In nik01010/openbankeR: R Client for Querying the UK 'Open Banking' ('Open Data') API

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)

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)

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.

nik01010/openbankeR documentation built on July 17, 2022, 8:56 a.m.