Docs
Flowseeker/API Reference/Contract

Contracts with unusual relative volume

GEThttps://api.skylit.ai/v1/contract/unusual-volume

Contracts whose volume on the target date is anomalously high relative to a avgPeriod-day baseline. Filters cover RVOL, raw volume, OI dynamics, premium, IV, moneyness, sweep / multi-leg, and ticker include / exclude lists. Sortable by rvol, volume, premium, vol_oi, or oi_change.

Authorization

Authorization: Bearer <your API key>

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

Query parameters

  • limitintegerdefault 50min 1 · max 200

    Maximum rows to return.

  • min_rvolnumberdoubledefault 2
  • avg_periodstringdefault 10d

    Baseline window as {N}d. Must be 2–365 days.

  • min_avg_volumeintegerdefault 100min 0
  • min_premiumnumberdouble
  • tickerstring
  • rightstring
    CP
  • min_dteinteger
  • max_dteinteger
  • min_strikenumberdouble
  • max_strikenumberdouble
  • expirationstringdate
  • datestringdate

    Target trading date (YYYY-MM-DD). Defaults to the previous calendar day (not the current trading date) since baselines need a settled session.

  • order_bystringdefault rvol
    rvolvolumepremiumvol_oioi_change
  • min_vol_oi_rationumberdouble
  • min_oi_changeinteger
  • max_oi_changeinteger
  • only_sweepsboolean
  • only_multi_legboolean
  • exclude_multi_legboolean
  • min_oi_change_pctnumberdouble
  • min_bid_imbalancenumberdoublemin 0 · max 1
  • min_ask_imbalancenumberdoublemin 0 · max 1
  • moneynessstring
    ITMATMOTM
  • min_moneyness_pctnumberdouble
  • max_moneyness_pctnumberdouble
  • min_ivnumberdouble
  • max_ivnumberdouble
  • exclude_tickersstring

    Comma-separated tickers to exclude (e.g. SPY,QQQ,IWM).

Responses

  • 200

    Contracts ranked by the requested metric.

  • 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
    • symbolstringrequired
    • tickerstringrequired
    • expirationstringdaterequired
    • strikenumberdoublerequired
    • rightstringrequired
      CP
    • dteintegerrequired
    • datestringdaterequired
    • volumeintegerrequired
    • avgVolumenumberdoublerequired

      Baseline volume over the requested avgPeriod.

    • rvolnumberdoublerequired

      volume / avgVolume.

    • premiumnumberdoublerequired
    • openInterestintegerrequired
    • prevOiintegerrequired
    • oiChangeintegerrequired
    • oiChangePctnumberdoublerequired
    • volumeOiRationumberdoublerequired
    • bidVolumeintegerrequired
    • askVolumeintegerrequired
    • bidPctnumberdoublerequired
    • askPctnumberdoublerequired
    • lastPricenumberdoublerequired
    • underlyingPricenumberdoublerequired
    • ivnumberdoublerequired
    • moneynessPctnumberdoublerequired
    • sweepVolumeintegerrequired
    • sweepPremiumnumberdoublerequired
    • multiLegVolumeintegerrequired
    • multiLegPremiumnumberdoublerequired
  • 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?