Skip to content

Indices · Statistics

Indices volatility regime

Ratios between the volatility indexes, contango or backwardation state and one-year percentile.
GET/v1/indices/volatility-regimeindicesVolatilityRegime
On this page

How the volatility indexes stand against one another: the 1-day, 9-day and VVIX levels as ratios of the 30-day volatility index, term_state (contango when the 9-day ratio is under 0.98, backwardation over 1.02, otherwise flat), percentile_1y (the share of the last 252 sessions on which the 30-day index closed at or below its current value, 0 to 100) and its change in percent on the session. A ratio whose indexes are not both available is null and its index is named in meta.coverage.missing. Ratios and states only; no index values are returned. The percentile uses the last 252 sessions whatever your plan's history window; the window limits the dated rows returned, and this route returns none.

Example request

curl -sS "https://api.ordermap.si/v1/indices/volatility-regime" \
  -H "Authorization: Bearer $ORDERMAP_API_KEY"

Set ORDERMAP_API_KEY to your key. Replace the dates with a recent trading date.

Parameters

This endpoint takes no parameters.

Response

StatusMeaningBody
200Successful response.Schema below
400Invalid, unknown or repeated parameters, or an invalid cursor.Error object
401Missing or invalid API key.Error object
403The plan, dataset release or account state does not allow this request.Error object
422The request is valid but no data exists for it.Error object
429Rate limit, burst limit or cooldown; wait Retry-After seconds.Retry-AfterError object
500Internal error.Error object
503Data temporarily unavailable; retry after Retry-After seconds.Retry-AfterError object
504The 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 volatility regime.7 fields inside
    • change_pct_1dnumber | nullrequiredChange of the 30-day index on the session, in percent.
    • percentile_1ynumber | nullrequiredPercentile rank of the 30-day index over the last 252 sessions, 0 to 100.
    • ratiosobjectrequiredVolatility indexes as ratios of the 30-day index.3 fields inside
      • nine_day_to_30dnumber | nullrequiredThe 9-day index over the 30-day index.
      • one_day_to_30dnumber | nullrequiredThe 1-day index over the 30-day index.
      • vol_of_vol_to_30dnumber | nullrequiredThe volatility-of-volatility index over the 30-day index.
    • term_statestring | nullrequiredShape of the short end of the volatility term structure.contangoflatbackwardationnull
  • metaobjectrequiredMeta object

Example response

{
  "data": {
    "change_pct_1d": 1.5,
    "percentile_1y": 50,
    "ratios": {
      "nine_day_to_30d": 0.97,
      "one_day_to_30d": 0.75,
      "vol_of_vol_to_30d": 4.5
    },
    "term_state": "contango"
  },
  "meta": {
    "as_of": 1760659200123,
    "coverage": {
      "complete": true
    },
    "delay_ms": 0,
    "delayed": false,
    "request_id": "0199f0c2-5a1e-7c3b-9d4e-2b6f8a1c3d5e",
    "source": "index_feed"
  }
}

Values are illustrative. Missing values are null, never 0.