Skip to content
Python SDK generated against the Yapily API. This SDK can be used to connect to Open Banking entities.
Python Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
sdk
.gitignore
CODE_OF_CONDUCT.md
LICENCE
README.md

README.md

Yapily Python SDK

GitHub version

This SDK was generated using Swagger Code Generator. The SDK can be used as a module in your code and the examples demonstrate how to connect to financial institutions integrated with Yapily.

Requirements

To connect to the Yapily API, you will need to register your application at https://dashboard.yapily.com.

These application credentials can then be used to authorise all your API requests.

Installation

The SDK is currently available in the Yapily github repository and can be included in your project by adding it to your dependencies

pip

pip3 install git+https://github.com/yapily/yapily-sdk-python.git#subdirectory=sdk

Usage

Sample usage of the SDK can be seen in the examples folder.

  • Retrieve a list of available financial institutions to connect to
institutionsApi = InstitutionsApi(ApiClient(Configuration()))
institutions = institutionsApi.get_institutions_using_get()
  • Creating users and retrieving users for your application registered in the Yapily Dashboard
application_user = NewApplicationUser(str(uuid.uuid4()))
user_api = ApplicationUsersApi(ApiClient(Configuration()))
user_api.add_user_using_post(application_user)
  • Receiving an authorisation URL your users to log into their institution
redirect_url = auth_direct_url(constants.APPLICATION_ID,app_user_uuid,institution_id,constants.CALLBACK_URL,"account")
  • Receiving consents issued by your user authorizing
consents = ConsentsApi(apiClient).get_user_consents_using_get(app_user_uuid)
  • Returning user account details
accounts_api =  AccountsApi(ApiClient(configuration,"CONSENT","consent-token"))
accounts = accounts_api.get_accounts_using_get()
  • Returning user transaction details
transactionsApi = TransactionsApi(ApiClient(configuration,"CONSENT","consent-token"))
transactions = transactionsApi.get_transactions_using_get("account_id")
  • Returning user identity details
identity_api = IdentityApi(ApiClient(configuration,"CONSENT","consent-token"))
identity =  identity_api.identity_using_get()

Further information

For more information on how to get connected, visit the Yapily developer resources repo.

You can’t perform that action at this time.