full_request: Create an API call, send the request and retrieve the...

In ARawles/BMRSr: Wrapper Functions to the 'BMRS API'

Create an API call, send the request and retrieve the results, and parse them

Description

Create an API call, send the request and retrieve the results, and parse them

Usage

full_request(
  ...,
  get_params = list(),
  parse = TRUE,
  clean_dates = TRUE,
  rename = TRUE
)

Arguments

...	values to be passed to appropriate build_x_call function
get_params	list; parameters to be passed to the send_request function (which will pass those parameters to httr::get)
parse	boolean; whether the results should be parsed or returned as a response() object
clean_dates	boolean; whether the csv response columns should be cleaned (reformatted to be correct date/time/datetime)
rename	boolean; whether blank columns should be renamed (not always accurate)

Value

If parse == TRUE, a tibble if service_type = "csv", otherwise a list. If parse == FALSE, a response() object is returned

Examples

full_request(data_item = "B1730", api_key = "12345",
settlement_date = "14-12-2016", parse = TRUE, service_type = "xml")

ARawles/BMRSr documentation built on Feb. 1, 2023, 12:11 p.m.