Futures · Order book
Futures book walls
/v1/futures/book/wallsfuturesBookWallsThe displayed levels within within_ticks of the midpoint whose size is at least min_ratio times the median size of the displayed levels in that range (both sides together), the largest ratio first, at most top per side. This is displayed size only and makes no claim about intent: displayed size can be cancelled, and nothing is inferred about hidden orders. Values are null and the lists empty when the book is not synchronized or has levels on one side only; coverage.complete is then false.
Example request
curl -sS --get "https://api.ordermap.si/v1/futures/book/walls" \
-H "Authorization: Bearer $ORDERMAP_API_KEY" \
--data-urlencode symbol=ESconst params = new URLSearchParams({
symbol: "ES",
});
const res = await fetch(`https://api.ordermap.si/v1/futures/book/walls?${params}`, {
headers: { Authorization: `Bearer ${process.env.ORDERMAP_API_KEY}` },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data, meta } = await res.json();
console.log(data, meta.coverage);Set ORDERMAP_API_KEY to your key. Replace the dates with a recent trading date.
Parameters
5 parameters, none required.
| Parameter | Type and limits | Description |
|---|---|---|
symbolqueryoptional | stringat most 3 characterspattern ^[A-Za-z0-9]{1,3}$ | Futures product root, for example ES, NQ, CL or GC. Without contract the current front month is used and returned in the response. |
contractqueryoptional | stringat most 6 characterspattern ^[A-Za-z0-9]{1,3}[FGHJKMNQUVXZfghjkmnquvxz][0-9]{1,2}$ | Exact dated contract: root, month code and year, for example ESZ6 (December 2026). Two-digit years are accepted and returned in the one-digit form (ESZ26 is ESZ6). Only the front month and the contracts listed by /v1/futures/contracts are served. |
within_queryoptional | integerdefault 100min 1max 500 | Only levels within this many ticks of the midpoint. |
min_queryoptional | numberdefault 4min 1max 1000 | Smallest size, as a multiple of the median displayed level, that counts as a wall. |
topqueryoptional | integerdefault 5min 1max 20 | Most walls to return on each side. |
Response
| Status | Meaning | Body |
|---|---|---|
200 | Successful response. | Schema below |
400 | Invalid, unknown or repeated parameters, or an invalid cursor. | Error object |
401 | Missing or invalid API key. | Error object |
403 | The plan, dataset release or account state does not allow this request. | Error object |
422 | The request is valid but no data exists for it. | Error object |
429 | Rate limit, burst limit or cooldown; wait Retry-After seconds.Retry-After | Error object |
500 | Internal error. | Error object |
503 | Data temporarily unavailable; retry after Retry-After seconds.Retry-After | Error object |
504 | The request timed out. | Error object |
Authenticated responses carry the X-RateLimit-* headers (see rate limits); 429 and 503 add Retry-After.
200 response body
dataobjectrequiredWalls of the displayed book.17 fields insideasksarray<object>requiredAsk walls, largest ratio first.5 fields insideordersintegerrequiredDisplayed orders.pricenumberrequiredPrice of the level.rationumberrequiredsize divided by median_level_size.sizeintegerrequiredDisplayed contracts.ticks_from_midnumberrequiredDistance from the midpoint, in ticks.
bidsarray<object>requiredBid walls, largest ratio first.5 fields insideordersintegerrequiredDisplayed orders.pricenumberrequiredPrice of the level.rationumberrequiredsize divided by median_level_size.sizeintegerrequiredDisplayed contracts.ticks_from_midnumberrequiredDistance from the midpoint, in ticks.
contractstringrequiredDated contract.median_level_sizenumber | nullrequiredMedian displayed size of the levels within range.midnumber | nullrequiredMidpoint of the best bid and ask.timestampinteger | nullunix-msrequiredTime of the book. Unix epoch milliseconds (UTC).validbooleanrequiredThe book is synchronized.
metaobjectrequiredMeta object
Example response
{
"data": {
"asks": [],
"bids": [
{
"orders": 20,
"price": 6019,
"ratio": 6.41,
"size": 500,
"ticks_from_mid": 9.5
}
],
"contract": "ESZ6",
"median_level_size": 78,
"mid": 6021.375,
"timestamp": 1792159200123,
"valid": true
},
"meta": {
"as_of": 1760659200123,
"coverage": {
"complete": true
},
"delay_ms": 0,
"delayed": false,
"request_id": "0199f0c2-5a1e-7c3b-9d4e-2b6f8a1c3d5e",
"source": "cme"
}
}Values are illustrative. Missing values are null, never 0.
