api-monobank

[ library, mit, program, web ] [ Propose Tags ]

Api client for popular Ukrainian bank - Monobank


[Skip to Readme]
Versions [faq] 0.1.0.0, 0.1.0.1, 0.1.1.0, 0.1.2.0
Dependencies aeson, api-monobank, base (>=4.7 && <5), bytestring, http-client, http-client-tls, http-conduit, servant, servant-client, stm, text, time [details]
License MIT
Copyright Copyright: (c) 2019 Sergey Bushnyak
Author Sergey Bushnyak
Maintainer sergey.bushnyak@sigrlami.eu
Category Web
Home page https://github.com/sigrlami/api-monobank#readme
Source repo head: git clone https://github.com/sigrlami/api-monobank
Uploaded by sigrlami at Tue Jun 25 18:23:37 UTC 2019
Distributions NixOS:0.1.2.0
Executables mnb-app
Downloads 131 total (131 in the last 30 days)
Rating 2.0 (votes: 1) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs not available [build log]
All reported builds failed as of 2019-06-26 [all 3 reports]

Modules

  • Monobank
    • Monobank.Api
    • Monobank.Types
    • Monobank.Utils

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for api-monobank-0.1.2.0

[back to package description]

Monobank Api Client

Hackage Azure DevOps builds

Haskell client for Monobank API services.

Monobank Api

  1. Introduction
  2. Public API
  3. Private API
  4. Building library

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.

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 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

   {
    "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)

Building

  • 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 and use following

$ 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

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':

`getPersonalStatement' (Just "bm90IHNvIGZhc3QgSm9obm55") "0" "1559728800" ""