Skip to main content

apifetch

apifetch (Python)

PyPI version Python versions CI Downloads License: MIT DOI R sibling

apifetch is a small, dependency-light toolkit for talking to token-authenticated REST APIs. It handles three recurring chores:

  1. Token management — store/get/remove/list tokens in process environment variables (never written to disk), namespaced per service.
  2. Request building — pluggable authentication and pagination strategies, bundled into a reusable Api profile.
  3. Data retrieval — fetch one page, or fetch everything in chunks.

This is the Python sibling of the R package apifetch. Both were extracted from the BigDataPE package, which is now one use case (see examples/bigdatape.py).

Installation

pip install apifetch

Usage

import apifetch as af

# 1. Describe the API once: where, how to authenticate, how to paginate.
api = af.Api(
    endpoint="https://api.example.com/v1/search",
    service="Example",
    auth=af.AuthBearer(),                 # "Authorization: Bearer <token>"
    pagination=af.PaginateOffset(where="query"),
)

# 2. Store a token (kept only in this process's environment).
af.store_token("reports", "my-secret-token", service="Example")

# 3. Fetch.
one_page = af.fetch(api, "reports", limit=50)
everything = af.fetch_all(api, "reports", chunk_size=1000)

# Optional: turn it into a DataFrame.
# import pandas as pd; df = pd.DataFrame(everything)

Strategies

Authentication: AuthBearer, AuthRaw, AuthHeader, AuthQuery.

Pagination: PaginateOffset(where="header" | "query"), PaginateNone.

License

MIT © André Leite

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apifetch-0.1.3.tar.gz (50.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apifetch-0.1.3-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file apifetch-0.1.3.tar.gz.

File metadata

  • Download URL: apifetch-0.1.3.tar.gz
  • Upload date:
  • Size: 50.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for apifetch-0.1.3.tar.gz
Algorithm Hash digest
SHA256 2c76dcb6e2076022ff264681cd09e619fce1f8954c7907169db64a4deb920070
MD5 bc20a1a58ac4040c5e2e870d1d982155
BLAKE2b-256 f348ddb7b5bcf835af297898376877e31fae3d14473963dac45fbab2a369e2f1

See more details on using hashes here.

Provenance

The following attestation bundles were made for apifetch-0.1.3.tar.gz:

Publisher: release.yml on StrategicProjects/apifetch-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file apifetch-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: apifetch-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 9.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for apifetch-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9845f2ca8fb2604fd50a844c27aa95294e1819ac9cfef4608845dcf8d7a0bd27
MD5 77028a06105248ce70c7c35586d0fe2f
BLAKE2b-256 e27511c0818d313ab069aad9237936d6f496893010c202d2f79bcd53fc3ebe6b

See more details on using hashes here.

Provenance

The following attestation bundles were made for apifetch-0.1.3-py3-none-any.whl:

Publisher: release.yml on StrategicProjects/apifetch-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page