{"id":14064708,"url":"https://github.com/yapily/yapily-sdk-python","last_synced_at":"2026-01-29T15:13:42.326Z","repository":{"id":44002710,"uuid":"133962026","full_name":"yapily/yapily-sdk-python","owner":"yapily","description":"Python SDK generated against the Yapily API. This SDK can be used to connect to Open Banking entities.","archived":false,"fork":false,"pushed_at":"2022-11-25T12:42:31.000Z","size":24906,"stargazers_count":13,"open_issues_count":5,"forks_count":10,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-14T07:07:39.363Z","etag":null,"topics":["devtools","finance","financial-institutions","fintech-utility","oauth2","openapi-generator","openapi3","openbanking","openbanking-sdk","psd2","python","python-sdk","sdk","sdk-python","yapily","yapily-api","yapily-sdk"],"latest_commit_sha":null,"homepage":"https://yapily.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yapily.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-05-18T14:02:57.000Z","updated_at":"2024-06-23T15:55:49.000Z","dependencies_parsed_at":"2023-01-22T04:00:53.738Z","dependency_job_id":null,"html_url":"https://github.com/yapily/yapily-sdk-python","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yapily%2Fyapily-sdk-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yapily%2Fyapily-sdk-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yapily%2Fyapily-sdk-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yapily%2Fyapily-sdk-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yapily","download_url":"https://codeload.github.com/yapily/yapily-sdk-python/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228040825,"owners_count":17860211,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["devtools","finance","financial-institutions","fintech-utility","oauth2","openapi-generator","openapi3","openbanking","openbanking-sdk","psd2","python","python-sdk","sdk","sdk-python","yapily","yapily-api","yapily-sdk"],"created_at":"2024-08-13T07:04:01.918Z","updated_at":"2026-01-29T15:13:42.293Z","avatar_url":"https://github.com/yapily.png","language":"Python","readme":"# Yapily Python SDK\n[![GitHub version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=gh\u0026type=6\u0026v=\u0026x2=0)](http://badge.fury.io/gh/boennemann%2Fbadges)\n\nThis SDK library was generated using [OpenApi Generator](https://github.com/OpenAPITools/openapi-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.\n\n## Requirements\n\nTo connect to the Yapily API, you will need to register your \napplication at [https://dashboard.yapily.com]().\n\nThese application credentials can then be used to authorise all\nyour API requests.\n\n## Installation\n\nThe SDK is currently available in the Yapily github repository and \ncan be included in your project \nby adding it to your dependencies\n\n#### pip install\n\npip3 install git+https://github.com/yapily/yapily-sdk-python.git#subdirectory=sdk\n\n#### pip upgrade\n\npip3 install --upgrade git+https://github.com/yapily/yapily-sdk-python.git#subdirectory=sdk\n\n## Usage\n\nSample usage of the SDK can be seen in the `examples` folder.\n\n- Retrieve a list of available financial institutions to connect to\n\n```python\nconfiguration = Configuration()\nconfiguration.username = constants.APPLICATION_ID\nconfiguration.password = constants.APPLICATION_SECRET\n\napiClient = ApiClient(configuration)\ninstitutionsApi = InstitutionsApi(apiClient)\ninstitutions = institutionsApi.get_institutions_using_get()\n```\n\n- Creating users and retrieving users for your application registered in the Yapily Dashboard\n```python\napplication_user = NewApplicationUser(application_user_id=app_user_id)\nuser_api = ApplicationUsersApi(apiClient)\nuser_api.add_user_using_post(application_user)\n```\n\n- Create an authorisation URL for your users to use to log into their institution\n\n```python\naccount_authorisation_request = AccountAuthorisationRequest(\n    application_user_id=constants.APPLICATION_USER_ID, \n    institution_id=constants.INSTITUTION_ID,\n    callback='',\n    one_time_token=''\n)\n\nresponse = accounts_api.initiate_account_request_using_post(account_auth_request=account_authorisation_request)\nredirect_url = response.data.authorisation_url\n```\n \n- Obtaining a valid consent for financial data\n\n```python\ndef filterByStatus(consent):\n    if (consent.status == \"AUTHORIZED\"):\n        return True\n    else:\n        return False\n\nconsents = ConsentsApi(apiClient).get_consents_using_get(\n    filter_application_user_id=[constants.APPLICATION_USER_ID],\n    filter_institution=[constants.INSTITUTION_ID]\n).data\n\nauthorised_consents = list(filter(filterByStatus, consents))\nconsent = authorised_consents[0]\nconsent_token = consent.consent_token\n```\n\n- Returning user account details\n```python\naccountsApi = AccountsApi(apiClient)\naccounts = accountsApi.get_accounts_using_get(consent_token)\n```\n\n- Returning user transaction details\n\n```python\ntransactionsApi = TransactionsApi(apiClient)\ntransactions = transactionsApi.get_transactions_using_get(consent_token, accounts.data[0]._id)\n```\n\n- Returning user identity details\n```python\ninstitutions_api = InstitutionsApi(apiClient)\nfeatures = institutions_api.get_institution_using_get(constants.INSTITUTION_ID).features\nif (\"IDENTITY\" in features):\n    identity_api = IdentityApi(apiClient)\n    identity = identity_api.get_identity_using_get(consent_token)\n```\n\n## Further information\n\nFor more information on how to get connected, visit the [Yapily Knowledge Base](https://kb.yapily.com).\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyapily%2Fyapily-sdk-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyapily%2Fyapily-sdk-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyapily%2Fyapily-sdk-python/lists"}