Futures · Order book
Futures liquidity changes
/v1/futures/liquidity/changesfuturesLiquidityChangesFor each price within within_ticks of the mid at the end of the window, the displayed size at the start and the end, the size added and the size removed in between, and the net change, per side with totals per side. These are changes in displayed size, not cancellations or new orders: a size falls when orders trade or are cancelled and rises when orders are added, and the book is anonymous. A window is at most 15 minutes (413 range_too_large beyond), defaults to the last 5 minutes and reads the live capture, which holds the last 20 minutes: a window that starts earlier, or in which the book was not continuously synchronized, answers 422 data_unavailable.
Example request
curl -sS --get "https://api.ordermap.si/v1/futures/liquidity/changes" \
-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/liquidity/changes?${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. |
start_queryoptional | integerunix-msmin 946684800000max 4102444800000 | Start of the window (inclusive). |
end_queryoptional | integerunix-msmin 946684800000max 4102444800000 | End of the window (exclusive); at most 15 minutes after start_time. |
within_queryoptional | integerdefault 20min 1max 50 | Include prices within this many ticks of the mid at the end of the window. |
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
dataobjectrequiredChanges of displayed size over the window.34 fields insideask_totalsobjectrequiredTotals over the levels of one side.5 fields insideaddedintegerrequiredSum of increases.end_sizeintegerrequiredDisplayed size at the end.netintegerrequiredend_size minus start_size.removedintegerrequiredSum of decreases.start_sizeintegerrequiredDisplayed size at the start.
asksarray<object>requiredAsk prices, lowest first.7 fields insideaddedintegerrequiredSum of the increases of displayed size during the window.end_sizeintegerrequiredDisplayed size at the end of the window.netintegerrequiredend_size minus start_size, equal to added minus removed.pricenumberrequiredPrice.price_ticksstringrequiredPrice in ticks, as a string.removedintegerrequiredSum of the decreases of displayed size during the window.start_sizeintegerrequiredDisplayed size at the start of the window.
bid_totalsobjectrequiredTotals over the levels of one side.5 fields insideaddedintegerrequiredSum of increases.end_sizeintegerrequiredDisplayed size at the end.netintegerrequiredend_size minus start_size.removedintegerrequiredSum of decreases.start_sizeintegerrequiredDisplayed size at the start.
bidsarray<object>requiredBid prices, highest first.7 fields insideaddedintegerrequiredSum of the increases of displayed size during the window.end_sizeintegerrequiredDisplayed size at the end of the window.netintegerrequiredend_size minus start_size, equal to added minus removed.pricenumberrequiredPrice.price_ticksstringrequiredPrice in ticks, as a string.removedintegerrequiredSum of the decreases of displayed size during the window.start_sizeintegerrequiredDisplayed size at the start of the window.
contractstringrequiredDated contract.end_timeintegerunix-msrequiredEnd of the window. Unix epoch milliseconds (UTC).mid_pricenumberrequiredMidpoint of the best bid and ask at the end of the window.start_timeintegerunix-msrequiredStart of the window. Unix epoch milliseconds (UTC).symbolstringrequiredProduct root.within_ticksintegerrequiredBand around the mid, in ticks.
metaobjectrequiredMeta object
Example response
{
"data": {
"ask_totals": {
"added": 620,
"end_size": 1850,
"net": -134,
"removed": 754,
"start_size": 1984
},
"asks": [
{
"added": 40,
"end_size": 60,
"net": -36,
"price": 6021.5,
"price_ticks": "24086",
"removed": 76,
"start_size": 96
}
],
"bid_totals": {
"added": 910,
"end_size": 2390,
"net": 180,
"removed": 730,
"start_size": 2210
},
"bids": [
{
"added": 190,
"end_size": 140,
"net": 22,
"price": 6021.25,
"price_ticks": "24085",
"removed": 168,
"start_size": 118
}
],
"contract": "ESZ6",
"end_time": 1792159500000,
"mid_price": 6021.375,
"start_time": 1792159200000,
"symbol": "ES",
"within_ticks": 20
},
"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.
