We provide both a Websocket API and Representational State Transfer (REST) API which you can easily access through HTTPS requests.
There are two types of API methods: public methods and private methods. Anyone can use the public methods, for instance to retrieve market data. All you need to do is to paste the HTTPS request in your browser or write a piece of code that sends these requests automatically.
To access the private methods, you need to be a verified client and generate your personal set of API keys.
The REST API allows to securely access the functionalities of your Kraken Derivatives account.
Examples of REST API functionalities:
Examples of REST API functionalities:
- •request current or historical price information
- •check your account balance and PnL
- •your margin parameters and estimated liquidation thresholds
- •place or cancel orders (individually or in batch)
- •see your open orders
- •open positions or trade history
- •request a digital asset withdrawal
These functionalities are called "endpoints" and are explained in REST API section.
The websocket API allows to securely establish a communication channel to the Kraken Derivatives platform to receive information in real time. This allows listening to updates instead of continuously sending requests. These channels are called subscriptions and are explained in Websocket API section.
Some of the endpoints allow performing sensitive tasks, such initiating a digital asset withdrawal. To access these endpoints securely, the API uses encryption techniques developed by the National Security Agency. This section describes how to encrypt your communication with the API when accessing these endpoints.
The API can be implemented using any programming language you like (e.g. C, C++, Java or PHP), as long as it is capable of managing HTTP requests. We strongly suggest you look at the code examples listed in Additional Resources section.
DISCLAIMER: Please use the API only if you have adequate programming skills and have fully understood its functionalities. Kraken Derivatives excludes all liability for losses and damages resulting from using the API, including, but not limited to, losses and damages resulting from erroneous use of the API, unavailability of the API, other technical failure or malfunction of the API or loss of API keys.