Docs
Flowseeker/API Reference/Underlying

Relative-volume bars for a ticker

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

Time-bucketed bars with call/put volume + premium and an average-volume baseline computed from avgPeriod recent days, plus aggregate RVOL stats.

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

  • intervalstringdefault 1D

    Trailing window — {N}D where N is 1–365 (e.g. 1D, 7D, 30D).

  • bucketstringdefault 5min
    1min5min10min15min30min1d1w
  • avg_periodstringdefault 14d

    Baseline lookback as {N}d (e.g. 14d, 30d). Max 365 days.

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

  • order_bystringdefault time
    rvolvolumepremiumtime
  • orderstring

    Sort direction. Defaults to asc when order_by=time, otherwise desc.

    ascdesc
  • limitintegermin 1
  • formatstringdefault full
    fullsummary

Responses

  • 200

    RVOL bars + aggregate 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

  • dataobjectrequired
    • barsobject[]required
    • statsobjectrequired
    • callRvolnumberdoublerequired

      Aggregate call-volume RVOL.

    • putRvolnumberdoublerequired

      Aggregate put-volume RVOL.

  • metaobjectrequired
    • timestampstringdate-timerequired

      Server-side timestamp the response was generated at.

    • requestIdstringrequired

      Short opaque ID for log correlation.

Last updated

Was this page helpful?