Docs
Flowseeker/API Reference/Ratios

Chain-level bid/ask/mid distribution

GEThttps://flow-api.skylit.ai/v1/chain-ratio/{ticker}

Aggregates a ticker's full option chain to surface buying vs selling pressure (askRatio, bidRatio, midRatio, aggressionRatio), call/put balance, and ATM/OTM concentration. Returns a bias, aggression, and confidence interpretation.

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

  • datestringdate
  • timeframestringdefault 1d
    5m15m1h4h1d
  • option_typestringdefault all
    callputall
  • min_premiumintegermin 0
  • min_dteintegermin 0
  • max_dteintegermin 0

Responses

  • 200

    Chain ratio analysis with interpretation.

  • 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
    • datestringdaterequired
    • timeframestringrequired
    • tradeCountintegerrequired
    • totalPremiumnumberrequired
    • chainRatiosobjectrequired
    • interpretationobjectrequired
  • metaobjectrequired
    • timestampstringdate-timerequired

      Server-side timestamp the response was generated at.

    • requestIdstringrequired

      Short opaque ID for log correlation.

Last updated

Was this page helpful?