Docs
Heatseeker/API Reference/Heatmap

Key levels (classified nodes) for one or more symbols

GEThttps://api.skylit.ai/v1/gex/levels

The strikes Skylit classifies as nodes (king, gatekeeper, pika, barney, significant) for up to 10 symbols, strongest first, with each level's distance from spot. Same live source, filters and 5-second cache as /v1/heatmap; 1 credit per request.

Authorization

Authorization: Bearer <your API key>

Required. A missing header returns 401; an invalid, revoked or expired key returns 403.

Query parameters

  • symbolsstringrequired

    One ticker, or a comma-separated list for a single cross-asset call (e.g. SPY or SPY,SPX,QQQ). Each is returned as an element of data.symbols.

  • metricstringdefault gamma

    Which Greek exposure to return per strike.

    gammavanna
  • maxStrikesintegerdefault 92min 1 · max 400

    Maximum number of strikes around spot to return.

  • maxExpirationsintegerdefault 5min 1 · max 60

    How many of the nearest expirations to net into each strike's value. Ignored when expirations is set.

  • expirationsstring

    Net each strike over exactly these expirations (YYYY-MM-DD, comma-separated) — one for a single-expiration heatmap (2026-05-22) or several for a custom set (2026-05-22,2026-06-19). Supersedes maxExpirations, and reaches any expiration the snapshot has, not just the nearest ones. Requested dates the symbol does not have are ignored; the expirations array in the response lists what was actually used. If none of them match, the response is 404 with code: expiration_not_found and the available dates in the message. On /v1/heatmap, expirations that have already expired are not available (they are trimmed from the live snapshot) — replay them with /v1/historical instead.

Responses

  • 200

    Levels per symbol.

  • 400

    Request validation failed.

  • 401

    Missing or invalid API key.

  • 402

    Out of credits (insufficient_credits).

  • 404

    Unknown symbol, no data available, or none of the requested expirations exist for the symbol (code: expiration_not_found).

Response fields

  • dataobject
    • symbolsobject[]
  • metaobject
    • metricstringrequired
      gammavanna
    • resolutionstringrequired
    • modestringrequired
      livehistorical
    • cachedbooleanrequired

      True if served from the in-process cache.

Last updated

Was this page helpful?