Docs
Flowseeker/API Reference/Underlying

Top underlyings by trailing-5-day flow

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

Same shape as /v1/underlying/top/daily but rolled up across 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).

  • min_premiumnumberdoublemin 0
  • min_volumeintegermin 0
  • order_bystringdefault premium
    premiumvolumenet_premiumcall_put_ratio
  • orderstringdefault desc
    ascdesc

Responses

  • 200

    Top underlyings 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
    • tickerstringrequired
    • totalPremiumnumberdoublerequired
    • totalVolumeintegerrequired
    • callPremiumnumberdoublerequired
    • putPremiumnumberdoublerequired
    • callVolumeintegerrequired
    • putVolumeintegerrequired
    • netPremiumnumberdoublerequired

      callPremium - putPremium.

    • callPutRationumberdoublerequired

      callPremium / putPremium (0 when no put premium).

  • metaobjectrequired
    • timestampstringdate-timerequired

      Server-side timestamp the response was generated at.

    • requestIdstringrequired

      Short opaque ID for log correlation.

Last updated

Was this page helpful?