Market-wide breadth, advance/decline, and sector rotation
https://api.skylit.ai/v1/flow/market-breadthCombines 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
datestringdateTrading date (YYYY-MM-DD). Defaults to today.
fir_thresholdnumberdoubledefault10Absolute FIR threshold (in %) used to classify a ticker as advancing or declining. Tickers with
|fir| < thresholdcount 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
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; noRetry-After, wait untilX-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_QUERIESorRATE_LIMITEDwithRetry-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 aRetry-Afterheader and aretry_afterfield 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
dataobjectrequireddatestringdaterequiredmajorIndicesobject[]requiredaggregateSentimentobjectrequiredadvanceDeclineobjectrequiredsectorRotationobject[]required
metaobjectrequiredtimestampstringdate-timerequiredServer-side timestamp the response was generated at.
requestIdstringrequiredShort opaque ID for log correlation.
nextCursorstringTrade feeds (
/v1/flow/{ticker},/v1/contract/{symbol}/trades): pass back ascursorwith 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), forend_timepaging. Inclusive, so rows at that instant can repeat;nextCursornever repeats or skips.
Last updated