Skip to main content

The Plaid API SDK

Built with APIMatic License: MIT Python 3.10+

The The Plaid API SDK for Python provides access to the The Plaid API REST APIs from Python applications.

The Plaid REST API. Please see https://plaid.com/docs/api for more details.


Installation

To install the Python SDK from PyPI, with whichever package manager your project uses:

pip install apimatic-plaid-sdk
uv add apimatic-plaid-sdk
poetry add apimatic-plaid-sdk

To install from the SDK source instead, give the tool a path containing a slash — a bare folder name is looked up on PyPI, and resolves to whatever project holds that name there:

pip install <path-to-sdk>

Quick Start

Synchronous client

Construct ThePlaidApiClient with keyword arguments, and call close() when you are done. Every argument is optional; the full list is in the SDK map.

from the_plaid_api import ThePlaidApiClient

client = ThePlaidApiClient(
    plaid_client_id="YOUR_API_KEY", plaid_secret="YOUR_API_KEY", plaid_version="YOUR_API_KEY", environment="production"
)

# TODO: call endpoints here -- see api-reference.md

client.close()

Alternatively, scope it -- with ThePlaidApiClient(...) as client: closes the pool on exit; see Best Practices.

Client is exported as an alias of ThePlaidApiClient, so from the_plaid_api import Client also works.

The SDK accepts every model-typed input in two interchangeable spellings, both type-checked: the typed model, or a plain dict with the same keys -- the OrDict and Model | ModelDict unions in the SDK map. Pick whichever suits the call site: the dict form needs no import, while the model form adds a keyword-checked constructor and editor completion.

Asynchronous client

AsyncThePlaidApiClient mirrors ThePlaidApiClient with identical method names, and every endpoint method is a coroutine. It takes the same arguments, with some differences -- for example, the transport argument is custom_async_http_client.

from asyncio import run

from the_plaid_api import AsyncThePlaidApiClient


async def main() -> None:
    client = AsyncThePlaidApiClient(
        plaid_client_id="YOUR_API_KEY",
        plaid_secret="YOUR_API_KEY",
        plaid_version="YOUR_API_KEY",
        environment="production",
    )
    # TODO: call endpoints here, awaiting each -- see api-reference.md
    await client.aclose()


run(main())

Alternatively, scope it -- async with AsyncThePlaidApiClient(...) as client: closes the pool on exit. Only the async spelling is aclose, matching httpx; see Best Practices.

AsyncClient is the exported alias. Each client accepts only its own transport argument; passing the other's is a TypeError at runtime and an error under mypy.


Usage

Two generated references cover the SDK; each answers a different question:

Reference For
API Reference Usage guidance for a single parsed operation: client.<group>.<operation>(...) returns the typed payload and raises ApiError on any non-2xx, with .error the typed error body, or RawError for a status the operation does not document.
Raw API Reference The same for the raw variant: client.<group>.with_raw_response.<operation>(...) returns ApiResult[T, E] and never raises for an API error.

Both API references carry every one of the 93 operations, with a sync and an async sample and a parameter table each.

SDK map

This SDK ships a generated SDK map -- sdk-map.md -- a deterministic, lookup-oriented table of contents of the SDK's Python surface, generated by APIMatic alongside this SDK.

Consult the map before scanning or grepping the source: it answers call-level contract questions by lookup, and for anything it does not carry -- model shapes, enum values, an endpoint's route or behavioural prose -- it names the one source file to read. How to read the map itself, including the SDK-wide defaults its rows rely on, is stated at the top of sdk-map.md.

Best Practices

Match the disposal to the client's lifetime: an application-lifetime client is closed once at shutdown with close() / aclose(); where the lifetime fits a block, with ThePlaidApiClient() as client: / async with AsyncThePlaidApiClient() as client: releases it automatically. Both are idempotent, but a closed client is not reusable: the next call raises. The client closes whatever transport it holds, including one you supplied via custom_http_client / custom_async_http_client; if you intend to reuse your own transport across clients, don't hand its lifetime to a with block.

Retries are on by default: a failed idempotent request — a retryable status or no response at all — is sent again up to three times before the call gives up. Pass retry_options=0 to turn it off, for instance in a test that stubs an error response; the policy and its defaults are under Retries in the SDK map.

License

This SDK is distributed under the MIT License.


Support

Refer to the API reference for detailed information on available operations with code samples.


Metadata

Release files for apimatic-plaid-sdk 0.0.2

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

Source distribution (sdist)

Source distribution for apimatic-plaid-sdk 0.0.2
File Size Uploaded Provenance Actions
apimatic_plaid_sdk-0.0.2.tar.gz 274.7 kB Without provenance Details for apimatic_plaid_sdk-0.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for apimatic-plaid-sdk 0.0.2
File Interpreter ABI Platform Actions
apimatic_plaid_sdk-0.0.2-py3-none-any.whl Python 3 none any Details for apimatic_plaid_sdk-0.0.2-py3-none-any.whl

Total release size: 841.6 kB

Release files / apimatic_plaid_sdk-0.0.2.tar.gz

Download URL apimatic_plaid_sdk-0.0.2.tar.gz
Size 274.7 kB
Tags Source
SHA-256 checksum
How to use checksums
aed3e8357423d0c536f4171995d5ce43824749cf5410b2eab12361e574b94d8c
BLAKE2b-256 checksum
How to use checksums
77658cf3e918de4a4ee6d4940dd5cb4879385359b3d997aa0967c56193e933dc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.5.1 CPython/3.13.15 Linux/6.1.158.2-microsoft-standard

Release files / apimatic_plaid_sdk-0.0.2-py3-none-any.whl

Download URL apimatic_plaid_sdk-0.0.2-py3-none-any.whl
Size 566.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3ae85eb9deac8602b297f24baabe718d808024913e72b4fe6af2f018fd243cc7
BLAKE2b-256 checksum
How to use checksums
c772f03be242328867baaeac7c13309cec3d11b50ed5f2514994945fc1846406
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.5.1 CPython/3.13.15 Linux/6.1.158.2-microsoft-standard

Security for apimatic-plaid-sdk 0.0.2

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

0.0.2 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