KrakenEx.jl

Futures and Spot Websocket and REST API Julia SDK for the Kraken Cryptocurrency Exchange 🐙

GitHub License: GPL v3 Generic badge CI Documentation

This is an unofficial collection of REST and websocket clients for Spot and Futures trading on the Kraken cryptocurrency exchange using Julia.

This project is based on the python-kraken-sdk.

Disclaimer

There is no guarantee that this software will work flawlessly at this or later times. Of course, no responsibility is taken for possible profits or losses. This software probably has some errors in it, so use it at your own risk. Also no one should be motivated or tempted to invest assets in speculative forms of investment. By using this software you release the author(s) from any liability regarding the use of this software.

Features

Clients:

  • Spot REST Clients
  • Spot Websocket Client
  • Futures REST Clients
  • Futures Websocket Client

General:

Installation and setup

1. Install the Julia Package:

julia> using Pkg; Pkg.add("KrakenEx")

2. Register at Kraken and generate API Keys:

3. Start using the provided example scripts

4. Error handling

If any unexpected behavior occurs, please check your API permissions, rate limits, update the KrakenEx.jl package, see the Troubleshooting Troubleshooting section, and if the error persits please open an issue on GitHub.

Troubleshooting

  • Check if your version of KrakenEx.jl version is the newest.
  • Check the permissions of your API keys and the required permissions on the respective endpoints.
  • If you get some cloudflare or rate limit errors, please check your Kraken Tier level and maybe apply for a higher rank if required.
  • Use different API keys for different algorithms, because the nonce calculation is based on timestamps and a sent nonce must always be the highest nonce ever sent of that API key. Having multiple algorithms using the same keys will result in invalid nonce errors.

Notes

  • Coding standards are not always followed to make arguments and function names as similar as possible to those in the Kraken API documentations.

  • When calling endpoints for examlpe the futures funding endpoint and you submit spaces, braces, etc in strings like " ()[]{}|/\*.+!^" a KrakenAuthenticationError will be raised.

References