Futures · Order flow
Futures sweeps
/v1/futures/sweepsfuturesSweepsA sweep is a run of prints on the same side, each within window_ms of the previous one, whose price moves in one direction (up for buys, down for sells) across at least min_levels ticks, with a total size of at least min_size contracts. levels is the price span in ticks from the first to the last print. A print on the other side, with an unknown side, a longer pause or a price against the run ends it. Rows are in time order. A window that is held but holds no qualifying run answers 200 with an empty list. A window with more than 2,000 sweeps is refused with 413 range_too_large: narrow start_time and end_time or raise min_size. Reads the live capture; a window it no longer holds answers 422 data_unavailable.
Example request
curl -sS --get "https://api.ordermap.si/v1/futures/sweeps" \
-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/sweeps?${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
9 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. |
window_queryoptional | integerdefault 250min 50max 2000 | Longest pause between two prints of a sweep, in milliseconds. |
min_queryoptional | integerdefault 3min 2max 50 | Fewest ticks the price must move across. |
min_queryoptional | integerdefault 20min 1max 1000000 | Fewest contracts in total. |
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
dataarray<object>required10 fields insidecontractstringrequiredDated contract.end_pricenumberrequiredPrice of the last print.end_timeintegerunix-msrequiredTime of the last print. Unix epoch milliseconds (UTC).levelsintegerrequiredPrice span in ticks from the first to the last print.printsintegerrequiredPrints in the sweep.sidestringrequiredAggressor side of the sweep.buysellsizeintegerrequiredContracts traded in the sweep.start_pricenumberrequiredPrice of the first print.start_timeintegerunix-msrequiredTime of the first print. Unix epoch milliseconds (UTC).vwapnumberrequiredSize-weighted average price.
metaobjectrequiredMeta object
Example response
{
"data": [
{
"contract": "ESZ6",
"end_price": 6022,
"end_time": 1792159200213,
"levels": 3,
"prints": 4,
"side": "buy",
"size": 24,
"start_price": 6021.25,
"start_time": 1792159200123,
"vwap": 6021.625
}
],
"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.
