Options Flow

Daily flow overview

Aggregated unusual-options flow per symbol for one trading day, plus market-wide totals for that day in meta.market_stats. A date without data returns an empty data array. Orders: streak = consecutive_days desc, total_volume desc, symbol asc; volume = total_volume desc, symbol asc; callput = call/put volume ratio desc, symbol asc; premium = call + put premium desc, symbol asc. Nulls sort last. The cursor pins the trading day. Pro tier required.

get/options-flow

Request

  • Base URL: https://stockmarketscan.com/api/v1
  • URL: https://stockmarketscan.com/api/v1/options-flow
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer
    • API key in header X-RapidAPI-Key

Query parameters

datestring date

Trading date. Defaults to the latest available day.

sort'streak' | 'volume' | 'callput' | 'premium'
limitinteger
cursorstring

Opaque cursor from meta.pagination.next_cursor of the previous page. Omit for the first page.

Headers

If-None-Matchstring

ETag of a previous response. An unchanged resource returns 304 without a body and without a quota charge.

Response

Options flow for one day

Example response

{
  "data": [
    {
      "symbol": "NVDA"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.