Futures · Order book
Futures book impact
/v1/futures/book/impactfuturesBookImpactWalks the displayed book with market orders of each requested size (default 10, 50, 100 and 500 contracts): a buy consumes the asks from the best price up, a sell the bids from the best price down. For each it reports the contracts that could be filled, the levels consumed, the volume-weighted average price, the worst price touched, the slippage |average - best price| in ticks and whether the whole size could be filled from the displayed depth. It is an estimate from displayed size at one instant: displayed size can change before an order arrives, and no hidden liquidity is assumed. Fields are null when the book is not synchronized or the side to trade against is empty.
Example request
curl -sS --get "https://api.ordermap.si/v1/futures/book/impact" \
-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/impact?${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
4 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. |
sizesqueryoptional | array<integer>comma-separated in one parameter1 to 6 items | Order sizes in contracts; at most 6 values from 1 to 100000. Default 10,50,100,500. |
sidequeryoptional | stringbuysellbothdefault both | Direction of the market orders: buy, sell or both. |
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
dataobjectrequiredThe estimated fills of market orders.13 fields insidecontractstringrequiredDated contract.midnumber | nullrequiredMidpoint of the best bid and ask.resultsarray<object>requiredOne entry per size and side, smallest size first.8 fields insideaverage_pricenumber | nullrequiredVolume-weighted fill price.completeboolean | nullrequiredThe whole size could be filled from the displayed depth.filledinteger | nullrequiredContracts the displayed depth could fill.levels_consumedinteger | nullrequiredPrice levels the order reaches.sidestringrequiredbuy trades against the asks, sell against the bids.buysellsizeintegerrequiredOrder size, in contracts.slippage_ticksnumber | nullrequired|average price - best price| in ticks.worst_pricenumber | nullrequiredPrice of the last level touched.
timestampinteger | nullunix-msrequiredTime of the book. Unix epoch milliseconds (UTC).validbooleanrequiredThe book is synchronized.
metaobjectrequiredMeta object
Example response
{
"data": {
"contract": "ESZ6",
"mid": 6021.375,
"results": [
{
"average_price": 6021.51,
"complete": true,
"filled": 100,
"levels_consumed": 2,
"side": "buy",
"size": 100,
"slippage_ticks": 0.04,
"worst_price": 6021.75
}
],
"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.
