Docs
Flowseeker/API Reference/Market

Market-wide flow overview for the current trading day

GEThttps://flow-api.skylit.ai/v1/market/overview

Returns market-wide call/put premium, total volume, directional bullish/bearish premium, FIR, premium relative volume vs the trailing 20-day baseline at the same time of day, and the top 10 tickers by total premium. Optionally narrowed to a comma-separated ticker filter.

Authorization

Authorization: Bearer <your API key>

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

Query parameters

  • tickersstring

    Comma-separated list of tickers (e.g. AAPL,NVDA,SPY). When omitted, returns true market-wide stats over every ticker.

Responses

  • 200

    Market-wide overview snapshot.

  • 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

    API key invalid, revoked or expired, or the account's API access is suspended (account_suspended).

  • 429

    Per-minute rate limit exceeded.

  • 503

    Underlying data source temporarily unavailable, or the credit balance could not be verified (credit_check_failed). Safe to retry.

Response fields

  • dataobjectrequired
    • datestringdaterequired
    • totalPremiumnumberrequired
    • totalVolumeintegerrequired
    • callPremiumnumberrequired
    • putPremiumnumberrequired
    • netPremiumnumberrequired
    • callVolumeintegerrequired
    • putVolumeintegerrequired
    • callPutRationumberrequired
    • activeTickersintegerrequired
    • bullishPremiumnumberrequired
    • bearishPremiumnumberrequired
    • directionalNetnumberrequired
    • firnumberrequired
    • premiumRvolnumberrequired

      Premium relative to the trailing 20-day baseline at this time of day.

    • topTickersobject[]required
  • metaobjectrequired
    • timestampstringdate-timerequired

      Server-side timestamp the response was generated at.

    • requestIdstringrequired

      Short opaque ID for log correlation.

Last updated

Was this page helpful?