Skip to main content

Install

Python 3.9 or higher. The only runtime dependency is requests.

Quick start

Full method surface

Every method returns the parsed JSON response body as a dict.

Constructor options

Idempotency

Pass an idempotency_key to make retries safe. Repeat the same key within 24 hours to get the cached response.

Error handling

Non-2xx responses raise ApiError. The exception carries the status, machine code, the parsed body, and retry_after (populated on 429).
The client retries once by default on 429 and 5xx. Set max_retries=0 on the constructor to disable.

Docstrings

Every method has a full docstring. In a REPL:

Type checking

The package ships a py.typed marker. mypy --strict and pyright both pass against the public surface. Response bodies are typed as Dict[str, Any]; for stricter typing, layer the OpenAPI spec through datamodel-code-generator or openapi-python-client.

Repository and issues