https://github.com/dalemyers/libmonzo

A Python library for interacting with Monzo bank accounts
https://github.com/dalemyers/libmonzo

Last synced: 22 days ago
JSON representation

A Python library for interacting with Monzo bank accounts

• Host: GitHub
• URL: https://github.com/dalemyers/libmonzo
• Owner: dalemyers
• License: mit
• Created: 2018-08-08T20:44:30.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-10-08T18:24:05.000Z (about 6 years ago)
• Last Synced: 2024-10-06T15:12:54.843Z (about 1 month ago)
• Language: Python
• Size: 16.6 KB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-monzo - libmonzo - A Python 3 wrapper of the Monzo API that supports OAuth (Code & Client Libraries)

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

* Listing accounts

* Reading balance

* Listing pots

* Depositing into pots

* Withdrawing from pots

* Retrieving a transaction

* Listing transactions

* Creating feed items

* Uploading and setting attachments

* Removing attachments

* Registering webooks

* Listing webhooks

* Removing webhooks

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.

* The OAuth setup isn't 100% reliable and could be better

* Limited error checking

* Limited bounds/variable checking

* Lack of useful error messages

* Design could be cleaner

* The tests require a local configuration file to even run

* Plus so many more