Learn R Programming
openbankeR (version 0.1.1)

.openBankingClient: initialize

Description

initialize

initialize

Arguments

Public fields

BankDetails

Details for available banks that support the API

Methods

Public methods

Method new()

Initialize a new API client

Usage

.openBankingClient$new(
  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. This 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

Returns

Object of type OpenBankingClient with methods for querying the API

Method GetAvailableBanks()

Get available banks that support the API

Usage

.openBankingClient$GetAvailableBanks()

Returns

character list. Names of available banks

Method GetAvailableInstruments()

Get available instruments for the API

Usage

.openBankingClient$GetAvailableInstruments()

Returns

character list. Names of available instruments

Method GetRawData()

Get raw data for a specified bank and instrument

Usage

.openBankingClient$GetRawData(bankName, instrument)

Arguments

bankName

character. Name of the bank to get data for. See GetAvailableBanks()

instrument

character. Instrument to get data for. See GetAvailableInstruments()

Returns

list. Raw data for the requested bank and instrument