Futures · Profiles and levels
Futures vwap
/v1/futures/vwapfuturesVwapThe volume-weighted average price of captured prints with bands at one, two and three volume-weighted standard deviations around it. anchor session (default) reads the whole current Globex session from the session profile (which can answer 503 data_pending; retry), rth the regular session (09:30 to 16:00 Eastern Time) and custom the window from start_time (required) to end_time (default now). Each price level counts with its traded volume. Values are null when the window holds no volume, and coverage.complete is then false. A window it no longer holds answers 422 data_unavailable.
Example request
curl -sS --get "https://api.ordermap.si/v1/futures/vwap" \
-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/vwap?${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. |
anchorqueryoptional | stringsessionrthcustomdefault session | Where the average starts: session (the current Globex session), rth (regular hours) or custom (start_time). |
start_queryoptional | integerunix-msmin 946684800000max 4102444800000 | Start of a custom window (inclusive); required with anchor=custom. |
end_queryoptional | integerunix-msmin 946684800000max 4102444800000 | End of a custom window (exclusive); default now. |
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
dataobjectrequiredA VWAP with deviation bands.13 fields insideanchorstringrequiredThe anchor used.sessionrthcustomcontractstringrequiredDated contract.end_timeinteger | nullunix-msrequiredEnd of the window (now while the session is open). Unix epoch milliseconds (UTC).lower_1number | nullrequiredvwap minus one standard deviation.lower_2number | nullrequiredvwap minus two standard deviations.lower_3number | nullrequiredvwap minus three standard deviations.start_timeinteger | nullunix-msrequiredStart of the window. Unix epoch milliseconds (UTC).std_devnumber | nullrequiredVolume-weighted standard deviation of price around the vwap.upper_1number | nullrequiredvwap plus one standard deviation.upper_2number | nullrequiredvwap plus two standard deviations.upper_3number | nullrequiredvwap plus three standard deviations.volumeinteger | nullrequiredContracts in the window.vwapnumber | nullrequiredVolume-weighted average price.
metaobjectrequiredMeta object
Example response
{
"data": {
"anchor": "session",
"contract": "ESZ6",
"end_time": 1792162800000,
"lower_1": 6011.11,
"lower_2": 6003.8,
"lower_3": 5996.49,
"start_time": 1792101600000,
"std_dev": 7.31,
"upper_1": 6025.73,
"upper_2": 6033.04,
"upper_3": 6040.35,
"volume": 412837,
"vwap": 6018.42
},
"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.
