Flow sentiment (Pro)
get_flow_sentimentBullish/bearish classification of each symbol's unusual flow with a 0-9 strength score, based on call/put volumes, premium and net delta. Pass a symbol for that ticker's sentiment time series (date_from, date_to, limit apply); omit it for the cross-market snapshot (filterable by sector, side, minimum strength or premium).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date | No | Trading day, YYYY-MM-DD. Defaults to the latest available day. | |
| side | No | Only rows classified with this signal side (snapshot only). | |
| limit | No | ||
| offset | No | Snapshot only. Rows to skip for paging; the response reports filtered_total and has_more. | |
| sector | No | GICS sector name, e.g. 'Information Technology' (snapshot only). | |
| symbol | No | Single ticker for its sentiment series; omit for the market-wide snapshot. | |
| date_to | No | Range end, YYYY-MM-DD inclusive. | |
| symbols | No | Comma-separated tickers, e.g. 'AAPL,NVDA,TSLA'. | |
| date_from | No | Range start, YYYY-MM-DD inclusive. | |
| min_premium | No | Minimum call+put premium in USD (snapshot only). | |
| signal_only | No | Only rows with an active bullish/bearish signal (snapshot only). | |
| min_strength | No | Snapshot only; rows without a signal count as 0. |