Docs
Flowseeker/API Reference/Underlying

Bulk underlying stats for a list of tickers

GEThttps://flow-api.skylit.ai/v1/underlying/bulk/stats

Returns a single-day UnderlyingStats record per requested ticker. Tickers absent from the response had no options activity that day.

Authorization

Authorization: Bearer <your API key>

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

Query parameters

  • tickersstringrequired

    Comma-separated list of tickers (max 50).

  • 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

    Per-ticker stats.

  • 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.

  • 429

    Per-minute rate limit exceeded.

Response fields

  • dataobject[]required
    • tickerstringrequired
    • datestringdaterequired
    • lastPricenumberdoublerequired

      Last traded underlying stock price on date.

    • totalPremiumnumberdoublerequired
    • totalVolumeintegerrequired
    • callPremiumnumberdoublerequired
    • putPremiumnumberdoublerequired
    • callVolumeintegerrequired
    • putVolumeintegerrequired
    • netPremiumnumberdoublerequired
    • callPutRationumberdoublerequired
    • tradeCountintegerrequired
    • uniqueStrikesintegerrequired
    • uniqueExpirationsintegerrequired
  • metaobjectrequired
    • timestampstringdate-timerequired

      Server-side timestamp the response was generated at.

    • requestIdstringrequired

      Short opaque ID for log correlation.

Last updated

Was this page helpful?