Indices · Values and bars
Indices bars
/v1/indices/barsindicesBarsOpen, high, low and close of an index value series per bar (indices carry no volume). start_time is inclusive and end_time exclusive on bar starts, ascending; end_time defaults to now and start_time to 7 days before it (a year for 1d, 1w and 1mo, or your plan's history depth when shorter). Only completed bars are returned and a bar exists only where the index printed. Intraday intervals are aligned to the clock; 1d, 1w and 1mo bars start at midnight Eastern Time. Page with cursor_id.
Example request
curl -sS --get "https://api.ordermap.si/v1/indices/bars" \
-H "Authorization: Bearer $ORDERMAP_API_KEY" \
--data-urlencode symbol=SPXconst params = new URLSearchParams({
symbol: "SPX",
});
const res = await fetch(`https://api.ordermap.si/v1/indices/bars?${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);
// Paginated: repeat with cursor_id set to pagination.next_cursor_id until it is null.Set ORDERMAP_API_KEY to your key. Replace the dates with a recent trading date.
Parameters
6 parameters, 1 required.
| Parameter | Type and limits | Description |
|---|---|---|
symbolqueryrequired | stringat most 10 characterspattern ^[A-Za-z][A-Za-z0-9]{0,9}$ | Index symbol, for example SPX. |
intervalqueryoptional | string1m2m3m5m10m15m30m1h1d1w1modefault 1d | Bar size. |
start_queryoptional | integerunix-msmin 946684800000max 4102444800000 | First bar start to return (inclusive). |
end_queryoptional | integerunix-msmin 946684800000max 4102444800000 | End of the range (exclusive). |
limitqueryoptional | integerdefault 1000min 1max 5000 | Maximum rows to return. |
cursor_queryoptional | stringat most 1024 characters | Opaque cursor returned as pagination.next_cursor_id; resumes the same query on the next page. |
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>required6 fields insideclosenumberrequiredClose.highnumberrequiredHigh.lownumberrequiredLow.opennumberrequiredOpen.start_timeintegerunix-msrequiredStart of the bar. Unix epoch milliseconds (UTC).symbolstringrequiredIndex symbol.
metaobjectrequiredMeta objectpaginationobjectrequiredPagination object
Example response
{
"data": [
{
"close": 5983.2,
"high": 5984.1,
"low": 5980.75,
"open": 5981.4,
"start_time": 1792157400000,
"symbol": "SPX"
}
],
"meta": {
"as_of": 1760659200123,
"coverage": {
"complete": true
},
"delay_ms": 0,
"delayed": false,
"request_id": "0199f0c2-5a1e-7c3b-9d4e-2b6f8a1c3d5e",
"source": "index_feed"
},
"pagination": {
"count": 1,
"has_more": false,
"limit": 1000,
"next_cursor_id": null,
"next_url": null
}
}Values are illustrative. Missing values are null, never 0.