Get PIX Transactions by Region — get_pix_transactions_by

A convenience wrapper that aggregates municipality data at the region level.

Usage

get_pix_transactions_by_region(database, verbose = TRUE)

Arguments

database: Character string in "YYYYMM" format specifying which month's data to retrieve. This parameter is required.
verbose: Logical; if TRUE (default), prints progress messages.

Value

A tibble::tibble with PIX transaction data aggregated by region.

Examples

# It usually takes much longer than 5 seconds.
# Get region-level aggregates
regions <- get_pix_transactions_by_region(database = "202512")
#> 
#> ── Fetching PIX Transactions by Region ──
#> 
#> ── Fetching PIX Transactions by Municipality ──
#> 
#> ℹ URL: https://olinda.bcb.gov.br/olinda/servico/Pix_DadosAbertos/versao/v1/odata/TransacoesPixPorMunicipio(DataBase=@DataBase)?$format=json&@DataBase='202512'
#> ✔ Retrieved 61292 records
#> ✔ Aggregated data for 66 regions