Skip to main content

Documentation Index

Fetch the complete documentation index at: https://kraken-sandbox.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
OpenAPI spec

Spot REST OpenAPI

Download the Spot REST OpenAPI spec (YAML)

Derivatives REST OpenAPI

Download the Derivatives REST OpenAPI spec (YAML)

​
API Organisation

The Spot REST API is organised by function, covering a wide range of services:

​
Requests, Responses and Errors

​
Requests

Request payloads supports Json encoding (Content-Type: application/json) as well as form-encoded (Content-Type: application/x-www-form-urlencoded). We recommend clients to specify User-Agent in the headers of all their requests. This will help us optimize interactions and improve the overall efficiency and security of the API.

​
Responses

Responses are JSON encoded and contain one or two top-level keys (result and error for successful requests or those with warnings, or only error for failed or rejected requests)

​
Example

Request: 
GET <https://api.kraken.com/0/public/SystemStatus>
Successful response: 
{
    "error": [],
    "result": {
        "status": "online",
        "timestamp": "2021-03-22T17:18:03Z"
    }
}
Error response: 
{
    "error": [
        "EGeneral:Invalid arguments:ordertype"
    ]
}

​
Error Details

HTTP status codes are generally not used by our API to convey information about the state of requests and any errors or warnings are denoted in the error field of the response as described above. Status codes other than 200 indicate that there was an issue with the request reaching our servers. Error messages follow the general format “<severity><category>: <description>”
  • <severity> : E for error, W for warning.
  • <category> : General, Auth, API, Query, Order, Trade, Funding, or Service.
  • <description> : a text string that describes the reason for the error.
i.e., "EGeneral: Invalid arguments:ordertype"
Additional information can be found on the error reference guide or the support center.

Authentication

HMAC-SHA512 signature, nonce management, and API-Key header

API key permissions

Which permissions to enable for each use case

Error reference

Full list of error codes and handling strategies

Rate limits

How the REST rate counter works

API comparison

When to use REST vs WebSocket vs FIX