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.
WSS ws.kraken.com book
Order book levels. On subscription, a snapshot is published at the specified depth, followed by level updates. Subscription depth options are 10, 25, 100, 500, or 1000 levels per side.
Subscribe
Example: ["BTC/USD", "MATIC/GBP"]The currency pairs for this request.
One of: 10, 25, 100, 500, 1000
Default: 10Specifies the number of price levels (in each side of the book) to be received.
Optional client originated request identifier sent as acknowledgment in the response.
The subscription status is returned via the subscriptionStatus message.
Snapshot
Note, there is no checksum on the snapshot.
Deprecated: use channelName and pairChannel identifier.
Ask price levels, ascending from best ask. Price level volume, for updates volume = 0 for level removal/deletion.
Format: Epoch Seconds
Example: 1534614248.456738Timestamp when the level last updated.
Bid price levels, ascending from best bid. Price level volume, for updates volume = 0 for level removal/deletion.
Format: Epoch Seconds
Example: 1534614248.456738Timestamp when the level last updated.
Example: "BTC/USD"The symbol of the currency pair.
Update
Deprecated: use channelName and pairChannel identifier.
Ask price levels. The price for this level.
The cumulative volume at this price level. If volume is 0, remove level from book.
Format: Epoch Seconds
Example: 1534614248.456738Timestamp when the level was last updated.
One of: r
Condition: Republish only
Example: "4088505763"
Condition: Only present on last updateBook checksum as a quoted unsigned 32-bit integer.
Bid price levels. The price for this level.
The cumulative volume at this price level. If volume is 0, remove level from book.
Format: Epoch Seconds
Example: 1534614248.456738Timestamp when the level was last updated.
One of: r
Condition: Republish only
Example: "4088505763"
Condition: Only present on last updateBook checksum as a quoted unsigned 32-bit integer.
Example: "BTC/USD"The symbol of the currency pair.
Unsubscribe
Example: ["BTC/USD", "MATIC/GBP"]
Condition: All channels which support pair subscriptionsThe currency pairs to unsubscribe.
Optional client originated request identifier sent as acknowledgment in the response.
Condition: ‘book’ channel onlyUnsubscribe to a specific depth.
The unsubscription status is returned via the subscriptionStatus message.