Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lorenzosinisi/exkontist
(not official) Kontist API client in Elixir
https://github.com/lorenzosinisi/exkontist
banking-api banking-applications interface
Last synced: 3 days ago
JSON representation
(not official) Kontist API client in Elixir
- Host: GitHub
- URL: https://github.com/lorenzosinisi/exkontist
- Owner: lorenzosinisi
- License: apache-2.0
- Created: 2019-09-09T15:07:46.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-09-09T15:19:55.000Z (over 5 years ago)
- Last Synced: 2024-10-08T14:50:52.395Z (3 months ago)
- Topics: banking-api, banking-applications, interface
- Language: Elixir
- Homepage: https://kontist.com/integrations
- Size: 12.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Exkontist - And Elixir client for Kontist API
**Client for Kontist APIs**
## NOTE
Nothing in this repo is provided or linked to http://kontist.com, this is an independent repository
that is just using their API. Use at your own risk.
## Login
Login to get a Bearer token which has to be passed for each subsequent request
```elixir
{:ok, %{"token" => token}} = Exkontist.Client.login(username, password)
```
## Get a User
Return a user and its settings
```elixir
Exkontist.Client.user(token)
```
## Get all bank accounts
```elixir
Exkontist.Client.accounts(token)
```
## Get all transactions from one bank account
```elixir
Exkontist.Client.account_transactions(account_id, token)
```
## Get all future transactions from one bank account
```elixir
Exkontist.Client.future_transactions(account_id, token)
```
## Get all standing orders from one bank account
```elixir
Exkontist.Client.standing_orders(account_id, token)
```
## Get all wire transfer suggestions from one bank account
```elixir
Exkontist.Client.wire_transfer_suggestions(account_id, token)
```
## Get your monthly statement
```elixir
Exkontist.Client.statement(year, month, token)
```
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `exkontist` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:exkontist, "~> 0.1.0"}
]
end
```
**TODO**
- implement post requests of the https://github.com/netnexus/IKontist/blob/master/src/kontist-client.ts
- write tests
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/exkontist](https://hexdocs.pm/exkontist).