https://github.com/vitalik/python-monobank
Python client for Monobank API
https://github.com/vitalik/python-monobank
Last synced: 3 months ago
JSON representation
Python client for Monobank API
- Host: GitHub
- URL: https://github.com/vitalik/python-monobank
- Owner: vitalik
- Created: 2019-06-25T07:42:43.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-01-04T16:07:21.000Z (almost 6 years ago)
- Last Synced: 2025-07-08T00:51:43.812Z (3 months ago)
- Language: Python
- Homepage:
- Size: 104 KB
- Stars: 49
- Watchers: 2
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# python-monobank
Python client for Monobank API (https://api.monobank.ua/docs/)
## Installation
```
pip install monobank
```
# Usage
## Personal api
1) Request your token at https://api.monobank.ua/
2) Use that token to initialize client:
```python
import monobank
token = 'xxxxxxxxxxxxxxx'
mono = monobank.Client(token)
user_info = mono.get_client_info()
print(user_info)
```
### Methods
Get currencies
```python
>>> mono.get_currency()
[
{'currencyCodeA': 840,
'currencyCodeB': 980,
'date': 1561686005,
'rateBuy': 25.911,
'rateSell': 26.2357},
{'currencyCodeA': 978,
'currencyCodeB': 980,
'date': 1561686005,
'rateBuy': 29.111,
'rateSell': 29.7513},
...
```
Get client info
```python
>>> mono.get_client_info()
{
'name': 'Dmitriy Dubilet'
'accounts': [
{
'id': 'accidxxxxx'
'balance': 100000000,
'cashbackType': 'UAH',
'creditLimit': 100000000,
'currencyCode': 980,
}
],
}
```
Get statements
```python
>>> mono.get_statements('accidxxxxx', date(2019,1,1), date(2019,1,30))
[
{
'id': 'iZDPhf8v32Qass',
'amount': -127603,
'balance': 99872397,
'cashbackAmount': 2552,
'commissionRate': 0,
'currencyCode': 978,
'description': 'Smartass club',
'hold': True,
'mcc': 5411,
'operationAmount': 4289,
'time': 1561658263
},
...
]
```
You can as well pass datetime objects
```python
>>> mono.get_statements('accidxxxxx', datetime(2019,1,1,11,15), datetime(2019,1,2,11,15))
```
Create a Webhook
```python
>>> mono.create_webhook('https://myserver.com/hookpath')
```
## Corporatre API
Documentation is here - https://api.monobank.ua/docs/corporate.html
Corporate API have the same methods as Public API, but it does not have rate limitation, and it is a recomended way if you are handling data for commercial use (or just storing lot of personal data).
### Getting access
#### 1) Generate private key
```
openssl ecparam -genkey -name secp256k1 -rand /dev/urandom -out priv.key
```
This will output file **priv.key**
**Warning**: do not share it with anyone, do not store it in public git repositories
#### 2) Generate public key
```
openssl ec -in priv.key -pubout -out pub.key
```
This will output file **pub.key**
#### 3) Request API access
Send an email to api@monobank.ua - describe your project, and attach **pub.key** (!!! NOT priv.key !!!)
### Requesting permission from monobank user
Once your app got approved by Monobank team you can start using corporate API:
#### 1) Create monobank user access request
```python
private_key = '/path/to/your/priv.key'
request = monobank.access_request('ps', private_key)
```
If all fine you should recive the following:
```python
print(request)
{'tokenRequestId': 'abcdefg_Wg', 'acceptUrl': 'https://mbnk.app/auth/abcdefg_Wg'}
```
You should save tokenRequestId to database, and then give user the link acceptUrl
Note: To be notified about user acceptance you can use web callback:
```python
monobank.access_request('ps', private_key, callback_url='https://yourserver.com/callback/')
```
#### 2) Check if user accepted
You can check if user accepted access request like this:
```python
request_token = 'abcdefg_Wg' # the token from access_request result
private_key = '/path/to/your/priv.key'
mono = monobank.CorporateClient(request_token, private_key)
mono.check() # returns True if user accepted, False if not
```
#### 3) Use methods
Once user accepts your access-request, you can start using all the methods same ways as Public API
```python
mono.get_statements(....)
```
## Handling Errors
If you use Personal API you may encounter "Too Many Requests" error. To properly catch it and retry - use *monobank.TooManyRequests* exception
```python
try:
mono.get_statements(....)
except monobank.TooManyRequests:
time.sleep(1)
# try again:
mono.get_statements(....)
```
You can use ratelimiter library (like https://pypi.org/project/ratelimiter/ ) to download all transactions