get_ifdata_registry: Download institution registry data from IFdata of Brazilian...

View source: R/get_ifdata_registry.R

get_ifdata_registryR Documentation

Download institution registry data from IFdata of Brazilian Central Bank (Bacen) Cadastro

Description

[Stable]

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

Usage

get_ifdata_registry(year, month, verbose = TRUE)

Arguments

year

Numeric or vector. Year(s) to download (e.g., 2024 or c(2023, 2024))

month

Numeric or vector. Month(s) to download (1 to 12)

verbose

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

Value

Data frame with institution registry data or NULL in case of error

Examples


# Single period
data <- get_ifdata_registry(
 year = 2024,
 month = 12
)
# Multiple years and months (all combinations), take some time to run
data <- get_ifdata_registry(
 year = c(2023, 2024),
 month = c(3, 6, 9, 12)
)


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