Docs
Flowseeker/API Reference/Underlying

Option chain snapshot

GEThttps://flow-api.skylit.ai/v1/underlying/{ticker}/chain

Snapshot of the option chain for a single expiration on the requested date — call & put volume, premium, OI, last IV, and last trade price per strike, plus the underlying price.

Authorization

Authorization: Bearer <your API key>

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

Path parameters

  • tickerstringrequired

    Underlying ticker symbol (uppercase, e.g. SPY, AAPL).

Query parameters

  • expirationstringdaterequired

    Expiration date (YYYY-MM-DD).

  • min_volumeintegermin 0

    Suppress strikes whose total (call+put) volume is below this floor.

  • datestringdate

    Trading date the request targets, in YYYY-MM-DD. Defaults to the current trading date (the most recent session that has settled enough data to be queryable).

Responses

  • 200

    Chain snapshot.

  • 400

    Request validation failed.

  • 401

    Missing or invalid API key.

  • 402

    The account's shared Skylit credit balance is lower than this route's cost. Top up to continue. Carries X-Credits-Remaining: 0.

  • 404

    Unknown resource (ticker / sector / window with no data).

  • 429

    Per-minute rate limit exceeded.

Response fields

  • dataobjectrequired
    • tickerstringrequired
    • expirationstringdaterequired
    • underlyingPricenumberdoublerequired
    • strikesobject[]required
  • metaobjectrequired
    • timestampstringdate-timerequired

      Server-side timestamp the response was generated at.

    • requestIdstringrequired

      Short opaque ID for log correlation.

Last updated

Was this page helpful?