olinda_get_currency: Get currency values for a given period

In rbcb: R Interface to Brazilian Central Bank Web Services

Get currency values for a given period

Description

Given a currency symbol and a time interval (in dates) this function returns the bid and ask time series of currency rates.

Usage

olinda_get_currency(
  symbol,
  start_date,
  end_date = NULL,
  as = c("tibble", "xts", "data.frame", "text"),
  parity = FALSE
)

Arguments

symbol	currency symbol
start_date	time interval initial date
end_date	time interval last date
as	the object's returning type
parity	TRUE returns the parity quotation (default FALSE currency quoted in BRL) The symbol argument is a three digits character which represents one currency. The symbols can be obtained with list_currencies. The time series date range is defined by start_date and end_date. If end_date is not passed, it is set equals to start_date. The parity argument defaults to FALSE, which means that the returned data is quoted in BRL. If it is TRUE the returned data is quoted in USD, for type A currencies and for type B currencies it is quoted as 1 USD in CURRENCY. For example, AUD, which is type B, returns 1 USD in AUD.

Value

The time series with the bid and ask currency rates regarding the given symbol quoted in BRL. The default returning is a tibble-fashioned data.frame with the three columns: date, ask and bid. The as argument also accepts data.frame to return old fashioned data frames, xts to return a xts object with two variables (bid and ask) and text which returns the text content download from BCB site.

Examples

## Not run: 
olinda_get_currency("USD", "2017-03-01", "2017-03-10")

## End(Not run)

rbcb documentation built on Oct. 13, 2023, 1:10 a.m.