Flow Alerts
Deprecated. Use /api/option-trades/flow-alerts, which supports the full filter set:
https://api.unusualwhales.com/docs#/operations/PublicApi.OptionTradeController.flow_alerts
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
A single ticker
"AAPL"
Query Parameters
How many items to return. Default: 100. Max: 200. Min: 1.
1 <= x <= 20010
Boolean flag whether a transaction is ask side.
true
Boolean flag whether a transaction is bid side.
true
Response
Representation of a flow alert.
The name of the alert rule.
"RepeatedHits"
false
A UTC timestamp.
"2023-12-12T16:35:52.168Z"
Size weighted delta of all transactions that make up the flow alert. Null when unavailable.
The contract expiry date in ISO format.
"2023-12-22T00:00:00.000Z"
The amount of expiries belonging to the trade. This is only greater than 1 if it is a multileg trade.
2
Size weighted gamma of all transactions that make up the flow alert. Null when unavailable.
false
Whether the trade is a multileg trade.
false
Whether the trade is a singleleg trade.
true
Whether the trade is a sweep.
true
The issue type of the ticker.
Common Stock, ETF, Index, ADR "Common Stock"
Size weighted implied volatility of all transactions that make up the flow alert. Null when unavailable.
The option symbol of the contract.
You can use the following regex to extract underlying ticker, option type, expiry & strike:
^(?<symbol>[\w]*)(?<expiry>(\d{2})(\d{2})(\d{2}))(?<type>[PC])(?<strike>\d{8})$
Keep in mind that the strike needs to be multiplied by 1,000.
Size weighted rho of all transactions that make up the flow alert. Null when unavailable.
The contract strike.
"375"
Size weighted theoretical option price of all transactions that make up the flow alert. Null when unavailable.
Size weighted theta of all transactions that make up the flow alert. Null when unavailable.
The contract type.
call, put "call"
Size weighted vega of all transactions that make up the flow alert. Null when unavailable.
