Aggregate sentiment scoring across timeframes (VWF / SDF / FIR / Composite)

Authorization

Path parameters

• tickerstringrequired

  Underlying ticker symbol (uppercase, e.g. SPY, AAPL).

Query parameters

• timeframesstringdefault 1d

  Comma-separated timeframes, or all. Supported atoms: 1h, 4h, 1d, 7d, 30d, 90d. all expands to all six. Unknown atoms are treated as a single trading day. At most 8 entries. Priced by range: 3 credits per started 30 days of summed window length (1d,7d = 3; all = 130 days = 15).

• include_breakdownbooleandefault true

  Attach the per-timeframe VWF/SDF/FIR component split.

• include_moneynessbooleandefault false

  Attach a byMoneyness array (deep_itm → deep_otm).

• moneyness_filterstringdefault all
  deep_itmitmatmotmdeep_otmall
• expiration_filterstringdefault all

  Restrict to one expiration bucket.

  0dteweeklymonthlyleapsall
• time_decaybooleandefault false

  Apply exponential time decay to VWF / SDF / FIR components.

• time_decay_half_lifeintegerdefault 30min 1

  Half-life in minutes for the decay (only applied when timeDecay=true).

• datestringdate

Responses

• 200

  Aggregate sentiment by timeframe.

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

• 404

  Unknown ticker or contract (SYMBOL_NOT_FOUND), or no data for the requested window. Not charged.

• 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

• dataobjectrequired
  Hide 5 fields

  • tickerstringrequired
  • generatedAtstringdate-timerequired
  • byTimeframeobjectrequired

    Map keyed by timeframe id (1h, 4h, 1d, 7d, 30d, 90d, …). Only the requested timeframes appear; missing entries indicate the underlying query failed for that horizon.

  • trendobjectrequired
    Show 3 fields
  • byMoneynessobject[]

    Present when includeMoneyness=true.

    Show 5 fields
• metaobjectrequired
  Hide 4 fields

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