gexbot api
state

gex profile major levels

Provides the major levels from the GEX Profile, including the strikes with the largest positive (call) and negative (put) GEX imbalances.

GET/{TICKER}/state/{AGGREGATION_PERIOD}/majorsState Tier

chart

Powers the gex profile chart.

Provides the major levels from the GEX Profile, including the strikes with the largest positive (call) and negative (put) GEX imbalances.

Subscription

Requires a State subscription or higher.

Request

Example: /SPX/state/full/majors

Headers

NameTypeDescription
AuthorizationstringRequired. Format: "Bearer <YOUR_API_KEY>"
User-AgentstringRequired. Identify your client application.
AcceptstringRequired. Set to "application/json".

Path parameters

NameTypeDescription
TICKERstringDesired ticker symbol (e.g., SPX).
AGGREGATION_PERIODstringAggregation period: full, zero, or one.

Response

FieldTypeDescription
timestampnumberThe Unix timestamp of when the data was generated.
tickerstringThe ticker symbol for the requested asset.
spotnumberThe spot price of the underlying asset.
mpos_volnumberMajor positive GEX imbalance level (call GEX).
mpos_oinumberNot applicable for State model.
mneg_volnumberMajor negative GEX imbalance level (put GEX).
mneg_oinumberNot applicable for State model.
zero_gammanumberNot applicable for State model
net_gex_volnumberThe total GEX imbalance (net GEX) based on classified volume.
net_gex_oinumberNot applicable for State model.
{
  "timestamp": 1753283592,
  "ticker": "SPX",
  "spot": 6326.27,
  "mpos_vol": 6345,
  "mpos_oi": 0,
  "mneg_vol": 6300,
  "mneg_oi": 0,
  "zero_gamma": 0,
  "net_gex_vol": -200.55548,
  "net_gex_oi": 0
}
{
  "type": "object",
  "properties": {
    "timestamp": {
      "type": "integer",
      "format": "int64"
    },
    "ticker": {
      "type": "string",
      "minLength": 2,
      "maxLength": 5
    },
    "spot": {
      "type": "number",
      "format": "double"
    },
    "mpos_vol": {
      "type": "integer"
    },
    "mpos_oi": {
      "type": "integer"
    },
    "mneg_vol": {
      "type": "integer"
    },
    "mneg_oi": {
      "type": "integer"
    },
    "zero_gamma": {
      "type": "integer"
    },
    "net_gex_vol": {
      "type": "number"
    },
    "net_gex_oi": {
      "type": "number"
    }
  },
  "additionalProperties": false
}
type: object
properties:
  timestamp:
    type: integer
    format: int64
  ticker:
    type: string
    minLength: 2
    maxLength: 5
  spot:
    type: number
    format: double
  mpos_vol:
    type: integer
  mpos_oi:
    type: integer
  mneg_vol:
    type: integer
  mneg_oi:
    type: integer
  zero_gamma:
    type: integer
  net_gex_vol:
    type: number
  net_gex_oi:
    type: number
additionalProperties: false

On this page