rbcb (version 0.1.14)

get_top5s_annual_market_expectations: Get annual market expectations from top 5 providers

Description

Statistics of annual expectations for top 5 indicators. All statistics are computed based on expectations provided by many financial institutions in Brazil: banks, funds, risk managers, so on and so forth. These expections and its statistics are used to build the FOCUS Report weekly released by the Brazilian Central Bank.

Usage

get_top5s_annual_market_expectations(
  indic = NULL,
  start_date = NULL,
  end_date = NULL,
  ...
)

Value

A data.frame with the requested data.

Arguments

indic

a character vector with economic indicators names. They are case sensitive and don't forget the accents.

start_date

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

end_date

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

...

additional parameters to be passed to the API

indic argument must be one of indicators listed in Details. Respecting the case, blank spaces and accents.

The ... is to be used with API's parameters. $top to specify the maximum number of rows to be returned, this returns the $top rows, in chronological order. There is also $skip to ignore the first rows.

Details

There are inflation's expectations available for the following indicators:

• Câmbio

• IGP-DI

• IGP-M

• IPCA

• Selic

Check <https://olinda.bcb.gov.br/olinda/servico/Expectativas/versao/v1/documentacao#ExpectativasMercadoTop5Anuais> for more details

Examples

if (FALSE) {
indic <- "IPCA"
end_date <- "2018-06-22"
x <- get_top5s_annual_market_expectations(indic, end_date = end_date, `$top` = 10)

# return all indicators for the specified date range
start_date <- "2021-01-01"
x <- get_top5s_annual_market_expectations(start_date = start_date, `$top` = 20)
}