rbcb (version 0.1.14)

get_series: Get the series from BCB

Description

Get the series from BCB

Usage

get_series(
  code,
  start_date = NULL,
  end_date = NULL,
  last = 0,
  as = c("tibble", "xts", "ts", "data.frame", "text")
)

Value

tibble is the default returning class, but the argument as can be set to xts, data.frame, ts, or text to return these other types. text returns the JSON data provided by the remote API.

Arguments

code

series code

start_date

series initial date. Accepts ISO character formated date and Date.

end_date

series final date. Accepts ISO character formated date and Date.

last

last items of the series

as

the returning type: data objects (tibble, xts, data.frame, ts) or text for raw JSON

code argument can be obtained in the SGS system site. In this site searches can be executed in order to find out the desired series and use the series code in the code argument.

The arguments start_date, end_date and last are optional. If none of these arguments are set, then the entire time series is downloaded. Define start_date and end_date to download a period of data and to download the last N registers define the last argument to N a positive integer. Once last is provided it overrides the arguments start_date and end_date.

Examples

# download the entire series
if (FALSE) {
get_series(1)
}
# download a period of dates
if (FALSE) {
get_series(1, start_date = "2016-12-01")
}
if (FALSE) {
x <- get_series(1, start_date = "2016-12-01", end_date = "2016-12-31")
}
# downlaod the last register
if (FALSE) {
x <- get_series(1, last = 1)
}