Package index • pixr

PIX Keys Data

Functions to retrieve PIX keys statistics from the DICT (Directory of Transactional Account Identifiers).

get_pix_keys(): Get PIX Keys Stock by Participant
get_pix_keys_summary(): Get PIX Keys Summary by Institution
get_pix_keys_by_type(): Get PIX Keys by Key Type

PIX Transactions by Municipality

Functions to retrieve PIX transaction statistics aggregated by municipality, state, or region.

get_pix_transactions_by_municipality(): Get PIX Transactions by Municipality
get_pix_transactions_by_state(): Get PIX Transactions by State
get_pix_transactions_by_region(): Get PIX Transactions by Region

PIX Transaction Statistics

Functions to retrieve detailed PIX transaction statistics with breakdowns by type, region, and demographics.

get_pix_transaction_stats(): Get PIX Transaction Statistics
get_pix_summary(): Get PIX Transaction Summary
get_pix_transaction_stats_multi(): Get PIX Transaction Statistics for Multiple Months

PIX Fraud Statistics

Functions to retrieve PIX fraud statistics from the Special Return Mechanism (MED).

get_pix_fraud_stats(): Get PIX Fraud Statistics (MED)
get_pix_fraud_stats_multi(): Get PIX Fraud Statistics for Multiple Months

Receiver Profiles and DICT Users

Functions to retrieve PIX statistics by receiver economic activity (CNAE), company size, and MEI status, and the series of users registered in the DICT.

get_pix_cnae_stats(): Get PIX Statistics by Receiver CNAE and Company Size
get_pix_dict_users(): Get PIX Users Registered in the DICT

API Utilities

Utility functions for working with the BCB PIX Open Data API, including connection testing, custom queries, and debugging.

pix_ping(): Check API Connection
pix_query(): Get Raw Data from PIX API
pix_url(): Build PIX API URL (for debugging)
pix_endpoints(): Get Available PIX API Endpoints
pix_columns(): Get Column Information for a PIX Endpoint
pix_timeout(): Get or Set API Request Timeout

Data Helpers

Helper functions for data transformation and formatting.

year_month_to_date(): Convert Year-Month String to Date
format_brl(): Format Currency Value