Option chain snapshot

Authorization

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). Past dates fall through to the daily rollup tables.

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.

• 403

  Unknown, revoked or expired API key (the gateway's forbidden), the account's API access is suspended (account_suspended) or blocked (account_blocked). Not retryable.

• 404

  Unknown ticker or contract (SYMBOL_NOT_FOUND), or no data for the requested window. Not charged.

• 429

  Either the key exceeded its requests-per-minute limit (X-RateLimit-Limit; no Retry-After, wait until X-RateLimit-Reset), or the account is over one of the API's own limits, such as the query budget (queries running at once, fresh queries per second): TOO_MANY_CONCURRENT_QUERIES or RATE_LIMITED with Retry-After. Not charged; retry after the wait.

• 500

  Unexpected server error (INTERNAL_ERROR, DATABASE_ERROR). Not charged; safe to retry with exponential backoff.

• 503

  Underlying data source temporarily unavailable, the credit balance could not be verified (credit_check_failed), or the API is paused for maintenance (api_paused, with a Retry-After header and a retry_after field in seconds). Not charged; safe to retry.

• 504

  The request did not complete within 25 seconds. Not charged; narrow the window or retry.

Response fields

• dataobjectrequired
  Hide 7 fields

  • tickerstringrequired
  • expirationstringdaterequired
  • underlyingPricenumberdoublerequired
  • strikesobject[]required
    Show 11 fields
  • maxPainnumber | nulldouble

    Strike at which the total intrinsic value owed to option holders (Σ callOi·max(0, S−K) + putOi·max(0, K−S)) is smallest, computed over the returned strikes. OI is each contract's latest reported value among the day's trades, so contracts that did not trade are absent; min_volume narrows it further. null when no OI is reported.

  • callOiTotalinteger

    Sum of callOi over the returned strikes.

  • putOiTotalinteger

    Sum of putOi over the returned strikes.

• metaobjectrequired
  Hide 4 fields

  • timestampstringdate-timerequired

    Server-side timestamp the response was generated at.

  • requestIdstringrequired

    Short opaque ID for log correlation.

  • nextCursorstring

    Trade feeds (/v1/flow/{ticker}, /v1/contract/{symbol}/trades): pass back as cursor with the same filters for the next page. Present only when more rows may follow.

  • nextEndTimestringdate-time

    /v1/flow/{ticker} only: the last row's exact time (RFC 3339 with nanoseconds), for end_time paging. Inclusive, so rows at that instant can repeat; nextCursor never repeats or skips.