Docs
Flowseeker/API Reference/Market

Market-wide breadth, advance/decline, and sector rotation

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

Combines SPY/QQQ/IWM aggregate sentiment with an advance/decline ratio (over directional FIR) and per-sector rotation signals. Ideal as a single "is the market risk-on or risk-off right now" probe.

Authorization

Authorization: Bearer <your API key>

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

Query parameters

  • datestringdate

    Trading date (YYYY-MM-DD). Defaults to today.

  • fir_thresholdnumberdoubledefault 10

    Absolute FIR threshold (in %) used to classify a ticker as advancing or declining. Tickers with |fir| < threshold count as unchanged.

Responses

  • 200

    Market breadth + advance/decline + sector rotation.

  • 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
    • majorIndicesobject[]required
    • aggregateSentimentobjectrequired
    • advanceDeclineobjectrequired
    • sectorRotationobject[]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?