Skip to main content

Python 3 package to extract public data for Open Banking Brasil.

Project description

OpenBankingBR

Um pacote Python para carregar, analisar e exportar os dados públicos expostos pelos participantes do OpenBanking Brasil.

This package is intended to extract public data from the Open Bank Brasil. Since most users of this library will be Brazilians, everything is in Portuguese.

Dados suportados:

Participantes

Agências via /open-banking/channels/v1/branches

from openbankingbr import OpenBankingBR

ob = OpenBankingBR(cacheDir='./cache')

for participante in ob.participantes:
    for agencia in participante.agencias:
        print(f'Participante: {participante.nome} > agencia código: {agencia.codigo}')

Produtos via /open-banking/products-services/v1/*

from openbankingbr import OpenBankingBR

ob = OpenBankingBR(cacheDir='./cache')

for participante in ob.participantes:
    print(f'Participante: {participante.nome}')
    for produto in participante.produtos:
        print(f'Produto: {produto.tipo} - {produto.nome}')

        # Serviços disponíveis no produto
        for servico in produto.servicos:
            print(f'    Serviço > {servico.nome}')

        # Pacotes de serviço disponíveis no produto.
        for pacote in produto.pacotes:
            print(f'    Pacote > {pacote.nome}')

Mecanismo de cache

Como esta biblioteca realiza centenas de chamadas em API's das financeiras, existe um mecanimo padrão de salvar os dados retornados pelos end-points das apis em uma pasta de cache com o objetivo de não enviar um request bem sucedido mais de uma vez no mesmo dia para a endpoint/financeira.

Basicamente é um mecanismo de bom senso para não abusar das apis disponibilizadas pelas financeiras, porém você pode desabilitar este comportamento com cacheDir = None (mas não recomendo).

Processamento batch

O objetivo inicial ao criar este pacote foi exportar os dados que são listados pelos participantes periodicamente para realizar análises dos produtos de crédito das instituições financeiras.

Uma forma simples de exportar todos produtos listados:

from openbankingbr.batch import BatchOpenBanking
batch = BatchOpenBanking(
    dataDir  = './data' ,
    cacheDir = './cache',
    ignoraErros = True  ,  
)
batch.todos_dados()
#
# ou... somente os aquivos que interessar.
#
# batch.agencias_csv()
# batch.produtos_csv()
# batch.servicos_csv()
# batch.pacotes_csv()

Notas importantes

Qualidade dos dados

Em teoria as APIs são homologadas pelo Bacen, porém na prática consultando as APIs é facilmente observado que várias instituições financeiras não seguem o padrão da documentação, não sei como passaram na homologação, mas o fato é que o dado problemático existe. Nesta biblioteca tentei contornar e validar o máximo dos dados, ignorando os valores que são absurdamente fora do padrão da documentação.

Segurança

A validação de certificados SSL teve que ser desabilitada, visto que as financeiras Brasileiras não se dão ao trabalho de ter um certificado SSL válido para as APIs expostas para a internet.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openbankingbr-0.1.4.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openbankingbr-0.1.4-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

Details for the file openbankingbr-0.1.4.tar.gz.

File metadata

  • Download URL: openbankingbr-0.1.4.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for openbankingbr-0.1.4.tar.gz
Algorithm Hash digest
SHA256 e625c9b17970e2a83138b157d3593d4dc1530d9149be27832eaa092525349e46
MD5 53dd52183880de66b8925c736722e003
BLAKE2b-256 dd3ed97a3b45a0ceb7d615834b4aa1581816de5e772228819627376d27e20dd2

See more details on using hashes here.

File details

Details for the file openbankingbr-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: openbankingbr-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 18.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for openbankingbr-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8bcd0ad893ae6dd7b6ecabe5ed7365eda3f6ef519fe6d5e15e0fc4e6697d443c
MD5 d4a2f6dd9dd9fa4c1fae17a2aeaa8d77
BLAKE2b-256 4c550e3be1cfbbabc60743ebd7af4e00bcc7bc0472fffc0aede9b076cf95b0a5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page