search

dalemyers / libmonzo

A Python library for interacting with Monzo bank accounts
MIT License
6 stars 0 forks source link

readme

libmonzo

A Python library for interacting with Monzo bank accounts that can handle OAuth authentication.

Installation

pip install libmonzo

Setup

Monzo has not opened their API broadly yet, and have some restrictions in place. As such, in order to use this library, you'll need to follow a few steps.

  1. Create your own client on the Monzo developer site: https://developers.monzo.com/apps/home
  2. Set the name, logo, and description to whatever you want them to be.
  3. Set the "Confidentiality" to "Not Confidential"
  4. Set the redirect URL to "http://localhost:36453/monzo_callback" (or whatever you like if you will be providing the access token).
  5. Keep note of the client ID, the owner ID, and the client secret for later use.
  6. Add your own user ID as a collaborator (this may not be required, but it appeared that I had to in order for things to work).

Example:

import libmonzo

client = libmonzo.MonzoClient(client_id, owner_id, client_secret)

# Via OAuth (it will open a browser window)
client.authenticate()

# Or providing the access token directly
client.access_token = "..."

# Getting accounts
for account in client.accounts():
    print(account.owners[0].preferred_name)

# Get the balance of an account
account = client.accounts()[0]
balance_info = client.balance(account_id=account.identifier)
print(balance_info.balance)

Supported APIs

Annotating transactions will be coming soon. There appears to be a minor bug causing problems at this point, so it's not quite ready.

Known issues

This was written because I needed it for a small personal project. Because of that, there are some issues. I'm open to PRs to fix these though.