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.
Platform overview
The Kraken Derivatives platform provides access via REST, WebSocket, and FIX APIs. For FIX, refer to the FIX introduction for session setup and authentication. The REST API provides secure access to your Derivatives account to:- Request current or historical price information
- Check your account balance and PnL
- View margin parameters and estimated liquidation thresholds
- Place or cancel orders (individually or in batch)
- View open orders, open positions, or trade history
- Request a digital asset withdrawal
Conventions
Server time
All timestamps are in Coordinated Universal Time (UTC).Unique identifiers
Dates and times
<yyyy>-<mm>-<dd>T<HH>:<MM>:<SS>.<sss>Z. The millisecond component <sss> is optional when provided as an argument. Z denotes UTC.
Symbols
The system identifies accounts, margin accounts, futures contracts, and indices through ticker symbols:| Symbol | Description |
|---|---|
xbt | Bitcoin |
xrp | Ripple XRP |
fi_xbtusd | Bitcoin-Dollar Futures Margin Account |
fi_xrpusd | Ripple-Dollar Futures Margin Account |
fi_xbtusd_180615 | Bitcoin-Dollar Futures, maturing 16:00 London time 15 June 2018 |
in_xbtusd | Bitcoin-Dollar Real-Time Index |
rr_xbtusd | Bitcoin-Dollar Reference Rate |
Generate API keys
- Sign in to your Derivatives account.
- Click your name in the upper-right corner.
- Select Settings from the drop-down menu.
- Select the Create Key tab in the API panel.
- Choose the access level: General API: No Access / Read Only / Full Access (excludes withdrawals) Withdrawal API: No Access / Full Access (controls withdrawal permissions)
- Press Create Key.
- Record your Public and Private keys somewhere safe.
Key limits
Up to 50 keys can be created per account, each with a distinct nonce.API testing environment
A fully functional demo environment is available at demo-futures.kraken.com. It is completely separate from production and does not require existing account credentials. To get started:- Navigate to demo-futures.kraken.com
- Click Sign Up — email and password are generated automatically
- Accept the Demo Terms & Conditions and Privacy Policy
- Note your credentials for reuse, then select Complete Sign-Up
| Environment | Base URL |
|---|---|
| Production | https://futures.kraken.com |
| Demo | https://demo-futures.kraken.com |
wss://demo-futures.kraken.com/ws/v1
REST (demo): https://demo-futures.kraken.com/derivatives/api/v3/tickers
API URLs
REST API:Direct access URLs for IP whitelisting are different from the above. Contact your Account Manager for whitelisted endpoint details.