Skip to content

WebSockets · Options

Options volatility stream

Implied volatility summary.
WS/v1/ws/options/volatilitywsOptionsVolatility
On this page

The at-the-money implied volatility of the nearest expiration at least one day out, the constant-maturity volatility at 7, 30 and 90 days, the 25-delta risk reversal and butterfly of the expiration nearest 30 days, the term slope (the 30-day volatility minus the 7-day) and the one-day expected move in percent (iv_30d divided by the square root of 252). Volatilities are decimals; a missing figure is null. The volatility is checked at most once every 5 seconds per root and an event is sent when any figure changed; the first event after subscribing is the current state (it can take up to 5 seconds). Subscribe by option root or family. At most 25 distinct option roots are served at once across all connections (an operator setting); a subscription to one more is answered with a status event, state unavailable and reason capacity, until a slot frees.

Connect and subscribe

Open wss://api.ordermap.si/v1/ws/options/volatility?symbols=SPXW with your key in the Authorization header and your saved installation ID in X-OrderMap-Device-ID, then send a subscribe message. Up to 25 symbols per connection. Streams need API Pro. All keys and projects share one active device per account and one connection per event type. Reuse the same installation ID for every stream and reconnect. Browser subprotocols, limits and close codes are in WebSockets.

Node.js

import WebSocket from "ws";

// Create a UUID once per installation, save it, and reuse it for every stream.
const deviceId = process.env.ORDERMAP_DEVICE_ID;
if (!deviceId) throw new Error("Set ORDERMAP_DEVICE_ID to this installation's saved UUID.");

const ws = new WebSocket("wss://api.ordermap.si/v1/ws/options/volatility?symbols=SPXW", {
  headers: {
    Authorization: `Bearer ${process.env.ORDERMAP_API_KEY}`,
    "X-OrderMap-Device-ID": deviceId,
  },
});

ws.on("open", () => ws.send(JSON.stringify({ action: "subscribe", symbols: ["SPXW"] })));
ws.on("message", (raw) => {
  const message = JSON.parse(raw.toString());
  if (message.type === "event") console.log(message.seq, message.data);
  if (message.type === "gap") console.warn("continuity lost: refetch the range over REST", message);
});
ws.on("close", (code, reason) => console.log("closed", code, reason.toString()));

Subscribe message

{"action":"subscribe","symbols":["SPXW"]}

Upgrade headers

A persistent installation ID is required. Supply the header below, or offer it as an ordermap.device.<id> browser subprotocol with ordermap.v1. Reuse the same saved ID for every event type, key, project and reconnect. Headers are not subscription filters.

ParameterType and limitsDescription
X-OrderMap-Device-IDheaderoptionalstringat least 16 charactersat most 128 characterspattern ^[A-Za-z0-9_-]{16,128}$Required unless supplied as an ordermap.device.<id> subprotocol together with ordermap.v1. Generate one random identifier per client installation and persist it across event types, keys, projects and reconnects. Never send it in the URL.

Subscription parameters

1 parameter, none required. Send them in the query string of the upgrade request, or as the filters of a subscribe message.

ParameterType and limitsDescription
symbolsqueryoptionalarray<string>comma-separated in one parameter1 to 25 itemseach at most 128 characterspattern ^[A-Za-z][A-Za-z0-9.]{0,9}$Symbols to subscribe to (up to 25).

Event

Each event is one message: {"type":"event","event_type":"options.volatility","seq":N,"data":{...}}.

data of options.volatility

  • atm_ivnumber | nullrequiredAt-the-money implied volatility of the nearest expiration at least one day out, as a decimal.
  • bf25number | nullrequired25-delta butterfly of the expiration nearest 30 days.
  • expected_move_1d_pctnumber | nullrequiredOne-day expected move in percent: iv_30d divided by the square root of 252.
  • iv_30dnumber | nullrequiredConstant-maturity implied volatility at 30 days.
  • iv_7dnumber | nullrequiredConstant-maturity implied volatility at 7 days.
  • iv_90dnumber | nullrequiredConstant-maturity implied volatility at 90 days.
  • rr25number | nullrequired25-delta risk reversal (call volatility minus put volatility) of the expiration nearest 30 days.
  • symbolstringrequiredThe root or family subscribed to.
  • term_slopenumber | nullrequiredThe 30-day volatility minus the 7-day volatility.
  • timestampintegerunix-msrequiredTime of the valuation. Unix epoch milliseconds (UTC).

Example event

{
  "type": "event",
  "event_type": "options.volatility",
  "seq": 1,
  "data": {
    "atm_iv": 0.152,
    "bf25": 0.009,
    "expected_move_1d_pct": 1.077,
    "iv_30d": 0.171,
    "iv_7d": 0.158,
    "iv_90d": 0.186,
    "rr25": -0.031,
    "symbol": "SPX",
    "term_slope": 0.013,
    "timestamp": 1792161060000
  }
}

Before the upgrade

Errors before the upgrade are ordinary JSON errors; after it, problems arrive as messages and close codes (see WebSockets).

StatusMeaningBody
101Switching protocols: WebSocket protocol ordermap.v1.Switching protocols
400Invalid handshake parameters or missing, malformed or conflicting persistent device identifier.Error object
401Missing or invalid API key (Authorization, X-API-Key or, from a browser, the ordermap.key. subprotocol).Error object
403The plan has no streaming (streaming_not_in_plan), the dataset is not released, or the account is suspended.Error object
409stream_connection_limit: the account is already connected on another device, or already has this event type open on the active device. The existing connection is preserved.Retry-AfterError object
426The request is not a WebSocket upgrade.Error object
429Rate limit or WebSocket cooldown.Retry-AfterError object
503stream_unavailable: the stream is not enabled or its source is down; retry after Retry-After seconds.Retry-AfterError object

Authenticated responses carry the X-RateLimit-* headers (see rate limits); 429 and 503 add Retry-After.