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.

2026

28 April 2026 — Spot WS v2

  • Added execution_venue subscription parameter to the instrument channel (one of international, bitnomial-exchange; defaults to international)

27 April 2026 — Spot REST v1

  • Added execution_venue field to AssetPairs response (one of international, bitnomial_exchange)

11 March 2026 — Spot REST v1

  • Added GetApiKeyInfo endpoint to retrieve API key configuration and usage

2025

15 December 2025 — Spot REST v1

  • Added Level3 endpoint for individual order-level (L3) order book data
  • Added GroupedBook endpoint for aggregated order book data over configurable tick size

15 December 2025 — General Docs

  • Migrated blog content to guides section
  • Refreshed navigation menus for improved discoverability

2 December 2025 — Spot WS v2

  • L3 WebSocket endpoint URL changed from wss://ws-auth.kraken.com/v2 to wss://ws-l3.kraken.com/v2

13 November 2025 — Spot ALL

  • Deprecated .F asset values returned by Balance and BalanceEx endpoints

18 September 2025 — Spot ALL

  • Deprecated no_mpp parameter on AddOrder, EditOrder, and AddOrderBatch

5 September 2025 — Spot REST v1

  • Added asset_class filter parameter to Ticker endpoint

15 August 2025 — Spot REST v1

  • Added asset_class parameter to market data and trading endpoints for xStocks

15 August 2025 — Spot WS v2

  • Added rebased parameter to executions and balances requests to specify xStocks mode

15 August 2025 — Spot WS v1

  • Added rebased parameter to openOrders and ownTrades requests to specify xStocks mode

15 August 2025 — Spot FIX v1

  • Added Tag 5051 to Logon requests to specify xStocks mode
  • Added TS SecurityType to InstrumentListRequest

4 August 2025 — Derivatives REST v1

  • Announced upcoming authentication breaking change effective October 1st, 2025

28 July 2025 — Spot REST v1

  • Added documentation for CreditLines endpoint

24 June 2025 — Spot REST v1

  • Fixed error message formatting on Account Data endpoints

29 May 2025 — Spot FIX v1

  • Added Tag 78 and 79 for Subaccount Management for Broker accounts

28 May 2025 — Spot REST v1

  • Moved OTC endpoints to Institutional menu section

28 May 2025 — Spot WS v2

  • Added user field to executions and balances channels to help identify the account

8 May 2025 — Spot WS v1 (v1.9.6)

  • Added stp_type to addOrder providing self trade prevention options

8 May 2025 — Spot WS v2 (v2.0.10)

  • Added timestamp field to level3 channel to help clients track market data sequence

8 March 2025 — Derivatives FIX v1

  • FIX now supports futures trading

2024

28 September 2024 — Spot FIX v1

  • Added Tag 5050 LiquidityInd in ExecutionReport

27 September 2024 — Spot REST v1

  • Added AmendOrder endpoint to modify order parameters
  • Added OrderAmends endpoint to retrieve an audit trail of amend transactions
  • Added amended flag to OpenOrders and ClosedOrders endpoints to identify amended orders

27 September 2024 — Spot WS v1 (v1.9.5)

  • Added amendOrder endpoint to modify order parameters
  • Added amended flag to openOrders channel to identify amended orders

27 September 2024 — Spot WS v2 (v2.0.9)

  • Added amend_order endpoint to modify order parameters
  • Added amended exec_type to executions channel to identify amended orders

27 September 2024 — Spot FIX v1

  • Added order cancel-replace request message MsgType=G to modify order parameters

5 September 2024 — Spot REST v1

  • Added cl_ord_id parameter to query endpoints: ClosedOrders, OpenOrders

22 August 2024 — Spot WS v2 (v2.0.8)

  • Added liquidated flag to executions channel to show when an order has been liquidated
  • Added subscription rate limits to the level3 market data feed

1 August 2024 — Spot WS v2 (v2.0.7)

  • snap_trades parameter now defaults to false
  • Added ext_ord_id field to openOrders and executions
  • Added ext_exec_id field to ownTrades and executions
  • Added margin_borrow flag to ownTrades and executions

27 June 2024 — Spot WS v2 (v2.0.6)

  • Deprecated snapshot and snapshot_trades in executions channel

24 June 2024 — Spot REST v1

  • Added cl_ord_id parameter to order endpoints: AddOrder, CancelOrder

30 May 2024 — Spot WS v2 (v2.0.5)

  • Modified balances channel to always include wallet breakdown and cumulative balance
  • Added asset_class to balances channel for future expansion

23 May 2024 — Spot FIX v1.8

  • Changed ClOrdId (Tag 11) and OrigClOrdId format and validation

21 May 2024 — Spot REST v1

  • Added country_code parameter to AssetPairs

16 May 2024 — Spot WS v2 (v2.0.4)

  • Added cl_ord_id and sender_sub_id client order identifiers
  • Clarified that GTD expire time is one month

16 May 2024 — Spot WS v1 (v1.9.3)

  • Added cl_ord_id and sender_sub_id client order identifiers
  • Added margin indicator for leveraged orders

14 May 2024 — Spot REST v1

  • Added cl_ord_id and sender_sub_id identifiers to order queries
  • Added margin indicator to leveraged orders

18 April 2024 — Spot FIX v1.7

  • Added iceberg and trailing-stop order types to FIX

1 March 2024 — Spot REST v1

  • Removed Staking section, deprecated and no longer supported

1 March 2024 — Spot WS v2 (v2.0.3)

  • Added event_trigger parameter to the ticker channel

15 February 2024 — Spot WS v2 (v2.0.2)

  • Added cash_order_qty to the executions channel

1 February 2024 — Spot REST v1

  • Added maker and ledgers fields to TradesHistory and QueryTrades

10 January 2024 — Spot WS v1 (v1.9.2)

  • Narrowed range of valid offsets (from current time) for the deadline parameter

1 January 2024 — Spot REST v1

  • Removed support for POST requests to all public endpoints
  • Added migration notes to Balance and Ledger endpoints

2023

14 December 2023 — Spot WS v2 (v2.0.1)

  • Added trailing-stop and trailing-stop-limit order types
  • Added trigger protection during connectivity issues with index providers

14 December 2023 — Spot REST v1

  • Added trailing-stop and trailing-stop-limit order types

7 December 2023 — Spot WS v2 (v2.0.0)

  • WebSocket v2 taken out of beta
  • Added status and restated values to exec_type
  • Added support for native amends in level3 channel
  • Enabled level3 channel in all environments
  • Added support for new ledger types in balances channel
  • Enabled balances channel in all environments
  • Deprecated cancel_reason in executions channel — use reason instead

1 November 2023 — Spot REST v1

  • Added WithdrawMethods and WithdrawAddresses endpoints
  • Added start, end, cursor, and limit parameters to WithdrawStatus

30 October 2023 — Spot FIX v1.0.0

  • Added Tag 5041 ChecksumOrderBook parameter

1 October 2023 — Spot REST v1

  • Added max_fee parameter to Withdraw and minimum field in response

1 September 2023 — Spot REST v1

  • Added start, end, cursor, and limit parameters to DepositStatus

1 August 2023 — Spot REST v1

  • Added earn / balance service documentation

14 July 2023 — Spot WS v2 (beta)

  • Added support for iceberg order type

1 July 2023 — Spot REST v1

  • Added private BalanceEx documentation

1 June 2023 — Spot FIX v1.0.0

  • First version of FIX API in production beta

1 June 2023 — Spot REST v1

  • Added amount parameter to DepositAddresses
  • Added count parameter to Trades

1 May 2023 — Spot REST v1

  • Added address parameter to Withdraw
  • Added since parameter to Spread

3 April 2023 — Spot WS v2 (beta)

  • OHLC channel: added interval field to request parameters

22 March 2023 — Spot WS v2 (beta)

  • Edit Order request: added limit_price field, deprecated price field
  • executions channel: added margin field to order details
  • instrument channel: added additional support for price_precision

15 March 2023 — Spot WS v2 (beta)

  • executions channel: added last_qty and last_price fields to trade events
  • OHLC channel: added interval and interval_begin fields
  • Corrected default time_in_force settings

2 March 2023 — Spot WS v1 (v1.9.1)

  • Added contingent field on private open order feed
  • Enabled fast reconnect on WebSockets following trading engine maintenance

1 March 2023 — Spot REST v1

  • Added originators parameter to DepositStatus

1 February 2023 — Spot REST v1

  • Added long and short position limits to AssetPairs
  • Specified minimum and maximum number of txids and userrefs
  • Specified maximum number of responses for DepositStatus and WithdrawStatus
  • Added note to use %2b instead of + for URL encoding

1 January 2023 — Spot REST v1

  • Removed requirement for asset in DepositStatus and WithdrawStatus
  • Documented reduce_only parameter
  • Added consolidate_taker to TradesHistory, ClosedOrders, and QueryOrders
  • Added Subaccounts section
  • Added trade_id to private TradesHistory

2022

1 December 2022 — Spot REST v1

  • Fixed pair parameter restriction on TradeVolume
  • EditOrder now allowed on margin orders

28 November 2022 — Spot WS v2 (beta)

  • Corrected several details in the executions channel

22 November 2022 — Spot WS v2 (beta)

  • Removed internal version from the About section
  • Multiple formatting and data corrections

1 November 2022 — Spot REST v1

  • Added tick_size and status parameters to AssetPairs
  • Added status and collateral_value to Assets
  • Added trade_id to public Trades

1 October 2022 — Spot REST v1

  • Documented uv (unexecuted value) field in TradeBalance
  • Added costmin trading parameter to AssetPairs
  • Ticker wildcard support — pair no longer required

1 September 2022 — Spot REST v1

  • AddOrder, EditOrder, and AddOrderBatch now support iceberg orders

1 July 2022 — Spot REST v1

  • Added support for restricting API keys to specified IP address(es)

1 June 2022 — Spot REST v1

  • Added custom self trade prevention options

1 May 2022 — Spot REST v1

  • New AddOrderBatch endpoint to send multiple new orders
  • New CancelOrderBatch endpoint to cancel multiple open orders

22 March 2022 — Spot WS v1 (v1.9.0)

  • Added support for editOrder

1 March 2022 — Spot REST v1

  • New EditOrder endpoint to edit volume and price on open orders

2021

1 December 2021 — Spot REST v1

  • Added trigger optional parameter to AddOrder

31 March 2021 — Spot WS v1 (v1.8.3)

  • Added deadline support to addOrder

25 February 2021 — Spot WS v1 (v1.8.0)

  • Added timeinforce and Immediate-or-Cancel (IOC) support

4 February 2021 — Spot WS v1 (v1.7.1)

  • Changed close code to 1008 (Policy Violation) from 1013
  • Added policy rule for maximum rate of subscriptions
  • Added new generic error type with optional internal error codes
  • Improved public market data snapshot performance

30 January 2021 — Spot WS v1 (v1.7.0)

  • Added userref field to openOrders and ownTrades update messages

13 January 2021 — Spot WS v1 (v1.6.1)

  • Added Dead Man’s Switch (cancelAllOrdersAfter) REST endpoint
  • Fixed intermittent public data WebSocket feed latency

2020

21 December 2020 — Spot WS v1 (v1.6.0)

  • Introduced post_only trading mode for maintenance procedure

5 December 2020 — Spot WS v1 (v1.5.0)

  • Added optional ratecounter argument for openOrders subscription
  • Added maxratecount and current ratecount reporting
  • Added cancel_only trading mode
  • Relaxed slow-consumer constraint on WebSocket connections
  • Maintained private WebSocket connections during maintenance
  • Improved public market data snapshot/stream synchronisation

18 November 2020 — Spot WS v1 (v1.4.1)

  • Added cancelAll REST endpoint

2 November 2020 — Spot WS v1 (v1.4.0)

  • Added cancelAll trading request functionality
  • Performance upgrade to cancelOrder request handling
  • Improved messages and close codes when closing WebSocket connections
  • Fixed incorrect error for addOrder with invalid pair

27 October 2020 — Spot WS v1 (v1.3.0)

  • Added sequence numbers on private feeds (openOrders, ownTrades)

12 October 2020 — Spot WS v1 (v1.2.1)

  • Eliminated trading rate limit penalty for filled orders
  • Performance improvement for REST real-time and historical market data
  • Rejected market conditional close orders
  • Fixed intermittent bug affecting Ticker REST endpoint

31 August 2020 — Spot WS v1 (v1.2.0)

  • Added cancel_reason to openOrders stream
  • Added optional snapshot parameter for ownTrades feed

22 June 2020 — Spot WS v1 (v1.1.0)

  • Added order book checksum

18 February 2020 — Spot WS v1 (v1.0.7)

  • Added addOrder and cancelOrder endpoints

2019

1 October 2019 — Spot WS v1 (v1.0.6)

  • Introduced openOrders and ownTrades channels

4 February 2019 — Spot WS v1 (v1.0.5)

  • Fixed publishing of deleted price levels

23 January 2019 — Spot WS v1 (v1.0.4)

  • Added connectionID field to systemStatus message

18 January 2019 — Spot WS v1 (v1.0.3)

  • Added open prices on ohlc including 24-hour values
  • Increased timestamp precision to microseconds
  • Updated sandbox URL

2018

24 December 2018 — Spot WS v1 (v1.0.2)

  • Changed timestamp field to string type

7 December 2018 — Spot WS v1 (v1.0.1)

  • Released WebSocket public market data sandbox v0.0.4
  • Changed timestamp precision to milliseconds

28 November 2018 — Spot WS v1 (v1.0.0)

  • Released WebSocket public market data sandbox v0.0.3