Docs
Flowseeker/API Reference/Underlying

Top underlyings by trailing-5-day flow

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

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

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

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

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