Order book depth

GET/api/v1/markets/{marketId}/bookPublic

Trading APIprice E4 · size E2 · amount E6 (integers)YES | NO

Bid and ask levels quoted in YES (priceE4/sizeE2). depth defaults to 10 and is clamped to 100 server-side. minCursor is supported.

Path parameters

marketIdstringpathrequired
Engine market id (read endpoints do not accept a slug unless that endpoint says otherwise)
Example"mkt-0001"

Query parameters

depthintegerqueryoptional
Number of levels returned
Default10Range≥ 1Example10
minCursorstringqueryoptional
Read-your-writes continuation point (pass the cursor from the 202 place-order response verbatim). While the projection has not caught up this query returns 404, indistinguishable from "the resource does not exist" — poll with the same cursor.
Example"c1:mkt-0001:184"

Response

200Order book snapshot

marketstring
Market id
Example"mkt-0001"
yesBidsobject(DepthLevel)[]
YES bid levels, best price first
priceE4integer
Price level (1e-4 USD)
Example5200
sizeE2int64
Resting size at that level (1e-2 shares)
Example1000
yesAsksobject(DepthLevel)[]
YES ask levels
priceE4integer
Price level (1e-4 USD)
Example5200
sizeE2int64
Resting size at that level (1e-2 shares)
Example1000

Switch status codes in the response example to view errors. For all codes, see the Errors page.

Request

curl -X GET "$BASE_URL/api/v1/markets/mkt-0001/book?depth=10"

Response

Order book snapshot

{
  "market": "mkt-0001",
  "yesBids": [
    {
      "priceE4": 5200,
      "sizeE2": 1000
    }
  ],
  "yesAsks": [
    {
      "priceE4": 5200,
      "sizeE2": 1000
    }
  ]
}

Path parameters

marketIdstringpathrequired
Engine market id (read endpoints do not accept a slug unless that endpoint says otherwise)
Example"mkt-0001"

Query parameters

depthintegerqueryoptional
Number of levels returned
Default10Range≥ 1Example10
minCursorstringqueryoptional
Read-your-writes continuation point (pass the cursor from the 202 place-order response verbatim). While the projection has not caught up this query returns 404, indistinguishable from "the resource does not exist" — poll with the same cursor.
Example"c1:mkt-0001:184"

Response

200Order book snapshot

marketstring
Market id
Example"mkt-0001"
yesBidsobject(DepthLevel)[]
YES bid levels, best price first
priceE4integer
Price level (1e-4 USD)
Example5200
sizeE2int64
Resting size at that level (1e-2 shares)
Example1000
yesAsksobject(DepthLevel)[]
YES ask levels
priceE4integer
Price level (1e-4 USD)
Example5200
sizeE2int64
Resting size at that level (1e-2 shares)
Example1000

Switch status codes in the response example to view errors. For all codes, see the Errors page.