Stocks · News and market map
Stocks market map
/v1/stocks/market-mapstocksMarketMapA treemap-ready snapshot of the configured large-cap universe (about a hundred of the largest US companies; the operator can change the list): each company's price, change against the previous close, volume, market capitalization, company name, approximate sector (from the SIC code) and industry text. value holds the metric you chose and rows are ordered by market capitalization. Prices refresh every 2 seconds; company details refresh daily. Share classes of one company appear once (meta.coverage.merged_share_classes counts those folded in). meta.coverage.complete is false when some companies are missing a price or detail.
Example request
curl -sS "https://api.ordermap.si/v1/stocks/market-map" \
-H "Authorization: Bearer $ORDERMAP_API_KEY"const res = await fetch("https://api.ordermap.si/v1/stocks/market-map", {
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
2 parameters, none required.
| Parameter | Type and limits | Description |
|---|---|---|
universequeryoptional | stringconfigureddefault configured | The company universe. configured is the platform's large-cap list. |
metricqueryoptional | stringchange_percentchangevolumedollar_volumemarket_capdefault change_percent | What value holds: change_percent (default), change, volume, dollar_volume or market_cap. |
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
dataobjectrequiredThe market map.14 fields insidemetricstringrequiredThe metric value holds.change_percentchangevolumedollar_volumemarket_caprowsarray<object>requiredCompanies, largest market capitalization first.12 fields insidechangenumber | nullrequiredPrice minus the previous close.change_percentnumber | nullrequiredChange as a percentage.dollar_volumenumber | nullrequiredShares traded times price.industrystring | nullrequiredIndustry text from the SIC code.market_capnumber | nullrequiredMarket capitalization in dollars.namestring | nullrequiredCompany name.previous_closenumber | nullrequiredPrevious close.pricenumber | nullrequiredLatest price.sectorstring | nullrequiredApproximate market sector.symbolstringrequiredTicker symbol.valuenumber | nullrequiredThe chosen metric.volumenumber | nullrequiredShares traded today.
metaobjectrequiredMeta object
Example response
{
"data": {
"metric": "change_percent",
"rows": [
{
"change": 5.42,
"change_percent": 2.4,
"dollar_volume": 9540000000,
"industry": "ELECTRONIC COMPUTERS",
"market_cap": 3450000000000,
"name": "Apple Inc.",
"previous_close": 226,
"price": 231.42,
"sector": "Information Technology",
"symbol": "AAPL",
"value": 2.4,
"volume": 41230000
}
]
},
"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.