Docs
Flowseeker/API Reference/Sector

Sector- or industry-level flow aggregation

GEThttps://flow-api.skylit.ai/v1/flow/sector/{sector}

Aggregates options flow across all tickers in a GICS sector. The {sector} path parameter accepts either a sector ETF symbol (XLK, XLF, XLE, …) or a sector name (Technology, Financials, …). Returns sector-level metrics, top-contributor tickers, and an industry-level breakdown.

Authorization

Authorization: Bearer <your API key>

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

Path parameters

  • sectorstringrequired

    Sector ETF symbol (XLK, XLF, XLE, XLV, XLY, XLP, XLU, XLI, XLB, XLRE, XLC) or full sector name (Technology, Financials, Healthcare, etc.).

Query parameters

  • datestringdate
  • top_nintegerdefault 10min 1 · max 50

Responses

  • 200

    Sector flow aggregation.

  • 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
    • sectorstringrequired
    • etfstring

      Sector ETF symbol when resolvable (e.g. XLK for Technology).

    • datestringdaterequired
    • metricsobjectrequired
    • topContributorsobject[]required
    • industryBreakdownobject[]required
    • tickerCountintegerrequired
  • metaobjectrequired
    • timestampstringdate-timerequired

      Server-side timestamp the response was generated at.

    • requestIdstringrequired

      Short opaque ID for log correlation.

Last updated

Was this page helpful?