Futures · Order flow
Futures trade sizes
/v1/futures/trade-sizesfuturesTradeSizesGroups the prints of a trading session into eight size classes by contracts per print (1, 2-4, 5-9, 10-24, 25-49, 50-99, 100-249, 250 and more) and reports, for each class, the number of prints, buy, sell and unknown volume, delta (buy minus sell) and its share of the total volume. The classes partition the volume: their volumes add up to total.volume. Reads the live capture; a window it no longer holds answers 422 data_unavailable, and a window with no retained prints answers 422 data_unavailable rather than zeros (the same as /v1/futures/cvd).
Example request
curl -sS --get "https://api.ordermap.si/v1/futures/trade-sizes" \
-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/trade-sizes?${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
6 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. |
sessionqueryoptional | stringrthglobexgthcurbcombineddefault rth | Trading session to read. rth is 09:30 to 16:00 Eastern Time; globex the full 18:00 to 17:00 session; gth the overnight window (20:15 to 09:25); curb 16:15 to 17:00; combined gth plus rth. Futures trade through the night, so every session is available on every plan. |
datequeryoptional | stringdate | Trading date (YYYY-MM-DD) of the session; default the current or most recent one. |
start_queryoptional | integerunix-msmin 946684800000max 4102444800000 | Narrow the session to start at or after this time. |
end_queryoptional | integerunix-msmin 946684800000max 4102444800000 | Narrow the session to end at or before this time. |
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 size distribution of one contract's prints.19 fields insidebucketsarray<object>requiredThe eight size classes, smallest first.9 fields insidebucketstringrequiredSize class in contracts per print: 1, 2-4, 5-9, 10-24, 25-49, 50-99, 100-249 or 250+.buy_volumeintegerrequiredContracts bought at the ask.deltaintegerrequiredbuy_volume minus sell_volume.max_sizeinteger | nullrequiredLargest print size in the class; null for the open-ended last class.min_sizeintegerrequiredSmallest print size in the class.sell_volumeintegerrequiredContracts sold at the bid.share_of_volumenumberrequiredVolume of the class divided by the total volume, from 0 to 1.tradesintegerrequiredPrints in the class.unknown_volumeintegerrequiredContracts whose aggressor could not be determined.
contractstringrequiredDated contract.symbolstringrequiredProduct root.totalobjectrequiredTotals over every class.6 fields insidebuy_volumeintegerrequiredContracts bought at the ask.deltaintegerrequiredbuy_volume minus sell_volume.sell_volumeintegerrequiredContracts sold at the bid.tradesintegerrequiredPrints.unknown_volumeintegerrequiredContracts with an unknown aggressor.volumeintegerrequiredContracts traded.
metaobjectrequiredMeta object
Example response
{
"data": {
"buckets": [
{
"bucket": "1",
"buy_volume": 2410,
"delta": -240,
"max_size": 1,
"min_size": 1,
"sell_volume": 2650,
"share_of_volume": 0.081,
"trades": 5120,
"unknown_volume": 60
},
{
"bucket": "250+",
"buy_volume": 900,
"delta": 900,
"max_size": null,
"min_size": 250,
"sell_volume": 0,
"share_of_volume": 0.014,
"trades": 3,
"unknown_volume": 0
}
],
"contract": "ESZ6",
"symbol": "ES",
"total": {
"buy_volume": 31840,
"delta": 720,
"sell_volume": 31120,
"trades": 41250,
"unknown_volume": 250,
"volume": 63210
}
},
"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.
