| 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)
openBankingClient <- openbankeR::CreateOpenBankingClient()bankDetails <- openBankingClient$BankDetails
View(bankDetails)Get a list of banks that report the API
availableBanks <- openBankingClient$GetAvailableBanks()
availableBanksGet a list of instruments reported via the API
availableInstruments <- openBankingClient$GetAvailableInstruments()
availableInstrumentsGet raw data using the API for a given bank and instrument
bankName <- "HSBC Group"
instrument <- "branches"
rawData <- openBankingClient$GetRawData(
bankName = bankName,
instrument = instrument
)
View(rawData)Raw Data
Use the below commands to find additional documentation about the package
??openbankeR
??openbankeR::CreateOpenBankingClientRaw data provided by the API can be a nested structure and may need to be unnested for some types of analysis.