Docs
Flowseeker/API Reference/Contract

Contracts with significant OI changes

GEThttps://flow-api.skylit.ai/v1/contract/unusual-oi

Contracts whose open interest changed by at least min_oi_change (or min_oi_change_pct) on the target date. direction narrows the result to opening (OI ↑) or closing (OI ↓) flow.

Authorization

Authorization: Bearer <your API key>

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

Query parameters

  • limitintegerdefault 50min 1 · max 200

    Maximum rows to return.

  • min_oi_changeintegerdefault 500
  • min_oi_change_pctnumberdoubledefault 25
  • tickerstring
  • rightstring
    CP
  • min_dteinteger
  • max_dteinteger
  • min_premiumnumberdouble
  • min_volumeintegermin 0
  • datestringdate

    Target trading date (YYYY-MM-DD). Defaults to the previous calendar day (not the current trading date).

  • order_bystringdefault oi_change
    oi_changeoi_change_pctvolumepremium
  • directionstringdefault both
    openingclosingboth
  • only_sweepsboolean
  • only_multi_legboolean
  • exclude_multi_legboolean

Responses

  • 200

    Contracts ranked by OI change.

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

  • 429

    Per-minute rate limit exceeded.

Response fields

  • dataobject[]required
    • symbolstringrequired
    • tickerstringrequired
    • expirationstringdaterequired
    • strikenumberdoublerequired
    • rightstringrequired
      CP
    • dteintegerrequired
    • datestringdaterequired
    • openInterestintegerrequired
    • prevOiintegerrequired
    • oiChangeintegerrequired
    • oiChangePctnumberdoublerequired
    • volumeintegerrequired
    • premiumnumberdoublerequired
    • volumeOiRationumberdoublerequired
    • bidVolumeintegerrequired
    • askVolumeintegerrequired
    • lastPricenumberdoublerequired
    • underlyingPricenumberdoublerequired
    • ivnumberdoublerequired
    • positionTypestringrequired
      openingclosing
    • sweepVolumeintegerrequired
    • sweepPremiumnumberdoublerequired
    • multiLegVolumeintegerrequired
    • multiLegPremiumnumberdoublerequired
  • metaobjectrequired
    • timestampstringdate-timerequired

      Server-side timestamp the response was generated at.

    • requestIdstringrequired

      Short opaque ID for log correlation.

Last updated

Was this page helpful?