Git Product home page Git Product logo

openbankingbr's Introduction

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.

openbankingbr's People

Contributors

knuppe avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

openbankingbr's Issues

Exemplo de Produtos e Serviços retorna "O conteúdo retornado pelo endpoint não possui um JSON válido."

Considerando a execução deste exemplo:

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}')

O seguinte erro ocorre:

Traceback (most recent call last):
File "D:\Levius\IdeaProjects\open-finance\products-services.py", line 7, in
for produto in participante.produtos:
File "C:\Users\samue\AppData\Local\Programs\Python\Python39\lib\site-packages\openbankingbr\models.py", line 165, in produtos
for page in fetchUrlPages(endPoint, self.openBaking.cacheDir):
File "C:\Users\samue\AppData\Local\Programs\Python\Python39\lib\site-packages\openbankingbr\utils.py", line 155, in fetchUrlPages
root = fetchUrl(url, cacheDir = cacheDir)
File "C:\Users\samue\AppData\Local\Programs\Python\Python39\lib\site-packages\openbankingbr\utils.py", line 145, in fetchUrl
raise OpenBankingException("O conteúdo retornado pelo endpoint não possui um JSON válido.") from None
openbankingbr.errors.OpenBankingException: O conteúdo retornado pelo endpoint não possui um JSON válido.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.