Futures · Statistics
Futures imbalances
/v1/futures/imbalancesfuturesImbalancesZones found in the footprint of the window: a zone is a run of adjacent price rows of one bar that all carry a stacked buy imbalance (buy volume dominates by the footprint imbalance rule) or all a stacked sell imbalance. price_low and price_high are the lowest and highest rows of the zone, levels the rows in it and volume the contracts traded in them. A zone is tested once a later bar's traded range overlaps it; tested_time is the start of the first such bar. Zones are ordered by bar and price. The footprint parameters (bar_type, target, row_ticks and the imbalance settings) are those of /v1/futures/footprint; at most 2,000 bars and 10,000 rows are read.
Example request
curl -sS --get "https://api.ordermap.si/v1/futures/imbalances" \
-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/imbalances?${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
16 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. |
bar_queryoptional | stringtimetrade_countvolumerangedefault time | What closes a bar: time (target seconds), trade_count (target prints), volume (target contracts; a print is never split) or range (target ticks between the bar's high and low). |
targetqueryoptional | integermin 1max 86400 | Bar size: seconds for time bars, prints for trade_count, contracts for volume, ticks for range. Default 60 seconds, 500 prints, 1,000 contracts, 10 ticks. |
row_queryoptional | integerdefault 1min 1max 1000 | Group prices into rows of this many ticks. |
imbalance_queryoptional | stringhorizontaldiagonaldefault horizontal | How imbalances compare volumes: horizontal (buy against sell at the same price) or diagonal (buy against the sell one row below). |
imbalance_queryoptional | numberdefault 3min 1max 1000 | Ratio at which one side counts as an imbalance. |
imbalance_queryoptional | integerdefault 10min 0max 1000000000 | Smallest volume that can be an imbalance. |
stacked_queryoptional | integerdefault 3min 2max 100 | Consecutive imbalanced rows that make a stacked imbalance. |
value_queryoptional | numberdefault 70min 1max 100 | Share of the volume the value area contains, in percent. |
sidequeryoptional | stringbuysell | Only buy or only sell zones. |
untested_queryoptional | boolean | Only zones that no later bar has traded back into. |
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>required8 fields insidebar_timeintegerunix-msrequiredStart of the bar the zone is in. Unix epoch milliseconds (UTC).levelsintegerrequiredRows in the zone.price_highnumberrequiredHighest row of the zone.price_lownumberrequiredLowest row of the zone.sidestringrequiredbuy: buyers dominated the rows; sell: sellers did.buyselltestedbooleanrequiredA later bar traded back into the zone.tested_timeinteger | nullunix-msrequiredStart of the first later bar that did. Unix epoch milliseconds (UTC).volumeintegerrequiredContracts traded in the zone's rows.
metaobjectrequiredMeta object
Example response
{
"data": [
{
"bar_time": 1792159200000,
"levels": 3,
"price_high": 6021.5,
"price_low": 6021,
"side": "sell",
"tested": true,
"tested_time": 1792159320000,
"volume": 940
}
],
"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.
