Get PIX Transactions by State — get_pix_transactions_by

A convenience wrapper around get_pix_transactions_by_municipality() that aggregates data at the state level.

Usage

get_pix_transactions_by_state(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 state.

Examples

# It usually takes much longer than 5 seconds.
# Get state-level aggregates for December 2025
states <- get_pix_transactions_by_state(database = "202512")
#> 
#> ── Fetching PIX Transactions by State ──
#> 
#> ── 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 308 states