Skip to main content

Getting Started with The Plaid API

Introduction

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

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install plaid-apimatic-sdk==1.0.0

You can also view the package at: https://pypi.python.org/pypi/plaid-apimatic-sdk/1.0.0

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
environment Environment The API environment.
Default: Environment.SANDBOX
http_client_instance Union[Session, HttpClientProvider] The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 30
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ["GET", "PUT"]
proxy_settings ProxySettings Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration LoggingConfiguration The SDK logging configuration for API calls
client_id_credentials ClientIdCredentials The credential object for Custom Header Signature
secret_credentials SecretCredentials The credential object for Custom Header Signature
plaid_version_credentials PlaidVersionCredentials The credential object for Custom Header Signature

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from theplaidapi.configuration import Environment
from theplaidapi.http.auth.client_id import ClientIdCredentials
from theplaidapi.http.auth.plaid_version import PlaidVersionCredentials
from theplaidapi.http.auth.secret import SecretCredentials
from theplaidapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from theplaidapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from theplaidapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from theplaidapi.theplaidapi_client import TheplaidapiClient

client = TheplaidapiClient(
    client_id_credentials=ClientIdCredentials(
        plaid_client_id='PLAID-CLIENT-ID'
    ),
    secret_credentials=SecretCredentials(
        plaid_secret='PLAID-SECRET'
    ),
    plaid_version_credentials=PlaidVersionCredentials(
        plaid_version='Plaid-Version'
    ),
    environment=Environment.SANDBOX,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from theplaidapi.theplaidapi_client import TheplaidapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = TheplaidapiClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name Description
SANDBOX Default
PRODUCTION -

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for plaid-apimatic-sdk 1.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 plaid-apimatic-sdk 1.0.0
File Size Uploaded Provenance Actions
plaid_apimatic_sdk-1.0.0.tar.gz 1.3 MB Without provenance Details for plaid_apimatic_sdk-1.0.0.tar.gz

Built distribution (wheel)

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

Total release size: 4.8 MB

Release files / plaid_apimatic_sdk-1.0.0.tar.gz

Download URL plaid_apimatic_sdk-1.0.0.tar.gz
Size 1.3 MB
Tags Source
SHA-256 checksum
How to use checksums
8584501c4b386df758ac6b2e53d579488adbe0a4a4b436c59ef0710df8d07fc8
BLAKE2b-256 checksum
How to use checksums
7c8868833c2a19392d8c814ee23af21024e03774b03e8daff01eb4686a98573d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / plaid_apimatic_sdk-1.0.0-py3-none-any.whl

Download URL plaid_apimatic_sdk-1.0.0-py3-none-any.whl
Size 3.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
a3e172496832f2ac0430e38a9173e4fc3dec3e7834111ec52e9a93064dd191d0
BLAKE2b-256 checksum
How to use checksums
0f9483bf4d0f76134487cf2dbff72b45a06290866089b2f99dd3337ada745b50
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for plaid-apimatic-sdk 1.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

1.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