Market Data

Get Order Book

Returns level 2 (L2) order book, which describes the individual price levels in the book with aggregated order quantities at each level.

get/public/Depth

Request

  • Base URL: https://api.kraken.com/0
  • URL: https://api.kraken.com/0/public/Depth
  • Auth: none required

Query parameters

pairstring required

Asset pair to get data for

assetVersion1

Controls whether response keys and asset identifier fields use Kraken's internal names or display names.

  • Omitted (default): internal names are used. Asset keys use legacy X/Z-prefixed format (XXBT, ZUSD). Pair keys use the internal format (XXBTZUSD). Asset identifier fields (base, quote, fee_volume_currency) also use internal names.
  • assetVersion=1: display names are used. Asset keys become their canonical display names (BTC, USD). Pair keys become the slash-separated display format (BTC/USD). On /public/AssetPairs, the base, quote, and fee_volume_currency fields also switch to display names.

Only assetVersion=1 is currently supported. The altname and wsname fields are not affected by this parameter.

countinteger

Maximum number of asks/bids

asset_class'tokenized_asset'

This parameter is required on requests for non-crypto pairs, i.e. use tokenized_asset for xStocks.

Response

Order book entries retrieved.

resultobject
errorstring[]

Example response

{
  "error": [
    "EGeneral:Invalid arguments"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.