{"id":14066741,"url":"https://github.com/nik01010/openbankeR","last_synced_at":"2025-07-29T23:32:07.847Z","repository":{"id":45480314,"uuid":"461173307","full_name":"nik01010/openbankeR","owner":"nik01010","description":"R client for querying the Open Banking API","archived":false,"fork":false,"pushed_at":"2022-07-13T13:44:09.000Z","size":53,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-22T22:48:23.935Z","etag":null,"topics":["bank","client","data","openbanking","openbanking-api","opendata","opendata-api","r"],"latest_commit_sha":null,"homepage":"","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nik01010.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-02-19T11:37:24.000Z","updated_at":"2023-06-13T09:14:21.000Z","dependencies_parsed_at":"2022-07-15T03:30:32.788Z","dependency_job_id":null,"html_url":"https://github.com/nik01010/openbankeR","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/nik01010/openbankeR","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nik01010%2FopenbankeR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nik01010%2FopenbankeR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nik01010%2FopenbankeR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nik01010%2FopenbankeR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nik01010","download_url":"https://codeload.github.com/nik01010/openbankeR/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nik01010%2FopenbankeR/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267780023,"owners_count":24143201,"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","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["bank","client","data","openbanking","openbanking-api","opendata","opendata-api","r"],"created_at":"2024-08-13T07:05:14.369Z","updated_at":"2025-07-29T23:32:07.562Z","avatar_url":"https://github.com/nik01010.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"# openbankeR\n\n\nAn R package for querying the \n\u003ca href=\"https://openbankinguk.github.io/opendata-api-docs-pub/\" target=\"_blank\"\u003eUK Open Banking (Open Data) API\u003c/a\u003e\n\n\n\u003c!-- badges: start --\u003e\n[![CRAN status](https://www.r-pkg.org/badges/version/openbankeR)](https://CRAN.R-project.org/package=openbankeR)\n[![R build status](https://github.com/nik01010/openbankeR/workflows/R-CMD-check/badge.svg)](https://github.com/nik01010/openbankeR/actions)\n[![Stability: Active](https://masterminds.github.io/stability/active.svg)](https://masterminds.github.io/stability/active.html)\n\u003c!-- badges: end --\u003e\n\n\n## Features\n- Create an R client for the OpenBanking (OpenData) API\n\n- Extract raw data from the API using convenient functions\n\n\n## Installation\nFrom CRAN:\n```R\ninstall.packages(\"openbankeR\")\n```\n\nFrom GitHub:\n```R\nlibrary(devtools)\ninstall_github(\"nik01010/openbankeR\")\n```\n\n\n## Functions / Queries\n\nR package functions:\n\n| Function       | Description                | Input | Output             |\n| ------------- |----------------------|----------------------|-------------------|\n| CreateOpenBankingClient | Creates a client for calling the API | Optional user-defined settings | OpenBankingClient object with queries |\n\nOnce the client has been set-up, the following queries can be used:\n\n| Query       | Description                | Input | Output             |\n| ------------- |----------------------|----------------------|-------------------|\n| GetAvailableBanks | Get a list of banks that report the API  | n/a | List of available banks |\n| GetAvailableInstruments | Get a list of instruments reported via the API  | n/a | List of available instruments |\n| GetRawData | Get raw data using the API for a given bank and instrument | Bank name and instrument | Requested raw data |\n\n\n## Create an API client\nCreate a new client for querying the API\n```R\nlibrary(openbankeR)\n\nopenBankingClient \u003c- openbankeR::CreateOpenBankingClient()\n```\n\n## Bank Details\n```R\nbankDetails \u003c- openBankingClient$BankDetails\n\nView(bankDetails)\n```\n\n\n## Available banks\nGet a list of banks that report the API\n```R\navailableBanks \u003c- openBankingClient$GetAvailableBanks()\n\navailableBanks\n\n# [1] \"Adam \u0026 Company\"              \"Allied Irish Bank (GB)\"    \"Bank of Ireland (UK)\"      \"Bank of Scotland\"           \n# [5] \"Barclays Bank\"               \"Coutts\"                    \"Danske Bank\"               \"Esme\"                       \n# [9] \"First Trust Bank\"            \"Halifax\"                   \"HSBC Group\"                \"Lloyds Bank\"                \n# [13] \"Nationwide Building Society\" \"NatWest\"                  \"Royal Bank of Scotland\"    \"Santander UK\"               \n# [17] \"Ulster Bank\"                 \"Clydesdale Bank PLC\"      \"Yorkshire Bank\"            \"VM\"\n```\n\n\n## Available instruments\nGet a list of instruments reported via the API\n```R\navailableInstruments \u003c- openBankingClient$GetAvailableInstruments()\n\navailableInstruments\n\n# [1] \"business-current-accounts\" \"personal-current-accounts\" \"unsecured-sme-loans\"  \"atms\"  \"branches\"                 \n# [6] \"commercial-credit-cards\"\n```\n\n\n## Extract raw data\nGet raw data using the API for a given bank and instrument\n```R\nbankName \u003c- \"HSBC Group\"\ninstrument \u003c- \"branches\"\n\nrawData \u003c- openBankingClient$GetRawData(\n  bankName = bankName,\n  instrument = instrument\n)\n\nView(rawData)\n```\n\n![Raw Data](man/figures/raw-data-screenshot.PNG)\n\n\n## Additional help\nUse the below commands to find additional documentation about the package\n```R\n??openbankeR\n\n??openbankeR::CreateOpenBankingClient\n```\n\n\n## Note\nRaw data provided by the API can be a nested structure and may need to be unnested for some types of analysis.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnik01010%2FopenbankeR","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnik01010%2FopenbankeR","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnik01010%2FopenbankeR/lists"}