Docs
Flowseeker/API Reference/Contract

Top contracts by trailing-5-day flow

GEThttps://flow-api.skylit.ai/v1/contract/top/weekly

Same shape as /v1/contract/top/daily, rolled up over the trailing 5 trading days ending on date.

Authorization

Authorization: Bearer <your API key>

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

Query parameters

  • limitintegerdefault 100min 1 · max 500

    Maximum rows to return. Server caps at 500.

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

  • tickerstring
  • min_premiumnumberdouble
  • max_premiumnumberdouble
  • min_volumeintegermin 0
  • max_volumeintegermin 0
  • min_oiintegermin 0
  • max_oiintegermin 0
  • rightstring
    CP
  • min_dteinteger
  • max_dteinteger
  • min_strikenumberdouble
  • max_strikenumberdouble
  • expirationstringdate
  • min_ivnumberdouble
  • max_ivnumberdouble
  • order_bystringdefault premium
    premiumvolumeoiiv
  • orderstringdefault desc
    ascdesc
  • only_sweepsbooleandefault false
  • only_multi_legbooleandefault false
  • exclude_multi_legbooleandefault false

Responses

  • 200

    Top contracts for the trailing week.

  • 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
    • symbolstringrequired
    • tickerstringrequired
    • expirationstringdaterequired
    • strikenumberdoublerequired
    • rightstringrequired
      CP
    • dteintegerrequired
    • totalPremiumnumberdoublerequired
    • totalVolumeintegerrequired
    • openInterestintegerrequired
    • oiChangeintegerrequired
    • volumeOiRationumberdoublerequired
    • bidVolumeintegerrequired
    • askVolumeintegerrequired
    • midVolumeintegerrequired
    • vwapnumberdoublerequired
    • lastPricenumberdoublerequired
    • underlyingPricenumberdoublerequired
    • ivnumberdoublerequired
    • tradeCountintegerrequired
    • sweepVolumeintegerrequired
    • sweepPremiumnumberdoublerequired
    • multiLegVolumeintegerrequired
    • multiLegPremiumnumberdoublerequired
  • metaobjectrequired
    • timestampstringdate-timerequired

      Server-side timestamp the response was generated at.

    • requestIdstringrequired

      Short opaque ID for log correlation.

Last updated

Was this page helpful?