get_option_trades_flow_alerts
Monitor significant options trades and unusual market activity to identify potential trading opportunities based on volume, premium, and other customizable filters.
Instructions
Get option flow alerts showing significant option trades and unusual activity
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| all_opening | No | Boolean flag whether all transactions are opening transactions based on OI, Size & Volume (default: true) | |
| is_ask_side | No | Boolean flag whether a transaction is ask side (default: true) | |
| is_bid_side | No | Boolean flag whether a transaction is bid side (default: true) | |
| is_call | No | Boolean flag whether a transaction is a call (default: true) | |
| is_floor | No | Boolean flag whether a transaction is from the floor (default: true) | |
| is_otm | No | Only include contracts which are currently out of the money | |
| is_put | No | Boolean flag whether a transaction is a put (default: true) | |
| is_sweep | No | Boolean flag whether a transaction is a intermarket sweep (default: true) | |
| issue_types | No | An array of 1 or more issue types | |
| limit | No | How many items to return (default: 100, max: 200, min: 1) | |
| max_diff | No | The maximum OTM diff of a contract | |
| max_dte | No | The maximum days to expiry (min: 0) | |
| max_open_interest | No | The maximum open interest on that alert's contract | |
| max_premium | No | The maximum premium on that alert (min: 0) | |
| max_size | No | The maximum size on that alert (min: 0) | |
| max_volume | No | The maximum volume on that alert's contract | |
| max_volume_oi_ratio | No | The maximum ratio of contract volume to contract open interest | |
| min_diff | No | The minimum OTM diff of a contract | |
| min_dte | No | The minimum days to expiry (min: 0) | |
| min_open_interest | No | The minimum open interest on that alert's contract | |
| min_premium | No | The minimum premium on that alert (min: 0) | |
| min_size | No | The minimum size on that alert (min: 0) | |
| min_volume | No | The minimum volume on that alert's contract | |
| min_volume_oi_ratio | No | The minimum ratio of contract volume to contract open interest | |
| newer_than | No | Unix time in milliseconds/seconds or ISO date (2024-01-25) - no older results will be returned | |
| older_than | No | Unix time in milliseconds/seconds or ISO date (2024-01-25) - no newer results will be returned | |
| rule_name | No | An array of 1 or more rule names | |
| ticker_symbol | No | A comma separated list of tickers. To exclude certain tickers prefix the first ticker with a - |