Package: pixr 0.1.1

André Leite

pixr: Access Brazilian Central Bank 'PIX' Open Data 'API'

Provides a 'tidyverse'-style interface to the Brazilian Central Bank (<https://www.bcb.gov.br>) 'PIX' Open Data 'API' <https://olinda.bcb.gov.br/olinda/servico/Pix_DadosAbertos/versao/v1/aplicacao#!/recursos>. Retrieve statistics on 'PIX' keys, transactions by municipality, and monthly transaction summaries. All functions return 'tibbles' and support 'OData' query parameters for filtering, selecting, and ordering data.

Authors:André Leite [aut, cre], Marcos Wasiliew [aut], Hugo Vasconcelos [aut], Carlos Amorim [aut], Diogo Bezerra [aut], Júlia Nascimento Barreto [aut]

pixr_0.1.1.tar.gz
pixr_0.1.1.zip(r-4.7-any)pixr_0.1.1.zip(r-4.6-any)
pixr_0.1.1.tar.gz(r-4.7-any)pixr_0.1.1.tar.gz(r-4.6-any)
pixr_0.1.1.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
pixr/json (API)

# Install 'pixr' in R:
install.packages('pixr', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/strategicprojects/pixr/issues

Pkgdown/docs site:https://strategicprojects.github.io

On CRAN:

Conda:

3.70 score 2 scripts 211 downloads 21 exports 21 dependencies

Last updated from:3de0570e96. Checks:6 OK. Indexed: no.

TargetResultTimeFilesSyslog
linux-develOK114
source / vignettesOK231
linux-releaseOK114
windows-develOK76
windows-releaseOK72
wasm-releaseOK104

Exports:format_brlget_pix_cnae_statsget_pix_dict_usersget_pix_fraud_statsget_pix_fraud_stats_multiget_pix_keysget_pix_keys_by_typeget_pix_keys_summaryget_pix_summaryget_pix_transaction_statsget_pix_transaction_stats_multiget_pix_transactions_by_municipalityget_pix_transactions_by_regionget_pix_transactions_by_statepix_columnspix_endpointspix_pingpix_querypix_timeoutpix_urlyear_month_to_date

Dependencies:askpassclicurldplyrgenericsgluehttr2lifecyclemagrittropensslpillarpkgconfigpurrrR6rlangsystibbletidyselectutf8vctrswithr

Receiver Profiles (CNAE) and DICT Users
Users registered in the DICT | Receiver profiles: CNAE section, company size, and MEI | The database parameter selects a snapshot, not a month | Where do MEI receive PIX payments? | Value received by company size | Other useful filters | Learn more
Rendered fromreceiver-profiles-dict-users.Rmdusingknitr::rmarkdown

Last update: 2026-10-28
Started: 2026-10-28

Data Analysis Examples
Setup | Example 1: PIX Keys Market Share | Example 2: Key Type Distribution | Example 3: Regional Transaction Analysis | Example 4: State-Level Analysis | Example 5: Transaction Nature Analysis | Example 6: Filtering Transactions by State | Example 7: Comparing Regions with Filters | Example 8: P2P vs P2B Analysis | Example 9: Multiple Months Analysis | Example 10: Initiation Method Analysis | Example 11: Creating a Summary Report | Example 12: Exporting Data | Tips for Large-Scale Analysis | See Also
Rendered fromanalysis-examples.Rmdusingknitr::rmarkdown

Last update: 2026-01-31
Started: 2026-01-31

Introduction to pixr
Overview | Installation | Getting Started | API Endpoints | Quick Examples | Retrieve PIX Keys Data | Retrieve Transaction Data by Municipality | Retrieve Transaction Statistics | Retrieve Fraud Statistics | OData Filter and OrderBy | Common Filter Examples | Working with the Data | Configuration | Timeout | Verbose Output | Debugging | Next Steps | References
Rendered frompixr.Rmdusingknitr::rmarkdown

Last update: 2026-01-31
Started: 2026-01-31

Understanding PIX Data
What is PIX? | The PIX Ecosystem | System Components | PIX Key Types | Data Available Through pixr | 1. PIX Keys Stock (ChavesPix) | Column Descriptions | 2. Transactions by Municipality (TransacoesPixPorMunicipio) | 3. Transaction Statistics (EstatisticasTransacoesPix) | Transaction Nature Codes | Initiation Methods | 4. Fraud Statistics (EstatisticasFraudesPix) | API Parameters Summary | OData Filter Examples | Data Quality Notes | Coverage | Exclusions | Geographic Data | Working with Dates | Currency Formatting | Understanding Participant Identifiers | See Also | References
Rendered fromunderstanding-pix-data.Rmdusingknitr::rmarkdown

Last update: 2026-01-31
Started: 2026-01-31

Working with OData Queries
Introduction to OData | API Endpoints and Parameters | Filtering with $filter | Basic Filter Syntax | Comparison Operators | Logical Operators | String Functions | Ordering with $orderby | Basic Ordering | Combining Filter and OrderBy | Selecting Columns with $select | Pagination with $top and $skip | Iterating Through All Data | Custom Queries with pix_query() | Building and Debugging URLs | Practical Examples | Top 10 States by Transaction Volume | P2P vs P2B Transactions by Region | Market Share by Key Type | Performance Tips | Filter Reference by Endpoint | ChavesPix (PIX Keys) | TransacoesPixPorMunicipio (Transactions by Municipality) | EstatisticasTransacoesPix (Transaction Statistics) | See Also | References
Rendered fromodata-queries.Rmdusingknitr::rmarkdown

Last update: 2026-01-31
Started: 2026-01-31