OptionWhales Gex API
The gex API from OptionWhales — 6 operation(s) for gex.
The gex API from OptionWhales — 6 operation(s) for gex.
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-gex-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 Gex 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: gex
paths:
/v1/gex/{ticker}/timeseries:
get:
tags:
- gex
summary: Gex Timeseries
description: Multi-session GEX timeseries — gamma flip, max pain, net GEX trend (Pro+ only).
operationId: gex_timeseries_v1_gex__ticker__timeseries_get
parameters:
- name: ticker
in: path
required: true
schema:
type: string
title: Ticker
- name: start
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Start
- name: end
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: End
- name: dte_filter
in: query
required: false
schema:
type: string
description: all | 0dte | 0+1 | weekly | monthly (legacy integer days also accepted)
default: all
title: Dte Filter
description: all | 0dte | 0+1 | weekly | monthly (legacy integer days also accepted)
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/gex/{session}/{ticker}/levels:
get:
tags:
- gex
summary: Gex Levels
description: 'Key GEX levels — spot, gamma flip, max pain, call wall, put wall (Pro+ only).
Definitions (data-api key levels v2, 2026-10-05): call wall = the strike
at/above spot with the largest call gamma; put wall = the strike at/below
spot with the largest put gamma; max pain = per expiration, headline struck
for the front expiry in the DTE filter (``max_pain_expiry``). ``wall_basis``
and ``max_pain_basis`` state which definition each field carries; the
legacy readings ride along as ``net_call_wall`` / ``net_put_wall`` /
``max_pain_blended``.'
operationId: gex_levels_v1_gex__session___ticker__levels_get
parameters:
- name: session
in: path
required: true
schema:
type: string
title: Session
- name: ticker
in: path
required: true
schema:
type: string
title: Ticker
- name: dte_filter
in: query
required: false
schema:
type: string
description: all | 0dte | 0+1 | weekly | monthly (legacy integer days also accepted)
default: all
title: Dte Filter
description: all | 0dte | 0+1 | weekly | monthly (legacy integer days also accepted)
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/gex/{session}/{ticker}/greek-exposure:
get:
tags:
- gex
summary: Gex Greek Exposure
description: 'Second-order dealer greek exposure — gamma, charm AND vanna — decomposed
by strike AND by expiry, split call/put (Pro+ only).
Each ``by_strike`` / ``by_expiry`` row carries ``call_gex/put_gex/net_gex``
(gamma $-exposure per 1% move), ``call_charm/put_charm/net_charm`` ($ per
day of decay), ``call_vanna/put_vanna/net_vanna`` ($ per vol-point) and
``call_oi/put_oi``. Pass ``include_strike_expiry=true`` for the full grid.'
operationId: gex_greek_exposure_v1_gex__session___ticker__greek_exposure_get
parameters:
- name: session
in: path
required: true
schema:
type: string
title: Session
- name: ticker
in: path
required: true
schema:
type: string
title: Ticker
- name: dte_filter
in: query
required: false
schema:
type: string
description: all | 0dte | 0+1 | weekly | monthly (legacy integer days also accepted)
default: all
title: Dte Filter
description: all | 0dte | 0+1 | weekly | monthly (legacy integer days also accepted)
- name: include_strike_expiry
in: query
required: false
schema:
type: boolean
description: Also return the per-strike-per-expiry grid
default: false
title: Include Strike Expiry
description: Also return the per-strike-per-expiry grid
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/gex/{session}/{ticker}/intraday-exposures:
get:
tags:
- gex
summary: Gex Intraday Exposures
description: 'Intraday spot-GEX — net dealer gamma/charm/vanna recomputed at each intraday
spot (minute bars), with OI/IV held fixed from the twice-daily snapshot. Shows
how dealer positioning evolves as price moves through the day (Pro+).
Returns a ``series`` of ``{t, spot, net_gex, net_charm, net_vanna, call_gex,
put_gex}`` plus a ``summary`` (open/last/min/max net_gex, contracts_used).'
operationId: gex_intraday_exposures_v1_gex__session___ticker__intraday_exposures_get
parameters:
- name: session
in: path
required: true
schema:
type: string
title: Session
- name: ticker
in: path
required: true
schema:
type: string
title: Ticker
- name: dte_filter
in: query
required: false
schema:
type: string
description: all | 0dte | 0+1 | weekly | monthly (legacy integer days also accepted)
default: all
title: Dte Filter
description: all | 0dte | 0+1 | weekly | monthly (legacy integer days also accepted)
- name: step_min
in: query
required: false
schema:
type: integer
maximum: 60
minimum: 1
description: Minutes between sampled spots
default: 5
title: Step Min
description: Minutes between sampled spots
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/gex/{session}/{ticker}/with-flow:
get:
tags:
- gex
summary: Gex With Flow
description: 'GEX including option flow — the same computation the OptionWhales panel renders.
Prefer this over ``GET /v1/gex/{session}/{ticker}`` when you want the numbers
our dashboard shows. The two endpoints agree on ``structural_gex`` to the
dollar but **not** on ``net_gex`` or ``key_levels``, because they differ on
one thing — flow:
* ``/v1/gex/{session}/{ticker}`` is **structural only** on a past session
(``flow_included: false``, ``flow_gex: 0``).
* this route adds flow on **every** session: reconstructed from that
session''s archived large-order tape for a past date, and from the **live
streaming tape** for the current one.
Because ``key_levels`` (call wall, put wall, gamma flip, at-spot regime) are
derived from ``structural + flow``, the flow difference moves the LEVELS too,
not just the totals — on SPY 2026-09-01 the call wall is 800 without flow and
780 with it. If you alert on a level, read it from here.
The payload declares its own bases: ``summary.basis`` names the basis of
every money column, ``summary.key_levels_structural`` carries the
structural-only levels alongside the flow-inclusive ``summary.key_levels``,
and ``summary.gamma_basis`` names the gamma model. ``summary.flow_source``
reports where the flow came from (``computed_from_streaming`` /
``computed_from_archive`` / ``historical_no_flow``) and
``summary.flow_orders_count`` how many orders backed it.
Note the flow tape is filtered at ingest to trades of **100+ contracts**, so
``flow_gex`` reflects large-order flow, not the session''s full volume.'
operationId: gex_with_flow_v1_gex__session___ticker__with_flow_get
parameters:
- name: session
in: path
required: true
schema:
type: string
title: Session
- name: ticker
in: path
required: true
schema:
type: string
title: Ticker
- name: dte_filter
in: query
required: false
schema:
type: string
description: all | 0dte | 0+1 | weekly | monthly (legacy integer days also accepted)
default: all
title: Dte Filter
description: all | 0dte | 0+1 | weekly | monthly (legacy integer days also accepted)
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/gex/{session}/{ticker}:
get:
tags:
- gex
summary: Gex Full
description: Full GEX profile — by_strike array, IV smile, optional flow overlay and OHLC (Pro+ only).
operationId: gex_full_v1_gex__session___ticker__get
parameters:
- name: session
in: path
required: true
schema:
type: string
title: Session
- name: ticker
in: path
required: true
schema:
type: string
title: Ticker
- name: include_flow
in: query
required: false
schema:
type: boolean
default: true
title: Include Flow
- name: include_ohlc
in: query
required: false
schema:
type: boolean
default: false
title: Include Ohlc
- name: dte_filter
in: query
required: false
schema:
type: string
description: all | 0dte | 0+1 | weekly | monthly (legacy integer days also accepted)
default: all
title: Dte Filter
description: all | 0dte | 0+1 | weekly | monthly (legacy integer days also accepted)
- name: smile_expiry
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Smile Expiry
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