v36

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2024-11-1856109168.6 KB

Flow Alerts

Returns the latest flow alerts.

get/api/option-trades/flow-alerts

Response

Successful response

Example response

{
  "data": [
    {
      "alert_rule": "RepeatedHits",
      "created_at": "2023-12-12T16:35:52.168Z",
      "expiry": "2023-12-22T00:00:00.000Z",
      "expiry_count": 2,
      "has_singleleg": true,
      "has_sweep": true,
      "option_chain": "MSFT231222C00375000",
      "price": 4.05,
      "ticker": "MSFT",
      "total_ask_side_prem": 151875,
      "total_bid_side_prem": 405,
      "total_premium": 186705,
      "total_size": 461,
      "trade_count": 32,
      "type": "call",
      "underlying_price": 372.99,
      "volume": 2442,
      "volume_oi_ratio": 0.30860609124226
    }
  ]
}