Stocks · Dark pool, large prints and captured events
Stocks dark pool zones
/v1/stocks/dark-pool/zonesstocksDarkPoolZonesThe price zones where the most off-exchange dollar value printed over the last sessions: the platform's off-exchange price levels (the 200 largest by notional, rounded to the cent) with neighbouring levels merged into one zone while each is within zone_pct percent of the previous. Zones are ranked by notional; share_of_notional is the zone's part of the notional of all 200 levels read; last_date is the exchange date of the zone's latest print. The sessions the window covered are listed in meta.coverage.sessions. Odd-lot, contingent, official and corrected prints are excluded. The window reaches back no further than your plan's history. Served from the platform's capture of equity prints: the tickers it captures are the always-on liquid ETFs plus tickers requested on demand (up to eight at a time, each for five minutes after the last request), so a symbol seen for the first time returns data only from the moment capture began; meta.coverage.captured_since says when. Use /v1/stocks/dark-pool/trades for the full tape of any symbol.
Example request
curl -sS --get "https://api.ordermap.si/v1/stocks/dark-pool/zones" \
-H "Authorization: Bearer $ORDERMAP_API_KEY" \
--data-urlencode symbol=AAPLconst params = new URLSearchParams({
symbol: "AAPL",
});
const res = await fetch(`https://api.ordermap.si/v1/stocks/dark-pool/zones?${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, 1 required.
| Parameter | Type and limits | Description |
|---|---|---|
symbolqueryrequired | stringat most 11 characterspattern ^[A-Za-z]{1,6}(\.[A-Za-z0-9]{1,4})?$ | Ticker symbol, for example SPY. |
sessionsqueryoptional | integerdefault 5min 2max 20 | Number of trading sessions the window reaches back, 2 to 20. |
zone_queryoptional | numberdefault 0.1min 0.05max 1 | Levels within this percentage of the previous level merge into one zone, 0.05 to 1. |
topqueryoptional | integerdefault 20min 1max 50 | Number of zones to return, ranked by notional. |
min_queryoptional | numbermin 0max 1000000000000000 | Only levels with at least this dollar value take part. |
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 insidelast_datestringdaterequiredExchange date of the latest print in the zone.notionalnumberrequiredDollar value printed in the zone.price_highnumberrequiredHighest level of the zone, in dollars.price_lownumberrequiredLowest level of the zone, in dollars.share_of_notionalnumberrequiredThe zone's fraction of the notional of the levels read (0 to 1).sharesnumberrequiredShares printed in the zone.tradesintegerrequiredPrints in the zone.
metaobjectrequiredMeta object
Example response
{
"data": [
{
"last_date": "2026-10-15",
"notional": 700000000,
"price_high": 600.6,
"price_low": 600,
"share_of_notional": 0.875,
"shares": 1165000,
"trades": 160
}
],
"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.
