brfinance (version 0.8.0)

get_exchange_rate: Get US Dollar Exchange Rate (Commercial)

Description

Downloads daily US dollar exchange rate (commercial, selling) from BCB/SGS. This function retrieves the daily exchange rate (SGS series 1) in Brazilian Real (R$).

Usage

get_exchange_rate(
  start_date = NULL,
  end_date = NULL,
  language = "eng",
  labels = TRUE
)

Value

A data.frame with US dollar exchange rate. Columns depend on the language parameter:

• English (language = "eng"): date (Date), exchange_rate (numeric, R$/US$)

• Portuguese (language = "pt"): data_referencia (Date), taxa_cambio (numeric, R$/US$)

Arguments

start_date

Start date for the data period. Accepts multiple formats:

• "YYYY" for year only (e.g., "2020" becomes "2020-01-01")

• "YYYY-MM" for year and month (e.g., "2020-06" becomes "2020-06-01")

• "YYYY-MM-DD" for a specific date (e.g., "2020-06-15")

end_date

End date for the data period. Accepts the same formats as start_date:

• "YYYY" (e.g., "2023" becomes "2023-12-31")

• "YYYY-MM" (e.g., "2023-12" becomes the last day of December 2023)

• "YYYY-MM-DD" for a specific date

• NULL defaults to the current date (today)

language

Language for column names in the returned data.frame:

• "eng" (default): Returns columns date and exchange_rate

• "pt": Returns columns data_referencia and taxa_cambio

labels

Logical indicating whether to add variable labels using the labelled package. Labels provide descriptive text for each column when available.

Examples

if (FALSE) { # interactive()
  # Default: last 30 days of exchange rate
  df <- get_exchange_rate()

  # Specific period
  df2 <- get_exchange_rate("2023-01-01", "2023-03-31")

  # Using year-month format for a specific month
  df3 <- get_exchange_rate("2023-06", "2023-06")

  # Portuguese column names and labels
  df4 <- get_exchange_rate(language = "pt")

  # Complete example with all parameters
  df5 <- get_exchange_rate("2023-01-01", "2023-12-31", language = "pt", labels = TRUE)
}