get_details: Get series or series-group details
In valet: Provide R Client to the Bank of Canada's Valet API

View source: R/get_details.R

get_details

R Documentation

Get series or series-group details

Description

get_details returns metadata from a Bank of Canada series or series group.

Usage

get_details(name = NULL, group = FALSE)

Arguments

`name`	A character of length 1 indicating the series or series group for which information should be retrieved.
`group`	A Boolean indicating whether the `name` is a series or a series group.

Value

A list of series or group details.

Examples

get_details("CES_C4E_LOSE_JOB_SK")
## Not run: 
get_details("BAPF_TRANSACTION_DATA")

## End(Not run)
get_details("BAPF_TRANSACTION_DATA", group = TRUE)

valet documentation built on June 8, 2025, 1:03 p.m.