Monzo API
=====================================
The Monzo API package allows you to interact with the API provided by Monzo
bank.
DISCLAIMER
-------------------------------------
Before using this package it is important to understand that the Monzo API should only be
used for non-public projects hosted securely. Please do not use this on a public server
and do not use it for accessing other users accounts.
Installation
-------------------------------------
The package can be installed as a standard pip project:
.. code-block:: bash
pip install monzo-api
Basic Usage
-------------------------------------
Prior to using the API you need to obtain a few details from Monzo. Please
read `this <https://monzo-api.readthedocs.io/en/latest/monzo_setup.html>`_
document.
Please see the examples in the example directory.
Documentation
-------------------------------------
Full documentation can be found on
`Read The Docs <https://monzo-api.readthedocs.io>`_
Implemented End Points
-------------------------------------
.. list-table:: Monzo Endpoints
:widths: 45 30 25 25
:header-rows: 1
* - End Point
- Implemented
- Version
- Tests Written
* - Authentication
- yes
- 0.0.1
- No
* - Refresh Access
- yes
- 0.0.1
- No
* - Whoami
- yes
- 0.0.1
- Yes
* - Logout
- yes
- 0.0.1
- Yes
* - List Accounts
- yes
- 0.0.2
- Yes
* - Read Balance
- yes
- 0.0.2
- Yes
* - List Pots
- yes
- 0.0.3
- No
* - Deposit Into Pot
- yes
- 0.0.3
- No
* - Withdraw From Pot
- yes
- 0.0.3
- No
* - Get Transaction
- yes
- 0.0.4
- No (Testing Fails)
* - Get Transaction List
- yes
- 0.0.4
- Yes
* - Annotate Transaction
- yes
- 0.1.1 \*
- Yes
* - Create Feed Item
- yes
- 0.0.2
- Yes
* - Upload Attachment
-
-
- No
* - Register Attachment
-
-
- No
* - Deregister Attachment
-
-
- No
* - Fetch Receipt
- yes
- 0.1.2
- Yes
* - Create Receipt
- yes
- 0.1.2
- Yes
* - Delete Receipt
- yes
- 0.1.2
- No, Functionality currently broken
* - Register Webhook
- yes
- 0.0.3
- Yes
* - List Webhooks
- yes
- 0.0.3
- Yes
* - Delete Webhooks
- yes
- 0.0.3
- Yes
* - Open Banking API
- No
- \*\*
-
* \* Annotations only appear to work for existing keys such as Notes `view on the forum <https://community.monzo.com/t/annotate-transaction-endpoint-not-working-for-custom-key/121203>`_.
* \*\* It is unlikely that this package will implement usage of the Open Banking API due to restrictions accessing it.
Raw data
{
"_id": null,
"home_page": "https://github.com/petermcd/monzo-api",
"name": "Monzo-API",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Peter McDonald",
"author_email": "git@petermcdonald.co.uk",
"download_url": null,
"platform": null,
"description": "Monzo API\n=====================================\n\nThe Monzo API package allows you to interact with the API provided by Monzo\nbank.\n\nDISCLAIMER\n-------------------------------------\n\nBefore using this package it is important to understand that the Monzo API should only be\nused for non-public projects hosted securely. Please do not use this on a public server\nand do not use it for accessing other users accounts.\n\nInstallation\n-------------------------------------\n\nThe package can be installed as a standard pip project:\n\n\n.. code-block:: bash\n\n pip install monzo-api\n\nBasic Usage\n-------------------------------------\n\nPrior to using the API you need to obtain a few details from Monzo. Please\nread `this <https://monzo-api.readthedocs.io/en/latest/monzo_setup.html>`_\ndocument.\n\nPlease see the examples in the example directory.\n\nDocumentation\n-------------------------------------\n\nFull documentation can be found on\n`Read The Docs <https://monzo-api.readthedocs.io>`_\n\nImplemented End Points\n-------------------------------------\n\n.. list-table:: Monzo Endpoints\n :widths: 45 30 25 25\n :header-rows: 1\n\n * - End Point\n - Implemented\n - Version\n - Tests Written\n * - Authentication\n - yes\n - 0.0.1\n - No\n * - Refresh Access\n - yes\n - 0.0.1\n - No\n * - Whoami\n - yes\n - 0.0.1\n - Yes\n * - Logout\n - yes\n - 0.0.1\n - Yes\n * - List Accounts\n - yes\n - 0.0.2\n - Yes\n * - Read Balance\n - yes\n - 0.0.2\n - Yes\n * - List Pots\n - yes\n - 0.0.3\n - No\n * - Deposit Into Pot\n - yes\n - 0.0.3\n - No\n * - Withdraw From Pot\n - yes\n - 0.0.3\n - No\n * - Get Transaction\n - yes\n - 0.0.4\n - No (Testing Fails)\n * - Get Transaction List\n - yes\n - 0.0.4\n - Yes\n * - Annotate Transaction\n - yes\n - 0.1.1 \\*\n - Yes\n * - Create Feed Item\n - yes\n - 0.0.2\n - Yes\n * - Upload Attachment\n -\n -\n - No\n * - Register Attachment\n -\n -\n - No\n * - Deregister Attachment\n -\n -\n - No\n * - Fetch Receipt\n - yes\n - 0.1.2\n - Yes\n * - Create Receipt\n - yes\n - 0.1.2\n - Yes\n * - Delete Receipt\n - yes\n - 0.1.2\n - No, Functionality currently broken\n * - Register Webhook\n - yes\n - 0.0.3\n - Yes\n * - List Webhooks\n - yes\n - 0.0.3\n - Yes\n * - Delete Webhooks\n - yes\n - 0.0.3\n - Yes\n * - Open Banking API\n - No\n - \\*\\*\n -\n\n* \\* Annotations only appear to work for existing keys such as Notes `view on the forum <https://community.monzo.com/t/annotate-transaction-endpoint-not-working-for-custom-key/121203>`_.\n* \\*\\* It is unlikely that this package will implement usage of the Open Banking API due to restrictions accessing it.\n",
"bugtrack_url": null,
"license": null,
"summary": "Package to interact with the API provided by Monzo bank",
"version": "1.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/petermcd/monzo-api/issues",
"Documentation": "https://monzo-api.readthedocs.io",
"Homepage": "https://github.com/petermcd/monzo-api",
"Source": "https://github.com/petermcd/monzo-api"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "abd0b47b81a66b79d11aed7db7305ec6f0a766928c3087275f96459124c38738",
"md5": "631521b5c5a73d8e4c2844995b015fbd",
"sha256": "e595524be152d8b5bd1bf55f3a37ad68f38b20c19b9151617bd888b93c6c35a4"
},
"downloads": -1,
"filename": "Monzo_API-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "631521b5c5a73d8e4c2844995b015fbd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 36731,
"upload_time": "2025-01-19T14:00:29",
"upload_time_iso_8601": "2025-01-19T14:00:29.051894Z",
"url": "https://files.pythonhosted.org/packages/ab/d0/b47b81a66b79d11aed7db7305ec6f0a766928c3087275f96459124c38738/Monzo_API-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-19 14:00:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "petermcd",
"github_project": "monzo-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "monzo-api"
}
JSON
