Docs
Flowseeker/API Reference/Market

Bucketed market-wide net call premium / net put premium time series

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

Returns the market-wide intraday "tide" — bucketed Net Call Premium and Net Put Premium series with both per-bucket and cumulative values, plus an SPY price overlay for context. Two directional flavors are emitted per bar: the standard ncp/npp (call-buying minus call-selling, etc.) and a manualNcp/ manualNpp variant with fewer exclusions applied, for callers that need raw flow.

Authorization

Authorization: Bearer <your API key>

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

Query parameters

  • intervalstringdefault 1D

    Trailing window length. Defaults to a single trading day (1D); multi-day intervals roll up history at the chosen bucket size.

    1D2D3D5D7D14D30D45D60D90D120D180D360D
  • bucketstringdefault 5min

    Bucket size for the time series.

    1min5min15min30min1d1w
  • datestringdate

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

  • exclude_multi_legbooleandefault false

    Exclude multi-leg / spread trades from the directional totals.

  • exclude_deep_itmbooleandefault false

    Exclude deep in-the-money trades (moneyness_percent < -20) from the directional totals.

Responses

  • 200

    Market tide bars.

  • 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
    • intervalstringrequired
    • bucketstringrequired
    • barsobject[]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?