Skip to content

Library that provides a convenient way to work with all Australian Open Banking API methods

Notifications You must be signed in to change notification settings

JargeZ/au-open-banking-client

Repository files navigation

Australian CDS Open Banking Client

This is a client library for the Australian CDS Open Banking API. It is handy wrapper from the OpenAPI specification. It provides a simple way to interact with the API using either sync or async clients.


⚠️ DRAFT warning

This project is a work in progress and is not yet ready for use.

This project will probably not be maintained, but serves as a basis for creating extensible abstract clients based on openapi

Usage

You can use endpoints directly

from au_open_banking_client.api_wrapped import AsyncApiBundle
from au_open_banking_client.client.async_client import AsyncClient
from au_open_banking_client.schemas.BankEndpoint import KnownBankHost
from au_open_banking_spec import Configuration, ApiClient

configuration = Configuration(
    host=KnownBankHost.COMMBANK.value
)

client = AsyncClient(AsyncApiBundle(ApiClient(configuration)))

await cl.api.products.get_product_detail(product_id="id")

OR with some wrappers
(you can also inherit and add you own helper methods)

async for product in client.get_all_products():
    print(f"{product.name} -  {product.application_uri}")

go-task install (modern make replacement)

# macOS
brew install go-task

# windows
choco install go-task

# linux
npm install -g @go-task/cli
# + reffer to https://taskfile.dev/#/installation

CDS open Banking Client

https://consumerdatastandardsaustralia.github.io/standards/includes/swagger/cds_banking.yaml

TODO:

  • sync/async client factory

About

Library that provides a convenient way to work with all Australian Open Banking API methods

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages