Docs
Flowseeker/API Reference/Analytics

Volume-vs-Open-Interest accumulation analysis

GEThttps://flow-api.skylit.ai/v1/vol-oi/{ticker}

Distinguishes new position building (accumulation) from position closing (distribution) by bucketing Vol/OI ratios per option type and moneyness band. Returns an overall accumulation score (0–100), an estimate of the share of volume representing new positions, and a one-token signal (strong_accumulation → low_activity).

Authorization

Authorization: Bearer <your API key>

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

Path parameters

  • tickerstringrequired

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

Query parameters

  • timeframestringdefault daily
    dailyweekly
  • option_typestringdefault all
    callputall
  • moneynessstringdefault all
    otm_10plusotm_5_10otm_3_5atm_itmall
  • min_oiintegermin 0
  • datestringdate

Responses

  • 200

    Vol/OI breakdown with accumulation score.

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

  • 404

    Unknown resource (ticker / sector / window with no data).

  • 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
    • tickerstringrequired
    • timestampstringdate-timerequired
    • timeframestringrequired
      dailyweekly
    • volOiAnalysisobjectrequired
    • accumulationScoreintegerrequired

      Composite accumulation score (0-100).

    • newPositionEstimatePctintegerrequired

      Estimated share of volume that represents new positions.

    • signalstringrequired
      strong_accumulationaccumulationmixeddistributionlow_activity
  • metaobjectrequired
    • timestampstringdate-timerequired

      Server-side timestamp the response was generated at.

    • requestIdstringrequired

      Short opaque ID for log correlation.

Last updated

Was this page helpful?