Docs
Heatseeker/API Reference/Heatmap

Replay per-strike heatmap at a past instant (one or more symbols)

GEThttps://api.skylit.ai/v1/historical

The snapshot nearest at for one or more symbols — same shape as /v1/heatmap minus velocityPct (velocity is live-only). at may be up to 365 days in the past; if no snapshot exists at/near that instant the response is 404 with code: no_data.

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.

  • atstringdate-timerequired

    RFC3339 instant to replay (e.g. 2026-03-05T10:01:00Z). Up to 365 days back.

  • 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

    Historical heatmap snapshot(s).

  • 400

    Request validation failed.

  • 401

    Missing or invalid API key.

  • 403

    The API key is invalid, revoked or expired, or the account is suspended.

  • 404

    No snapshot at/near the requested instant, unknown symbol, or none of the requested expirations exist in that snapshot.

  • 429

    Per-minute rate limit exceeded.

  • 503

    Heatmap data is temporarily unavailable.

Response fields

  • dataobjectrequired
    • symbolsobject[]required
  • metaobjectrequired
    • metricstringrequired
      gammavanna
    • resolutionstringrequired
    • modestringrequired
      livehistorical
    • cachedbooleanrequired

      True if served from the in-process cache.

Last updated

Was this page helpful?