Scored unusual options flow

get/unusual-activity

Request

  • Base URL: https://api.tradermatrix.pro/api/v1
  • URL: https://api.tradermatrix.pro/api/v1/unusual-activity
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Query parameters

tickerstring
minPremiuminteger
minScoreinteger
type'all' | 'call' | 'put'
sentiment'all' | 'bullish' | 'bearish'
timeFrame'hour' | 'today' | 'todayOrLastSession' | 'yesterday' | '3days' | 'week' | 'month'
tier1 | 2 | 3
pageinteger
pageSizeinteger
dtestring

DTE window: a range such as 0-7, or open-ended such as 8+ (more than 7 days out). Malformed values return 400.

tradeTypestring

Comma-separated trade types

flowAction'opening' | 'closing' | 'all'
minOtmPctnumber
minVsOInumber
minOInumber
marketCapTier'mega' | 'large' | 'mid' | 'small' | 'all'

Response

OK. Top-level sessionDate (YYYY-MM-DD, ET) names the trading session the rows were read from for timeFrame today / todayOrLastSession / yesterday (todayOrLastSession serves the last complete session until the market opens); null for rolling windows.

Changes

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