pynubank
Acesse seus extratos do Nubank pelo Python (Baseado na versão js)
Instalação
Disponível via pip
pip install pynubank
Autenticação
Primeiro de tudo, precisamos nos autenticar.
Para isso, além do seu CPF e senha usuais, precisamos de um fator extra de autenticação.
Temos 3 opções disponíveis, com seus respectivos exemplos:
- QR Code (assim como é feito no app web. Obs: permite somente acesso aos dados do cartão de crédito)
- Certificado (assim como é feito no app mobile)
- Certificado e Refresh Token
Tendo seguido com sucesso uma das opções, você pode tentar um dos exemplos a seguir!
Exemplos
⚠️ Atenção: O Nubank pode bloquear a sua conta por 72 horas caso detecte algum comportamento anormal ! Por conta disso, evite enviar muitas requisições. Você também pode utilizar o MockHttpClient descrito abaixo.
Realizando testes com dados falsos
Você pode utilizar este recurso para receber dados falsos para testar a sua solução sem correr riscos de ser bloqueado pelo Nubank e com tempo de resposta instantâneo. Para isso, utilize o exemplo a seguir:
from pynubankasync import Nubank, MockHttpClient
nu = Nubank(MockHttpClient())
await nu.start()
await nu.authenticate_with_cert(
"qualquer-cpf",
"qualquer-senha",
"caminho/do_certificado.p12"
) # Essa linha funciona porque não estamos chamando o servidor do Nubank ;)
# Qualquer método chamado não passará pelo Nubank e terá o retorno instantâneo.
Cartão de Crédito
from pynubankasync import Nubank
nu = Nubank()
nu.start()
# Insira aqui o código para se autenticar!
# Veja a seção acima sobre autenticação para mais detalhes ;)
# Lista de dicionários contendo todas as transações de seu cartão de crédito
card_statements = await nu.get_card_statements()
# Retorna um dicionário contendo os detalhes de uma transação retornada por get_card_statements()
# Contém as parcelas da transação
card_statement_details = await nu.get_card_statement_details(card_statements[0])
# Soma de todas as compras
print(sum([t['amount'] for t in card_statements]))
# Lista de dicionários contendo todas as faturas do seu cartão de crédito
bills = await nu.get_bills()
# Retorna um dicionário contendo os detalhes de uma fatura retornada por get_bills()
bill_details = await nu.get_bill_details(bills[1])
NuConta
from pynubankasync import Nubank
nu = Nubank()
nu.start()
# Insira aqui o código para se autenticar!
# Veja a seção acima sobre autenticação para mais detalhes ;)
# Lista de dicionários contendo todas as transações de seu cartão de crédito
account_statements = await nu.get_account_statements()
# Soma de todas as transações na NuConta
# Observacão: As transações de saída não possuem o valor negativo, então deve-se olhar a propriedade "__typename".
# TransferInEvent = Entrada
# TransferOutEvent = Saída
# TransferOutReversalEvent = Devolução
print(sum([t['amount'] for t in account_statements]))
# Saldo atual
print(await nu.get_account_balance())
Mais exemplos
A pasta examples possui mais referencias de uso com autenticação e visualização dos dados.
Testes
- Instale os requirements
- Execute o comando pytest
$ pip install -r requirements.txt
$ pip install -r requirements-test.txt
$ pytest
Contribuindo
Envie sua PR para melhorar esse projeto ! 😋
Metadata
Release files for pynubankasync 2.25.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pynubankasync-2.25.1.tar.gz | 36.4 kB | Without provenance | Details for pynubankasync-2.25.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pynubankasync-2.25.1-py3-none-any.whl | Python 3 | none | any | Details for pynubankasync-2.25.1-py3-none-any.whl |
Total release size: 120.4 kB
Release files / pynubankasync-2.25.1.tar.gz
| Download URL | pynubankasync-2.25.1.tar.gz |
|---|---|
| Size | 36.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ef04b200750d40068b67a8f19bbc9bbad6d1ae7971857428f1688b9955a44ceb
|
|
BLAKE2b-256 checksum How to use checksums |
3778db4457c5c6675953fc5d454c8eddb46fac53f6b63679870528ceec01e0c0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.3
|
Release files / pynubankasync-2.25.1-py3-none-any.whl
| Download URL | pynubankasync-2.25.1-py3-none-any.whl |
|---|---|
| Size | 84.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
52b5dd9fc914fc7d12629b073dd06d81466691bd0154349f76b8d6fc889ba4c7
|
|
BLAKE2b-256 checksum How to use checksums |
dbfc3ae69399726094cc203d3a7aa924f43e089b3721160fc755cad7e25e0689
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.3
|
Security for pynubankasync 2.25.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.