CreateOpenBankingClient {openbankeR}

CreateOpenBankingClient

Description

Creates a new Open Banking (Open Data) API client with convenient queries

Usage

CreateOpenBankingClient(
  bankDetails = "default",
  version = "latest",
  timeOutSeconds = 15
)

Arguments

bankDetails

optional. Bank details list to use. When set to "default", the bank details will be taken from the below URL: https://github.com/OpenBankingUK/opendata-api-spec-compiled/blob/master/participant_store.json

Otherwise, the user can provide a custom list of bank details.

version

optional. Which version of the API to use. Defaults to "latest". When set to "latest", the version used will be the latest available for the selected bank and instrument. The latest available version information will be derived from the bank details table above. Alternatively, the user can supply a manually set version such as "v2.3"

timeOutSeconds

optional. Number of seconds before a request times out. Defaults to 15 seconds

Value

Object of type OpenBankingClient with methods for querying the API

Available client fields

• BankDetails: The default table of bank details used to query the API.

Available client queries

• GetAvailableBanks: Get a list of banks that report the API.

• GetAvailableInstruments: Get a list of instruments reported via the API.

• GetRawData: Get raw data using the API for a given bank and instrument.

Examples

library(openbankeR)

openBankingClient <- openbankeR::CreateOpenBankingClient()

bankDetails <- openBankingClient$BankDetails
   
availableBanks <- openBankingClient$GetAvailableBanks()
availableInstruments <- openBankingClient$GetAvailableInstruments()

bankName <- "HSBC Group"
instrument <- "branches"

rawData <- openBankingClient$GetRawData(
  bankName = bankName,
  instrument = instrument
)