Skip to main content

Alelo API

Project description

python-alelo

Build status 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

Funciona apenas com vale refeição Alelo, esse é o único cartão que eu tenho.

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

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

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

# Pega o id do card que vc quser na lista
id = cards[0]["id"]

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

# Para pegar o saldo do cartão
s = a.get_statement(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(id, TransactionsTime.LAST_FIVE)
a.get_transactions(id, TransactionsTime.LAST_FIFTY_DAYS)
a.get_transactions(id, TransactionsTime.LAST_MONTH)
a.get_transactions(id, TransactionsTime.LAST_THREE_MONTHS)
a.get_transactions(id, TransactionsTime.LAST_FOUR_MONTHS)

Project details


Download files

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

Files for python-alelo, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size python_alelo-1.0.0-py3-none-any.whl (5.3 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size python_alelo-1.0.0.tar.gz (4.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page