Market · Status, sessions and calendar

Market overview

One-call picture of the market: indexes, futures, volatility and breadth.

GET/v1/market/overviewmarketOverview

API Developer Streamable MCP tool: market_overview Dataset: equities

On this page

Example request
Parameters
Response
Example response
Related

The S&P 500, Nasdaq-100, Dow Jones Industrial Average and Russell 2000 with their change on the session, the VIX volatility index, the front contracts of the E-mini and micro equity index futures (ES, NQ, YM, RTY) and market breadth: advancing, declining and unchanged stocks with their volume for the latest completed session against the one before. Each part is bounded and cached for 2 seconds; a part that cannot be served is omitted and named in meta.coverage.missing. The index and futures parts are returned only to keys whose data releases include indices and futures; otherwise they are empty and named in meta.coverage.missing.

Example request

curl -sS "https://api.ordermap.si/v1/market/overview" \
  -H "Authorization: Bearer $ORDERMAP_API_KEY"

const res = await fetch("https://api.ordermap.si/v1/market/overview", {
  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

This endpoint takes no parameters.

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 overview.31 fields inside
- breadthobject | nullrequiredMarket breadth of the latest completed session.9 fields inside
  - advance_decline_rationumber | nullrequiredAdvancers divided by decliners.
  - advancersintegerrequiredStocks that closed higher.
  - advancing_volumenumberrequiredShares traded in advancing stocks.
  - datestringdaterequiredSession date.
  - declinersintegerrequiredStocks that closed lower.
  - declining_volumenumberrequiredShares traded in declining stocks.
  - totalintegerrequiredStocks compared.
  - total_volumenumberrequiredShares traded in all compared stocks.
  - unchangedintegerrequiredStocks that closed unchanged.
- futuresarray<object>requiredFront contracts of the equity index futures.6 fields inside
  - changenumber | nullrequiredChange against the previous session close, in points.
  - change_percentnumber | nullrequiredChange as a percentage.
  - contractstring | nullrequiredFront contract, for example ESZ6.
  - pricenumber | nullrequiredLatest price.
  - symbolstringrequiredProduct root.
  - timestampinteger | nullunix-msrequiredTime of the price. Unix epoch milliseconds (UTC).
- indicesarray<object>requiredMajor index values.6 fields inside
  - changenumber | nullrequiredChange against the previous close, in index points.
  - change_percentnumber | nullrequiredChange as a percentage.
  - namestringrequiredIndex name.
  - symbolstringrequiredIndex symbol.
  - timestampinteger | nullunix-msrequiredTime of the value. Unix epoch milliseconds (UTC).
  - valuenumber | nullrequiredLatest value.
- volatilityobject | nullrequiredThe VIX volatility index.6 fields inside
  - changenumber | nullrequiredChange against the previous close, in index points.
  - change_percentnumber | nullrequiredChange as a percentage.
  - namestringrequiredIndex name.
  - symbolstringrequiredIndex symbol.
  - timestampinteger | nullunix-msrequiredTime of the value. Unix epoch milliseconds (UTC).
  - valuenumber | nullrequiredLatest value.
metaobjectrequiredMeta object

Example response

{
  "data": {
    "breadth": {
      "advance_decline_ratio": 1.74,
      "advancers": 3120,
      "advancing_volume": 3100000000,
      "date": "2026-10-15",
      "decliners": 1790,
      "declining_volume": 1400000000,
      "total": 5120,
      "total_volume": 4700000000,
      "unchanged": 210
    },
    "futures": [
      {
        "change": 10.25,
        "change_percent": 0.17,
        "contract": "ESZ6",
        "price": 6021.5,
        "symbol": "ES",
        "timestamp": 1792159199000
      }
    ],
    "indices": [
      {
        "change": 21.3,
        "change_percent": 0.35,
        "name": "S&P 500",
        "symbol": "SPX",
        "timestamp": 1792159200000,
        "value": 6021.4
      }
    ],
    "volatility": {
      "change": 1,
      "change_percent": 6.45,
      "name": "Cboe Volatility Index",
      "symbol": "VIX",
      "timestamp": 1792159200000,
      "value": 16.5
    }
  },
  "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.

Example request

Parameters

Response

200 response body

Example response

Related