Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edennis/krakex
Elixir client for the Kraken Bitcoin Exchange API
https://github.com/edennis/krakex
bitcoin crypto-exchange cryptocurrency elixir-client kraken kraken-exchange-api
Last synced: 8 days ago
JSON representation
Elixir client for the Kraken Bitcoin Exchange API
- Host: GitHub
- URL: https://github.com/edennis/krakex
- Owner: edennis
- License: mit
- Created: 2017-11-17T20:45:17.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-01-08T12:09:56.000Z (about 3 years ago)
- Last Synced: 2023-09-16T16:28:20.104Z (over 1 year ago)
- Topics: bitcoin, crypto-exchange, cryptocurrency, elixir-client, kraken, kraken-exchange-api
- Language: Elixir
- Size: 145 KB
- Stars: 22
- Watchers: 2
- Forks: 15
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Krakex
[](https://github.com/edennis/krakex/actions/workflows/elixir.yml)
[](https://coveralls.io/github/edennis/krakex?branch=master)
[](https://hex.pm/packages/krakex)
Elixir client for the [Kraken Bitcoin Exchange API](https://www.kraken.com/help/api)
> Note that this README refers to the `master` branch of Krakex, not the latest
released version on Hex. See [the documentation](http://hexdocs.pm/krakex) for
the documentation of the version you're using.
## Installation
The package can be installed by adding `krakex` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:krakex, "~> 0.7.0"}
]
end
```
## Configuration
The Kraken API consists of public and private calls. While you can use the public API as you like,
you'll need to create an account and get yourself an API key if you want to do more. To use the
private API you'll need to add some configuration to your Mix config:
```elixir
config :krakex,
api_key: System.get_env("KRAKEN_API_KEY"),
private_key: System.get_env("KRAKEN_PRIVATE_KEY")
```
## Usage
The entire functionality of the API can be accessed via the `Krakex` module. To get started just
configure your API credentials as described above and call the functions:
```elixir
iex(1)> Krakex.balance()
{:ok,
%{"BCH" => "0.0000000000", "XETH" => "0.0000000000", "ZEUR" => "50.00"}}
```
If you need to use multiple Kraken accounts in your application this can be achieved by explicitly
defining `Krakex.Client` structs and passing them as the first argument to any of the functions
defined in the `Krakex` module:
```elixir
client1 = Krakex.Client.new("api_key1", "secret1")
client2 = Krakex.Client.new("api_key2", "secret2")
balance1 = client1 |> Krakex.trade_balance(asset: "ZUSD")
balance2 = client2 |> Krakex.trade_balance(asset: "EUR")
```
## TODO - Help wanted!
### Private user data
- [ ] [`add_export/3`](https://www.kraken.com/features/api#add-history-export)
- [ ] [`export_status/2`](https://www.kraken.com/features/api#get-export-statuses)
- [ ] [`retrieve_export/2`](https://www.kraken.com/features/api#get-history-export)
- [ ] [`remove_export/3`](https://www.kraken.com/features/api#remove-history-export)
### Private user trading
- [ ] [`cancel_all/1`](https://www.kraken.com/features/api#cancel-all-open-orders)
- [ ] [`cancel_all_orders_after/2`](https://www.kraken.com/features/api#cancel-all-orders-after)
### Private user funding calls
- [ ] [`withdraw/5`](https://www.kraken.com/help/api#withdraw-funds)
- [ ] [`withdraw_status/3`](https://www.kraken.com/help/api#withdraw-status)
- [ ] [`withdraw_cancel/4`](https://www.kraken.com/help/api#withdraw-cancel)
- [ ] [`wallet_transfer/4`](https://www.kraken.com/features/api#wallet-transfer)
## Contributing
1. Fork it (https://github.com/edennis/krakex/fork)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Copyright (c) 2018 Erick Dennis