Retrieve Flow Data
Returns the latest flows for the given option chain, with optional filtering by min premium or side.
get/api/option-contract/{id}/flow
Path parameters
idstring required
Example:TSLA230526P00167500
The option contract in ISO format.
Query parameters
datestring date
Example:2024-01-18
A trading date in the format YYYY-MM-DD. Defaults to the last trading date.
limitinteger
Example:10
The number of items to return. Minimum is 1.
min_premiuminteger
Example:50000
The minimum premium requested trades should have. Defaults to 0.
side'ALL' | 'ASK' | 'BID' | 'MID'
Example:ASK
The side of a stock trade. Defaults to ALL.
Response
Successful response with flow data.
Example response
{
"data": [
{
"id": "8ef90a2d-d881-41de-98c9-c1de4318dcb5",
"executed_at": "2024-08-21T13:50:52.278Z",
"open_interest": 18680,
"volume": 33,
"underlying_symbol": "AAPL",
"option_type": "call",
"expiry": "2023-12-22T00:00:00.000Z",
"sector": "Technology",
"size": 1,
"tags": [
"activist",
"earnings_next_week"
],
"upstream_condition_detail": "auto"
}
]
}