get_group: Get series-group observations

In valet: Provide R Client to the Bank of Canada's Valet API

Get series-group observations

Description

get_group returns observations from a Bank of Canada series group.

Usage

get_group(name = NULL, ...)

Arguments

name	A character of length 1 indicating the series group to retrieve.
...	Additional query parameters. Possible values are start_date and/or end_date (both character), or one of recent, recent_weeks, recent_months, or recent_years (all numeric).

Details

Valet, the server-side API, does not always return observations filtered by ... arguments for series groups, even if it will accept the request.

Value

A tibble.

Examples

get_group("BAPF_TRANSACTION_DATA")
get_group("gbpp")

## Not run: 
#this is a series
get_group("FXCADAUD")

## End(Not run)

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