Python SDK

IntroCopy Anchor Link

The The Plaid API SDK provides access to the The Plaid API REST APIs.

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

InstallationCopy Anchor Link

To install the 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 StartCopy Anchor Link

Synchronous clientCopy Anchor Link

Construct ThePlaidApiClient with keyword arguments, and call close() when you are done. Every argument is optional.

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"
)

client.close()

Alternatively, scope it — with ThePlaidApiClient(...) as client: closes the pool on exit.

Asynchronous clientCopy Anchor Link

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",
    )
    await client.aclose()


run(main())

Alternatively, scope it — async with AsyncThePlaidApiClient(...) as client: closes the pool on exit.