Fetch Bank of Canada (BoC) data — boc_data • bbk

Retrieve time series data from the Bank of Canada Valet API.

Usage

boc_data(
  group_name = NULL,
  series_name = NULL,
  start_date = NULL,
  end_date = NULL
)

Source

https://www.bankofcanada.ca/valet/docs

Arguments

group_name: (NULL | character(1))
Name of the group. Only one of group_name or series_name can be used.
series_name: (NULL | character())
Name of the series.
start_date: (NULL | Date(1) | character(1))
Start date of the data. Default NULL.
end_date: (NULL | Date(1) | character(1))
End date of the data. Default NULL.

Value

A data.table::data.table() with the requested data.

See also

Other data: bbk_data(), bbk_series(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boe_data(), boj_data(), ecb_data(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

if (FALSE) { # \dontrun{
# fetch all data for a single group
dt <- boc_data(group_name = "FX_RATES_DAILY")
head(dt)

# or for multiple series ids
dt <- boc_data(
  series_name = c("FXUSDCAD", "FXEURCAD"),
  start_date = "2023-01-23",
  end_date = "2023-07-19"
)
head(dt)
} # }