Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sigrlami/api-monobank
Haskell client for Monobank Api
https://github.com/sigrlami/api-monobank
api monobank
Last synced: 8 days ago
JSON representation
Haskell client for Monobank Api
- Host: GitHub
- URL: https://github.com/sigrlami/api-monobank
- Owner: sigrlami
- License: mit
- Created: 2019-06-25T07:47:11.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-01-10T18:41:31.000Z (almost 5 years ago)
- Last Synced: 2024-10-12T23:26:15.974Z (24 days ago)
- Topics: api, monobank
- Language: Haskell
- Homepage: https://api.monobank.ua/docs/
- Size: 161 KB
- Stars: 23
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Monobank Api Client
Haskell client for Monobank API [services](https://api.monobank.ua/docs/).
1. [Introduction](#introduction)
2. [Public API](#public)
3. [Private API](#private)
4. [Using library](#use)
5. [Example](#example)
6. [Say Thanks](#contributions)
## Introduction
API for extracting information and personal account status. To grant access, you must pass the authorization in your personal office at https://api.monobank.ua/ and get a token for personal use.
If you have questions about the operation of the API, we invite to the community in the [Telegram channel](https://t.me/joinchat/FiAEWhDf-QzTqM4wzEtffw).
If you have a service or application and you want to centrally join the API for customer service, you need to connect to a [corporate](https://api.monobank.ua/docs/corporate.html) API that has more features.
This will allow monobank clients to log in to your service (for example, in a financial manager) to provide information about the status of an account or statements.
In the event of the exploitation of this API as corporate, the bank reserves the right to impose sanctions on the company.
## Public
General information provided without authorization.
| # |Path | Type | Params | Description | Response | Notes|
|---|---------------|------|--------|----------------------|----------|------|
| 1 | /bank/currency| GET | | Get a basic list of monobank currency rates. Information is cached and updated no more than once every 5 minutes. | JSON | Response will be a json array with objects of 2 types
```json
{
"currencyCodeA": 978,
"currencyCodeB": 840,
"date": 1561426807,
"rateBuy": 1.1249,
"rateSell": 1.1368
},
{
"currencyCodeA": 826,
"currencyCodeB": 980,
"date": 1561461569,
"rateCross": 33.2857
},
```
note the absence of `rateBuy`, `rateSell` in a second example.Inside client system automatically convert `int` base date into normalized `UTCTime` format.
## Private
Information provided with authorization.
| # |Path | Type | Params | Description | Response | Notes|
|---|----------------------|------|-------------------------------| ---------------------|----------|------|
| 1 | /personal/client-info| GET | | Obtaining information about the client and the list of his accounts. Limit on the use of the function no more than 1 time in 60 seconds.| JSON |
| | | | `X-Token` string; `in header` | Token for personal access to the API | |
| 2 | /personal/statement | GET | /{account}/{from}/{to} | Receive an extract for the time from {to} to {to} time in seconds Unix time format. The maximum time for which it is possible to extract an extract is 31 days (2678400 seconds) Limit on the use of the function no more than 1 time in 60 seconds. | JSON |
| | | | `X-Token` string; in `header` | Token for personal access to the API | |
| | | | `account` string; in `path` | Account ID from the Statement list list or 0 is a default account.
| | | | `from` string; in `path` | Start of the excerpt time
| | | | `to` string; in `path` | End time of the excerpt (if not, the current time will be used)
## Use
- `src` - contains actual API that can be used in 3rd part apps
- `app` - executable for CLI app that can be used to view current value or run continuosly
Just build repository with `stack build`
```
$ stack exec -- mnb-app
```
or simply `mnb-app` if you used `stack install` command
```
$ mnb-app
```
that will bring following output if runned without keys, currency info
```
Monobank | Not tokenized API access available for currencies only
Monobank | Getting last currency prices
USD/UAH
- Buy: 25.961 ₴
- Sell: 26.2357₴
EUR/UAH
- Buy: 29.161 ₴
- Sell: 29.9294₴
RUB/UAH
- Buy: 0.378 ₴
- Sell: 0.418₴
TRY/UAH
- Cross: 4.5473₴
...
```
Getting personal information with function `getPersonalInfo'` supply token
```
getPersonalInfo' (Just "bm90IHNvIGZhc3QgSm9obm55")
```
Lead to response:
```
Right (User {uName = "Paul Atreides", uAccounts = [Account {acId = "jTw-r2md_cykrO9vdNgNyQ", acBalance = 4446033, acCreditLimit = 10000000, acCurrencyCode = 980, acCashbackType = "UAH"},Account {acId = "8uZb22LO716bxAYRJ6FxG-ZA", acBalance = 17520, acCreditLimit = 0, acCurrencyCode = 840, acCashbackType = "None"},Account {acId = "6s-YdQTmX7MhndGGXPHEjg", acBalance = 5000, acCreditLimit = 0, acCurrencyCode = 978, acCashbackType = "None"}]})
```
Getting transations avalable with `getPersonalStatement''` function like this
```haskell
getPersonalStatement'' (Just "bm90IHNvIGZhc3QgSm9obm55") "0" "2019-06-05 10:00:00" "2019-06-25 10:00:00"
```
where you can have date in normal, human-readable form. They are converted to Posix based Unix epoch string automatically. If you want to calculate Unix epoch on your own, use raw access function `getPersonalStatement'`:
```haskell
`getPersonalStatement' (Just "bm90IHNvIGZhc3QgSm9obm55") "0" "1559728800" ""
```
## Example
Accumulated statement by month for the year. Implemented inside [Monolytics](https://github.com/sigrlami/monolytics) app with data collected by this API client.
## Contributions
Say thanks, send tip:
- `monobank`: https://send.monobank.com.ua/3BNNDq3CV
- `btc`: 39oVXpsgsyW8ZgzsnX3sV7HLdtXWfT96qN
- `fct`: FA38cwer93mmPw1HxjScLmK1yF9iJTu5P87T2vdkbuLovm2YXyss
- `eth`: 0x9cDBA6bb44772259B3A3fb89cf233A147a720f34
- `xlm`: GD2FROTYXYSNOQQREYXHCXVOYWV556EM6PAHMVUHJNJEUYTUXUSNUZQ3