Function | Description | Input | Output |
---|---|---|---|
CreateOpenBankingClient | Creates a client for calling the API | Optional user-defined settings | OpenBankingClient object with query functions |
Create a new client for querying the API
library(openbankeR)
<- openbankeR::CreateOpenBankingClient() openBankingClient
<- openBankingClient$BankDetails
bankDetails
View(bankDetails)
Get a list of banks that report the API
<- openBankingClient$GetAvailableBanks()
availableBanks
availableBanks
Get a list of instruments reported via the API
<- openBankingClient$GetAvailableInstruments()
availableInstruments
availableInstruments
Get raw data using the API for a given bank and instrument
<- "HSBC Group"
bankName <- "branches"
instrument
<- openBankingClient$GetRawData(
rawData bankName = bankName,
instrument = instrument
)
View(rawData)
Use the below commands to find additional documentation about the package
??openbankeR
::CreateOpenBankingClient ??openbankeR
Raw data provided by the API can be a nested structure and may need to be unnested for some types of analysis.