Flowseeker/API Reference/Underlying

Intraday chart bars for a ticker

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

Returns time-bucketed bars aggregating options activity for the underlying (call/put volume + premium, P/C ratio, bid/ask execution split) plus the underlying stock price at each boundary. The same data that powers the chart modal in the Skylit UI.

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

  • intervalstringrequired

    Trailing window covered by the bars (e.g. 1D, 7D, 30D).

  • bucketstringrequired

    Bucket size.

    1min5min10min15min30min1d1w

Responses

  • 200

    Intraday chart bars.

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

      Bucket start, Unix seconds (returned as a string for JS-precision safety).

    • timestampEndstringrequired
    • callVolumeintegerrequired
    • putVolumeintegerrequired
    • candleVolumeintegerrequired

      callVolume + putVolume.

    • callPremiumnumberdoublerequired
    • putPremiumnumberdoublerequired
    • candlePremiumnumberdoublerequired
    • stockPricenumberdoublerequired
    • pcRationumberdoublerequired

      putVolume / callVolume (0 when no calls).

    • avgVolumenumberdouble

      30D baseline volume for this time-of-day slot. Omitted when insufficient history.

    • avgPremiumnumberdouble

      30D baseline premium for this time-of-day slot.

    • chainBidPctnumberdoublerequired

      % of bucket volume executed at/below the bid.

    • chainAskPctnumberdoublerequired

      % of bucket volume executed at/above the ask.

  • metaobjectrequired
    • timestampstringdate-timerequired

      Server-side timestamp the response was generated at.

    • requestIdstringrequired

      Short opaque ID for log correlation.

Last updated

Was this page helpful?