OptionWhales Volatility API
The volatility API from OptionWhales — 10 operation(s) for volatility.
The volatility API from OptionWhales — 10 operation(s) for volatility.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/optionwhales-io:optionwhales-io-volatility-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: OptionWhales Pro Volatility API
description: Premium API for intent flow, momentum, abnormal trades, earnings intelligence, economic events, directional scores, GEX, dark pool, implied-volatility analytics, open interest, and an MCP server for AI agents
version: 1.2.0
tags:
- name: volatility
paths:
/v1/volatility/atm:
get:
tags:
- volatility
summary: Volatility Atm Batch
description: 'Batch ATM implied vol at ~``target_dte`` days for many tickers (Pro+).
Tickers absent from the vol-intel index are simply omitted from ``results``.'
operationId: volatility_atm_batch_v1_volatility_atm_get
parameters:
- name: symbols
in: query
required: true
schema:
type: string
description: Comma-separated tickers, e.g. SPY,QQQ,NVDA
title: Symbols
description: Comma-separated tickers, e.g. SPY,QQQ,NVDA
- name: target_dte
in: query
required: false
schema:
type: number
maximum: 365.0
minimum: 1.0
default: 30.0
title: Target Dte
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/volatility/movers:
get:
tags:
- volatility
summary: Volatility Movers
description: Top ATM-IV(30d) movers vs prior-session close (Pro+).
operationId: volatility_movers_v1_volatility_movers_get
parameters:
- name: direction
in: query
required: false
schema:
type: string
pattern: ^(both|expansions|compressions)$
default: both
title: Direction
- name: limit
in: query
required: false
schema:
type: integer
maximum: 50
minimum: 1
default: 10
title: Limit
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/volatility/{ticker}/surface:
get:
tags:
- volatility
summary: Volatility Surface
description: 'Full implied-vol surface — ``iv[][]`` over moneyness × DTE, with the
aligned strike/delta/oi/volume matrices and ATM stats (Pro+).'
operationId: volatility_surface_v1_volatility__ticker__surface_get
parameters:
- name: ticker
in: path
required: true
schema:
type: string
title: Ticker
- name: dte_min
in: query
required: false
schema:
type: integer
maximum: 730
minimum: 0
default: 3
title: Dte Min
- name: dte_max
in: query
required: false
schema:
type: integer
maximum: 730
minimum: 1
default: 400
title: Dte Max
- name: mode
in: query
required: false
schema:
type: string
pattern: ^(mid|call|put)$
default: mid
title: Mode
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/volatility/{ticker}/term-structure:
get:
tags:
- volatility
summary: Volatility Term Structure
description: 'ATM-IV term structure — ATM implied vol per expiry/DTE plus the mean
ATM-IV, extracted from the surface (Pro+).'
operationId: volatility_term_structure_v1_volatility__ticker__term_structure_get
parameters:
- name: ticker
in: path
required: true
schema:
type: string
title: Ticker
- name: dte_min
in: query
required: false
schema:
type: integer
maximum: 730
minimum: 0
default: 3
title: Dte Min
- name: dte_max
in: query
required: false
schema:
type: integer
maximum: 730
minimum: 1
default: 400
title: Dte Max
- name: mode
in: query
required: false
schema:
type: string
pattern: ^(mid|call|put)$
default: mid
title: Mode
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/volatility/{ticker}/history:
get:
tags:
- volatility
summary: Volatility History
description: 'Historical ATM-IV(30d) series (+ per-expiry term) from the immutable
iv-history store (Pro+).'
operationId: volatility_history_v1_volatility__ticker__history_get
parameters:
- name: ticker
in: path
required: true
schema:
type: string
title: Ticker
- name: from
in: query
required: false
schema:
anyOf:
- type: string
pattern: ^\d{4}-\d{2}-\d{2}$
- type: 'null'
title: From
- name: to
in: query
required: false
schema:
anyOf:
- type: string
pattern: ^\d{4}-\d{2}-\d{2}$
- type: 'null'
title: To
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/volatility/{ticker}/percentile:
get:
tags:
- volatility
summary: Volatility Percentile
description: 'Through-time IV percentile / z-score / bands at a (moneyness, DTE) cell —
the empirical percentile of current IV over the lookback window (Pro+).'
operationId: volatility_percentile_v1_volatility__ticker__percentile_get
parameters:
- name: ticker
in: path
required: true
schema:
type: string
title: Ticker
- name: dte
in: query
required: false
schema:
type: number
maximum: 730.0
minimum: 1.0
default: 30.0
title: Dte
- name: moneyness
in: query
required: false
schema:
type: number
description: Display percent, e.g. 4.2 = +4.2%
default: 0.0
title: Moneyness
description: Display percent, e.g. 4.2 = +4.2%
- name: lookback_days
in: query
required: false
schema:
type: integer
maximum: 252
minimum: 5
default: 90
title: Lookback Days
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/volatility/{ticker}/realized:
get:
tags:
- volatility
summary: Volatility Realized
description: 'Annualized close-to-close REALIZED volatility for several trailing windows
(10/20/30/60/90/120/252 days), from adjusted daily bars (Pro+).'
operationId: volatility_realized_v1_volatility__ticker__realized_get
parameters:
- name: ticker
in: path
required: true
schema:
type: string
title: Ticker
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/volatility/{ticker}/iv-rank:
get:
tags:
- volatility
summary: Volatility Iv Rank
description: 'IV rank + IV percentile of the CURRENT ATM-IV(30d) within its historical
range — rank = (iv-min)/(max-min); percentile = % of days at or below current
(Pro+). Computed from the immutable ATM-IV history.'
operationId: volatility_iv_rank_v1_volatility__ticker__iv_rank_get
parameters:
- name: ticker
in: path
required: true
schema:
type: string
title: Ticker
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/volatility/{ticker}/stats:
get:
tags:
- volatility
summary: Volatility Stats
description: 'Descriptive stats of the ATM-IV(30d) history — mean / std / min / max /
p25 / median / p75, plus the current value and its z-score (Pro+).'
operationId: volatility_stats_v1_volatility__ticker__stats_get
parameters:
- name: ticker
in: path
required: true
schema:
type: string
title: Ticker
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/volatility/{ticker}/risk-reversal:
get:
tags:
- volatility
summary: Volatility Risk Reversal
description: 'Risk-reversal skew ≈ call-wing IV − put-wing IV at ± `moneyness`% (a
negative value = the usual equity put skew), read from the IV surface near
the target DTE band (Pro+).'
operationId: volatility_risk_reversal_v1_volatility__ticker__risk_reversal_get
parameters:
- name: ticker
in: path
required: true
schema:
type: string
title: Ticker
- name: moneyness
in: query
required: false
schema:
type: number
maximum: 25.0
minimum: 1.0
description: Wing distance in % (e.g. 5 = ±5%)
default: 5.0
title: Moneyness
description: Wing distance in % (e.g. 5 = ±5%)
- name: dte_min
in: query
required: false
schema:
type: integer
maximum: 730
minimum: 0
default: 20
title: Dte Min
- name: dte_max
in: query
required: false
schema:
type: integer
maximum: 730
minimum: 1
default: 40
title: Dte Max
- name: mode
in: query
required: false
schema:
type: string
pattern: ^(mid|call|put)$
default: mid
title: Mode
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError