bridgeapi 1.0.0b2

Client for the Bridge open banking API aggregator

bridgeapi

---

bridgeapi is a client for the Bridge open banking API aggregator (API documentation).

Requirements

Python 3.10+

Installation

pip install bridgeapi

Example

from bridgeapi import AppClient, UserClient

app_client = AppClient("CLIENT_ID", "CLIENT_SECRET")
app_client.list_banks()
app_client.list_users()
app_client.create_user("[e-mail]", "password")
...

user_client = UserClient("CLIENT_ID", "CLIENT_SECRET", "[e-mail]", "password")
user_client.list_items()
user_client.connect_item()
user_client.list_accounts()
user_client.list_transactions()
...

API endpoints are split between two clients:

• AppClient handles all application-scoped endpoints, that don't depend on a user being authenticated. It only needs (client_id, client_secret) credentials to communicate with the API.
• UserClient handles user-scoped endpoints, those that are specific to a user and require an access token and the Authorization header to communicate with the API. It needs (user_email, user_password) credentials, in addition to the same client credentials as AppClient.

All API client methods return a Pydantic model mapping exactly the schema of the API response. The raw response object can be accessed with the .response property:

result = app_client.list_banks()

result # PaginatedResult[Bank]
result.response  # <Response [200]>
result.response.json()  # JSON-parsed raw response body

Paginated results

API endpoints that return a list of results are paginated, i.e. they don't return the complete list of objects in one result but in chunks (called pages). When calling a list API endpoint, the first page of results is returned. Existence of more pages can be checked with .has_more(). Subsequent pages can be retrieved by calling .next_page():

from bridgeapi import AppClient

app_client = AppClient("CLIENT_ID", "CLIENT_SECRET")
banks = app_client.list_banks(limit=2)
print(banks.resources)  # List of 2 Bank instances

print(banks.has_more())  # True
banks = banks.next_page()
print(banks.resources)  # List of 2 other Bank instances

The entire list of objects can be retrieved by calling .fetch_all() on the first page returned by the API. Attempting to call it on a subsequent page will result in an error. Beware of potentially large collections, you may exceed API or memory limits, or wait for a long time. You may also want to increase the limit parameter.

from bridgeapi import AppClient

app_client = AppClient("CLIENT_ID", "CLIENT_SECRET")
banks = app_client.list_banks(limit=100)
print(banks.fetch_all())  # List of all banks

banks.next_page().fetch_all()  # PaginationError

User authentication management

The simplest usage of UserClient is to it handle all the authorization lifecyle. It will automatically obtain an access token and renew it when it expires (after 2 hours):

user_client = UserClient("CLIENT_ID", "CLIENT_SECRET", "[e-mail]", "password")
print(user_client.list_items())  # OK

# 2+ hours later
print(user_client.list_items())  # OK

If you wish to manage the user authorization lifecycle yourself, pass auto_renew=False at creation. You will need to call .renew_auth() manually:

user_client = UserClient(
    "CLIENT_ID", "CLIENT_SECRET", "[e-mail]", "password", auto_renew=False
)
print(user_client.is_authenticated())  # False
user_client.list_items()  # UserAuthenticationError

user_client.renew_auth()
print(user_client.is_authenticated())  # True
print(user_client.list_items())  # OK

# 2+ hours later
print(user_client.is_authenticated())  # False
user_client.renew_auth()
print(user_client.is_authenticated())  # True

Additionally, if you are managing user tokens externally and persisting them to external storage, you can provide them at creation as well:

user_client = UserClient(
    "CLIENT_ID",
    "CLIENT_SECRET",
    "[e-mail]",
    "password",
    user_uuid="uuid",
    access_token="token",
    expires_at=datetime,  # "yyyy-mm-dd HH:MM:SS"
    auto_renew=False,
)
print(user_client.is_authenticated())  # True
user_client.list_items()  # OK

# Generate and store new authorization info
auth_info = user_client.renew_auth()
store_user_auth_to_db(
    user_email=auth_info.user.email,
    user_uuid=auth_info.user.uuid,
    access_token=auth_info.access_token,
    expires_at=auth_info.expires_at,
)

License

bridgeapi is distributed under the terms of the MIT license.