get_ifdata_reports: Download institution reports data from IFdata of Brazilian...

View source: R/get_ifdata_reports.R

get_ifdata_reportsR Documentation

Download institution reports data from IFdata of Brazilian Central Bank (Bacen) Relatorios

Description

[Stable]

Download IFdata reports from the Brazilian Central Bank (Bacen) API for specified years, months, institution types, and report types. The function handles multiple combinations of parameters and returns a consolidated data frame with the results.

Also, check the page to see the available reports for each institution type and date: IFdata.

Usage

get_ifdata_reports(year, month, type_institution, report, verbose = TRUE)

Arguments

year

Numeric or vector. year (ex: 2024 or c(2023, 2024))

month

Numeric or vector. month (ex: 1 to 12, or c(6, 12))

type_institution

Numeric. Type of Institution:

  • 1 = Conglomerados Prudenciais e Instituicoes Independentes

  • 2 = Conglomerados Financeiros e Instituicoes Independentes

  • 3 = Instituicoes Individuais

  • 4 = Instituicoes com Operacoes de Cambio

report

Numeric. Report type:

  • 1 = Resumo

  • 2 = Ativo

  • 3 = Passivo

  • 4 = Demonstracao de Resultado

  • 5 = Informacoes de Capital

  • 6 = Segmentacao

  • 7 = Carteira de Credito Ativa - Por indexador

  • 8 = Carteira de Credito ativa - por nivel de risco da operacao

  • 9 = Carteira de Credito ativa - por regiao geografica

  • 10 = Carteira de Credito ativa - quantidade de clientes e de operacoes

  • 11 = Carteira de Credito ativa Pessoa Fisica - modalidade e prazo de vencimento

  • 12 = Carteira de Credito ativa Pessoa Juridica - por atividade economica (CNAE)

  • 13 = Carteira de Credito ativa Pessoa Juridica - modalidade e prazo de vencimento

  • 14 = Carteira de Credito ativa Pessoa Juridica - por porte do tomador

  • 15 = Movimentacao de Cambio no Trimestre

  • 16 = Carteira de Credito ativa - por carteiras de instrumentos financeiros

verbose

Logical. If TRUE, print progress messages (default: TRUE)

Value

Data frame with IFdata values or NULL in the case of errors.

Examples


# Unique institution type for a specific period
data <- get_ifdata_reports(
 year = 2024,
 month = 12,
 report = 1,
 type_institution = 2
)

# Multiple periods, take some time to run
data <- get_ifdata_reports(
  year = c(2023, 2024),
  month = c(6, 12),
  report = 1,
  type_institution = 2
)


bacenR documentation built on Oct. 24, 2026, 1:07 a.m.