alerts.create

write

Create flow alert

Creates a flow alert that fires when new options flow matches the filters. Free accounts may hold one alert.

Free with an account. Requires a key or OAuth token with the write scope.

Input

Field	Type	Description
name*	string
filters*	object	Same filters as flow.search (minus limit/since/window/types)
source	"live" \| "historical"	Flow feed the alert watchesDefault "live".
active	boolean	Default true.
latency	"realtime" \| "5min" \| "15min"	Delivery latency; realtime and 5min require PaidDefault "15min".

* required

Output

Returned under data; every response also carries meta with freshness, as_of and truncated.

Field	Type	Description
dry_run*	boolean	True when dry_run was requested: nothing was persisted; other fields show the would-be result
alert*	object

* required

Example request

curl -X POST "https://impliedoptions.com/api/v1/tools/alerts.create" \
  -H "Authorization: Bearer <YOUR_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "args": {
      "name": "NVDA big call sweeps",
      "filters": {
        "tickers": [
          "NVDA"
        ],
        "rights": [
          "C"
        ],
        "min_premium": 500000
      }
    }
  }'

Rendered result: /flow?tab=options

alerts.create

Input

Output

Example request

Run