The hardware and bandwidth for this mirror is donated by METANET, the Webhosting and Full Service-Cloud Provider.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]metanet.ch.

Using openbankeR

Nik Lilovski

2022-02-21

Functions

Function	Description	Input	Output
CreateOpenBankingClient	Creates a client for calling the API	Optional user-defined settings	OpenBankingClient object with query functions

Create an API client

Create a new client for querying the API

library(openbankeR)

openBankingClient <- openbankeR::CreateOpenBankingClient()

Bank Details

bankDetails <- openBankingClient$BankDetails

View(bankDetails)

Available banks

Get a list of banks that report the API

availableBanks <- openBankingClient$GetAvailableBanks()

availableBanks

Available instruments

Get a list of instruments reported via the API

availableInstruments <- openBankingClient$GetAvailableInstruments()

availableInstruments

Extract raw data

Get 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

Additional help

Use the below commands to find additional documentation about the package

??openbankeR

??openbankeR::CreateOpenBankingClient

Note

Raw data provided by the API can be a nested structure and may need to be unnested for some types of analysis.

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.