Skip to main content

BasisTheory Python Library

fern shield pypi

The BasisTheory Python library provides convenient access to the BasisTheory APIs from Python.

Table of Contents

Documentation

API reference documentation is available here.

Installation

pip install BasisTheoryClient

Usage

Instantiate and use the client with the following:

from basis_theory import BasisTheory

client = BasisTheory(
    api_key="<value>",
)

client.tenants.self_.get()

Environments

This SDK allows you to configure different environments for API requests.

from basis_theory import BasisTheory
from basis_theory.environment import BasisTheoryEnvironment

client = BasisTheory(
    environment=BasisTheoryEnvironment.DEFAULT,
)

Async Client

The SDK also exports an async client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use httpx.AsyncClient() instead of httpx.Client() (e.g. for the httpx_client parameter of this client).

import asyncio

from basis_theory import AsyncBasisTheory

client = AsyncBasisTheory(
    api_key="<value>",
)


async def main() -> None:
    await client.tenants.self_.get()


asyncio.run(main())

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

from basis_theory.core.api_error import ApiError

try:
    client.tenants.self_.get()
except ApiError as e:
    print(e.status_code)
    print(e.body)

Pagination

Paginated requests will return a SyncPager or AsyncPager, which can be used as generators for the underlying object.

from basis_theory import BasisTheory

client = BasisTheory(
    api_key="<value>",
)

client.applications.list(
    id=[
        "id"
    ],
    type=[
        "type"
    ],
    page=1,
    start="start",
    size=1,
)
# You can also iterate through pages and access the typed response per page
pager = client.applications.list(...)
for page in pager.iter_pages():
    print(page.response)  # access the typed response for each page
    for item in page:
        print(item)

Advanced

Access Raw Response Data

The SDK provides access to raw response data, including headers, through the .with_raw_response property. The .with_raw_response property returns a "raw" client that can be used to access the .headers and .data attributes.

from basis_theory import BasisTheory

client = BasisTheory(...)
response = client.tenants.self_.with_raw_response.get()
print(response.headers)  # access the response headers
print(response.status_code)  # access the response status code
print(response.data)  # access the underlying object

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

Which status codes are retried depends on the retryStatusCodes generator configuration:

legacy (current default): retries on

  • 408 (Timeout)
  • 409 (Conflict)
  • 429 (Too Many Requests)
  • 5XX (All server errors, including 500)

recommended: retries on

  • 408 (Timeout)
  • 409 (Conflict)
  • 429 (Too Many Requests)
  • 502 (Bad Gateway)
  • 503 (Service Unavailable)
  • 504 (Gateway Timeout)

Use the max_retries request option to configure this behavior.

client.tenants.self_.get(request_options={
    "max_retries": 1
})

Timeouts

The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.

from basis_theory import BasisTheory

client = BasisTheory(..., timeout=20.0)

# Override timeout for a specific method
client.tenants.self_.get(request_options={
    "timeout_in_seconds": 1
})

Custom Client

You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies and transports.

import httpx
from basis_theory import BasisTheory

client = BasisTheory(
    ...,
    httpx_client=httpx.Client(
        proxy="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

Reference

A full reference for this library is available here.

Metadata

Release files for BasisTheoryClient 8.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for BasisTheoryClient 8.0.0
File Size Uploaded Provenance Actions
basistheoryclient-8.0.0.tar.gz 150.1 kB Without provenance Details for basistheoryclient-8.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for BasisTheoryClient 8.0.0
File Interpreter ABI Platform Actions
basistheoryclient-8.0.0-py3-none-any.whl Python 3 none any Details for basistheoryclient-8.0.0-py3-none-any.whl

Total release size: 532.9 kB

Release files / basistheoryclient-8.0.0.tar.gz

Download URL basistheoryclient-8.0.0.tar.gz
Size 150.1 kB
Tags Source
SHA-256 checksum
How to use checksums
3e5a0cbd7a7174bd39be1e2ad54c263a60cf443587925abaa2cd666235ba3373
BLAKE2b-256 checksum
How to use checksums
8ef7f88ed6c4dd3c111d56d89487c224d3783c6d513bb60fedba7f0cff677f58
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.22

Release files / basistheoryclient-8.0.0-py3-none-any.whl

Download URL basistheoryclient-8.0.0-py3-none-any.whl
Size 382.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9a2a3f06990590fc932624e195cc0a4c59a5287c84e6964ea4a1bdcdb8088c45
BLAKE2b-256 checksum
How to use checksums
fbed4919ba7aa5e13eeb14b02c6bd550c88f84d4d6f5a391e91ede66b48b34e6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.22

Security for BasisTheoryClient 8.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

8.0.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page