Skip to main content
POST
/
api
/
v1
/
options
/
overview
Live options overview for one symbol.
finterm tool options_overview TSLA
{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "data": {
    "ticker": "<string>",
    "as_of_date": "<string>",
    "spot": 123,
    "context": {
      "next_earnings": {
        "date": "<string>",
        "days": 123,
        "confirmed": true
      }
    },
    "volatility": {
      "iv_30": 123,
      "hv_20": 123,
      "iv_vs_hv": 123,
      "skew": 123,
      "iv_rank": 123,
      "iv_percentile": 123,
      "iv_1y_low": {
        "value": 123,
        "date": "<string>"
      },
      "iv_1y_high": {
        "value": 123,
        "date": "<string>"
      },
      "hv_rank": 123
    },
    "flow": {
      "volume": 123,
      "puts": 123,
      "calls": 123,
      "pc_ratio": 123,
      "vs_avg_30d": 123,
      "pc_5d_avg": 123,
      "pc_percentile_1y": 123
    },
    "positioning": {
      "open_interest": 123,
      "puts": 123,
      "calls": 123,
      "pc_ratio": 123,
      "vs_avg_30d": 123,
      "max_pain": {
        "strike": 123,
        "expiry": "<string>",
        "spot_vs": 123
      },
      "top_strikes": {
        "calls": [
          [
            123
          ]
        ],
        "puts": [
          [
            123
          ]
        ]
      }
    },
    "expected_move": [
      {
        "expiry": "<string>",
        "days": 123,
        "pct": 123,
        "dollars": 123,
        "post_earnings": true
      }
    ],
    "probability": {
      "expiry": "<string>",
      "method": "lognormal_iv30",
      "bands": {
        "p10": 123,
        "p25": 123,
        "p50": 123,
        "p75": 123,
        "p90": 123
      }
    },
    "derived": [
      "<string>"
    ],
    "flags": [
      "<string>"
    ],
    "scope": {
      "contracts_analyzed": 123,
      "expirations_covered": 123,
      "pages_fetched": 123
    },
    "data_quality": {
      "history": {
        "days_collected": 123
      },
      "note": "<string>"
    },
    "methodology": {
      "version": "<string>",
      "iv_30": "<string>",
      "hv_20": "<string>",
      "skew": "<string>",
      "expected_move": "<string>",
      "probability_bands": "<string>",
      "max_pain": "<string>",
      "flag_thresholds": "<string>"
    }
  }
}

Authorizations

Authorization
string
header
required

A live account API key from FINTERM_API_KEY.

Body

application/json
ticker
string
required

Stock ticker symbol

as_of_date
string

As-of date: 'today' or YYYY-MM-DD

Response

Success.

The two-key success envelope.

finterm
object
required

Canonical result meta header.

data
object
required