Relative-volume bars for a ticker

Authorization

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

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

• 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

  With format=full (the default) the response carries bars; with format=summary bars is omitted and only stats, callRvol and putRvol are returned.

  Hide 4 fields

  • barsobject[]

    Per-bucket bars. Present only with format=full.

    Show 12 fields
  • statsobjectrequired
    Show 7 fields
  • callRvolnumberdoublerequired

    Aggregate call-volume RVOL.

  • putRvolnumberdoublerequired

    Aggregate put-volume RVOL.

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