Full IV surface — strikes × expiries with per-cell IV.

2-D IV surface bounded to ATM ± `band` (default ±40%) so the grid stays legible. Each cell carries call IV, put IV, and their average.

Path parameters

Segments of the URL path, validated server-side.

Query parameters

All query parameters are optional unless marked required.

Response shape

Always wrapped in the standard envelope. Nullable fields are explicitly marked — treat missing numeric data as a real data-source gap, not as an error.

// Wrapped in the standard envelope:
// {
//   data: /* shape below */,
//   meta?: { total?: number; limit?: number; offset?: number; ... }
// }

{ underlying, band, strikes, expiries, cells, minIv, maxIv, underlyingPrice }

Example

Copy the curl, replace YOUR_KEY with a real key from your dashboard, and run.

curl -sS "http://localhost:3000/api/v1/options/BTC/iv/surface"

{ "data": { "underlying": "BTC", "band": 0.4, "strikes": [], "expiries": [], "cells": [] }, "meta": { "total": 0 } }