Flowseeker/API Reference/Underlying

Intraday chart bars for a ticker

GEThttps://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. Backed by the same intraday rollup tables that power 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). At most 30D with an intraday bucket, 365D with 1d/1w. Priced by range: 3 credits per started 30 days. N counts trading days (weekends and market holidays are skipped), ending with the current or latest session.

  • bucketstringrequired

    Bucket size. Every bucket in the window is returned, zero-filled when nothing traded, so the response grows with window / bucket: 1min over 30D is about 11,700 bars (390 per session), a multi-megabyte response. For windows over about 20 trading days, use 5min or coarser. Retention: 1min-30min cover the last 365 days; 1d and 1w go back to 2023-03-27.

    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.

  • 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

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

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

Last updated

Was this page helpful?