TheDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/sieblyio/kraken-api/llms.txt
Use this file to discover all available pages before exploring further.
SpotClient exposes a suite of public market data methods that require no authentication. You can call these endpoints immediately after constructing a client — no API key or secret is needed. These methods cover everything from system health checks to real-time order book snapshots, giving you all the market context required to build trading strategies, dashboards, and data pipelines.
getServerTime()
Get the current server time.
Signature
This method takes no parameters.
| Property | Value |
|---|---|
| HTTP method | GET |
| Endpoint | 0/public/Time |
| Auth required | No |
| Field | Type | Description |
|---|---|---|
unixtime | number | Current Unix timestamp (seconds) |
rfc1123 | string | Current time in RFC 1123 format |
getSystemStatus()
Get the current system status or trading mode.
Signature
This method takes no parameters.
| Property | Value |
|---|---|
| HTTP method | GET |
| Endpoint | 0/public/SystemStatus |
| Auth required | No |
| Field | Type | Description |
|---|---|---|
status | 'online' | 'maintenance' | 'cancel_only' | 'post_only' | Current trading mode |
timestamp | string | ISO 8601 timestamp |
Check
status before placing orders. The exchange may be in cancel_only (no new orders) or post_only (only maker orders) mode during degraded conditions.getAssetInfo(params?)
Get information about the assets that are available for deposit, withdrawal, trading, and earn.
Signature
Comma-delimited list of assets to filter by (e.g.
"XBT,ETH"). Omit to return all assets.Asset class filter. Defaults to
currency.| Property | Value |
|---|---|
| HTTP method | GET |
| Endpoint | 0/public/Assets |
| Auth required | No |
Record<string, SpotAssetInfo>
Each key is an asset identifier (e.g. "XXBT"), and the value contains:
| Field | Type | Description |
|---|---|---|
aclass | string | Asset class |
altname | string | Alternate asset name |
decimals | number | Scaling decimal places for record keeping |
display_decimals | number | Scaling decimal places for display purposes |
collateral_value | number? | Collateral value used in margin |
status | string? | Asset status |
getAssetPairs(params?)
Get tradable asset pairs and their detailed specifications including fees, precision, and leverage settings.
Signature
Comma-delimited list of asset pairs to query (e.g.
"XBTUSD,ETHUSD"). Omit to return all pairs.Info to retrieve. Defaults to
info (full pair data).Filter pairs by base asset class.
Two-letter country code to filter pairs available in that region.
Filter by execution venue.
| Property | Value |
|---|---|
| HTTP method | GET |
| Endpoint | 0/public/AssetPairs |
| Auth required | No |
Record<string, SpotAssetPair>
| Field | Type | Description |
|---|---|---|
altname | string | Alternate pair name |
wsname | string? | WebSocket pair name |
base | string | Base asset |
quote | string | Quote asset |
pair_decimals | number | Decimal places for pair |
lot_decimals | number | Decimal places for volume |
ordermin | string | Minimum order size |
costmin | string? | Minimum order cost |
tick_size | string? | Minimum price increment |
fees | number[][]? | Taker fee schedule [volume, percent_fee] |
fees_maker | number[][]? | Maker fee schedule |
leverage_buy | number[]? | Available buy leverage |
leverage_sell | number[]? | Available sell leverage |
getTicker(params?)
Get ticker information for all or requested markets. Today’s prices start at midnight UTC.
Signature
Asset pair to get ticker for (e.g.
"XBTUSD"). Leaving this blank returns tickers for all tradeable assets on Kraken.Filter by asset class.
| Property | Value |
|---|---|
| HTTP method | GET |
| Endpoint | 0/public/Ticker |
| Auth required | No |
Record<string, SpotAssetTickerInfo>
| Field | Type | Description |
|---|---|---|
a | string[] | Ask [price, whole lot volume, lot volume] |
b | string[] | Bid [price, whole lot volume, lot volume] |
c | string[] | Last trade closed [price, lot volume] |
v | string[] | Volume [today, last 24 hours] |
p | string[] | Volume weighted average price [today, last 24 hours] |
t | number[] | Number of trades [today, last 24 hours] |
l | string[] | Low [today, last 24 hours] |
h | string[] | High [today, last 24 hours] |
o | string | Today’s opening price |
getCandles(params)
Retrieve OHLC (Open/High/Low/Close) candlestick data. Returns up to 720 of the most recent entries. The last entry in the array represents the current, not-yet-committed timeframe and is always present.
Signature
Asset pair to get OHLC data for (e.g.
"XBTUSD").Time frame interval in minutes. Defaults to
1.| Value | Label |
|---|---|
1 | 1 minute |
5 | 5 minutes |
15 | 15 minutes |
30 | 30 minutes |
60 | 1 hour |
240 | 4 hours |
1440 | 1 day |
10080 | 1 week |
21600 | 15 days |
Unix timestamp to get OHLC data from. Note: this does not filter results — it controls which cached dataset is used as the starting point.
Asset class filter.
| Property | Value |
|---|---|
| HTTP method | GET |
| Endpoint | 0/public/OHLC |
| Auth required | No |
SpotOHLCResponse
Each OHLC entry is a tuple: [time, open, high, low, close, vwap, volume, count]
| Index | Type | Description |
|---|---|---|
0 | number | Unix timestamp |
1 | string | Open price |
2 | string | High price |
3 | string | Low price |
4 | string | Close price |
5 | string | Volume weighted average price |
6 | string | Volume |
7 | number | Trade count |
getOrderBook(params)
Returns the Level 2 (L2) order book, showing individual price levels with aggregated order quantities.
Signature
Asset pair to get order book for (e.g.
"XBTUSD").Maximum number of asks/bids to return. Range: 1–500. Defaults to 100.
Asset class filter.
| Property | Value |
|---|---|
| HTTP method | GET |
| Endpoint | 0/public/Depth |
| Auth required | No |
SpotOrderBookResponse
Each book entry is a tuple: [price, volume, timestamp]
getRecentTrades(params)
Returns recent trades. By default, returns the last 1000 trades.
Signature
Asset pair to get recent trades for (e.g.
"XBTUSD").Return trades after this trade ID (from a previous response’s
last field).Maximum number of trades to return. Range: 1–1000. Defaults to 1000.
Asset class filter.
| Property | Value |
|---|---|
| HTTP method | GET |
| Endpoint | 0/public/Trades |
| Auth required | No |
SpotRecentTradesResponse
Each trade entry is a tuple: [price, volume, time, buy/sell, market/limit, miscellaneous, trade_id]
| Index | Type | Description |
|---|---|---|
0 | string | Price |
1 | string | Volume |
2 | number | Timestamp |
3 | string | "b" (buy) or "s" (sell) |
4 | string | "m" (market) or "l" (limit) |
5 | string | Miscellaneous flags |
6 | number | Trade ID |
getRecentSpreads(params)
Returns the last ~200 top-of-book bid/ask spreads for a given pair.
Signature
Asset pair to get spread data for (e.g.
"XBTUSD").Unix timestamp to return spreads from. Used for incremental data fetches.
Asset class filter.
| Property | Value |
|---|---|
| HTTP method | GET |
| Endpoint | 0/public/Spread |
| Auth required | No |
SpotRecentSpreadsResponse
Each spread entry is a tuple: [time, bid, ask]
getPreTradeData(params)
Returns the top 10 price levels in the order book with aggregated order quantities at each level, for a given trading pair. This is a public transparency endpoint with no authentication required.
Signature
Trading pair symbol to retrieve pre-trade data for (e.g.
"XBTUSD").| Property | Value |
|---|---|
| HTTP method | GET |
| Endpoint | 0/public/PreTrade |
| Auth required | No |
getPostTradeData(params?)
Returns a list of recent trades on the spot exchange. If no filter parameters are specified, the last 1000 trades for all pairs are returned. This is a public transparency endpoint with no authentication required.
Signature
Filter trades by trading pair symbol (e.g.
"XBTUSD").ISO 8601 timestamp — return trades on or after this time.
ISO 8601 timestamp — return trades on or before this time.
Maximum number of trades to return. Defaults to 1000.
| Property | Value |
|---|---|
| HTTP method | GET |
| Endpoint | 0/public/PostTrade |
| Auth required | No |