v1

latestOpenAPI 3.0.32026-07-267278168.1 KB

Market Data

Get Order Book Depth

Returns the current order book depth snapshot for a market.

get/v1/perps/depth

Query parameters

marketstring required

Example:AAPL-USD.P

Trading market to query

depthinteger

Example:10

Number of price levels to return per side. Defaults to 10. Maximum 100.

Response

Order book snapshot

successboolean required

Whether the request was successful

errorstring

Error message, present only on failure

error_codestring

Semantic error code. See each endpoint's error responses for the specific codes it can return.

deprecatedstring

Deprecation notice, if applicable

Example response

{
  "success": true,
  "result": {
    "market": "AAPL-USD.P",
    "time": "2022-06-16T12:35:11.123456Z",
    "bids": [
      [
        "1.55",
        "100.0"
      ]
    ],
    "asks": [
      [
        "1.55",
        "100.0"
      ]
    ]
  }
}