Stocks · Dark pool, large prints and captured events
Stocks imbalances leaders
/v1/stocks/imbalances/leadersstocksImbalancesLeadersThe latest captured imbalance of each symbol for the next opening or closing auction, ranked by its dollar value (shares times the indicative auction price, null when none was published, which ranks last) and then by shares. side keeps buy or sell imbalances; by default both are ranked. An auction that has already been held is not listed, and halt-resumption auctions are not included. At most 15,000 captured events are read, newest first; when more remained, meta.coverage.truncated is true and meta.coverage.complete is false: the ranking is then partial, and symbols beyond the bound can be missing from it. Captured from the live stream from the moment it was enabled and kept for seven days: meta.coverage.captured_from is the oldest event available, and events from before it, or from while the stream was down, do not exist here.
Example request
curl -sS "https://api.ordermap.si/v1/stocks/imbalances/leaders" \
-H "Authorization: Bearer $ORDERMAP_API_KEY"const res = await fetch("https://api.ordermap.si/v1/stocks/imbalances/leaders", {
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
3 parameters, none required.
| Parameter | Type and limits | Description |
|---|---|---|
auctionqueryoptional | stringopenclosedefault close | open for the opening auction or close for the closing auction. |
sidequeryoptional | stringbuysell | buy or sell imbalances only. Defaults to both. |
topqueryoptional | integerdefault 20min 1max 50 | Number of symbols to return. |
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>required7 fields insideauction_clock_etstring | nullrequiredScheduled auction time as the exchange publishes it: HH:MM, Eastern Time.imbalance_notionalnumber | nullrequiredImbalance shares times the indicative price, in dollars.imbalance_sharesintegerrequiredSize of the imbalance in shares.paired_sharesinteger | nullrequiredShares matched at the indicative price.sidestringrequiredSide of the imbalance.buysellsymbolstringrequiredTicker.timestampintegerunix-msrequiredTime of the update. Unix epoch milliseconds (UTC).
metaobjectrequiredMeta object
Example response
{
"data": [
{
"auction_clock_et": "16:00",
"imbalance_notional": 111000000,
"imbalance_shares": 480000,
"paired_shares": 1240000,
"side": "buy",
"symbol": "JPM",
"timestamp": 1792180800000
}
],
"meta": {
"as_of": 1760659200123,
"coverage": {
"complete": true
},
"delay_ms": 0,
"delayed": false,
"request_id": "0199f0c2-5a1e-7c3b-9d4e-2b6f8a1c3d5e",
"source": "sip"
}
}Values are illustrative. Missing values are null, never 0.
