python-alelo

Alelo API


Keywords
python3
License
MIT
Install
pip install python-alelo==2.0.1

Documentation

python-alelo

GitHub Workflow Status (branch) Codacy Badge Codacy Badge Updates Python 3 Maintainability Code style: black GitHub PyPI version Downloads Downloads Downloads


A Alelo ainda não tem uma API para a gente pegar os nossos dados. Por isso fiz essa lib para poder melhorar o meu financeiro-bot

Contribuições são bem vindas para colocar outros cartões.

Como usar

Para instalar pip install python-alelo

from python_alelo.alelo import Alelo
from python_alelo.alelo import Card
from typing import List

a = Alelo(cpf="SEU-CPF", pwd="SUA-SENHA")
a.login()

# Você precisa pegar os seus cartões para pegar o id deles
cards: List[Card] = a.get_cards()

# Pega o primeiro card
card: Card = cards[0]

# Pega todas as cinco últimas transações
print(a.get_transactions(card))

# Para pegar o saldo do cartão
s = a.get_statement(card.id)
print(s["statement"]["balance"])

O retorno do get_transactions é assim, esse é o retorno real do meu cartão:

{
   "transactions":[
      {
         "date":"22/11",
         "value":5.1,
         "moneyType":"R$",
         "type":"DEBIT",
         "icon":"shopping",
         "description":"Pao To Go",
         "virtualCard":false
      },
      {
         "date":"15/11",
         "value":84,
         "moneyType":"R$",
         "type":"DEBIT",
         "icon":"shopping",
         "description":"VIA POMPEIA",
         "virtualCard":false
      },
      {
         "date":"14/11",
         "value":30,
         "moneyType":"R$",
         "type":"DEBIT",
         "icon":"shopping",
         "description":"T B B VILA OLIMPIA RES",
         "virtualCard":false
      },
      {
         "date":"11/11",
         "value":43.8,
         "moneyType":"R$",
         "type":"DEBIT",
         "icon":"shopping",
         "description":"KADALORA PIZZARIA",
         "virtualCard":false
      },
      {
         "date":"10/11",
         "value":5.9,
         "moneyType":"R$",
         "type":"DEBIT",
         "icon":"shopping",
         "description":"STARBUCKS 008-ELDORADO",
         "virtualCard":false
      }
   ],
   "average":33.76
}

Opções

Para pegar mais transações vc pode fazer assim:

from python_alelo.alelo import TransactionsTime

a.get_transactions(card, TransactionsTime.LAST_FIVE)
a.get_transactions(card, TransactionsTime.LAST_FIFTY_DAYS)
a.get_transactions(card, TransactionsTime.LAST_MONTH)
a.get_transactions(card, TransactionsTime.LAST_THREE_MONTHS)
a.get_transactions(card, TransactionsTime.LAST_FOUR_MONTHS)