Skip to main content
POST
Screen stocks with options-centric defaults

Body

application/json

Screener request payload.

Screen stocks using graph-native filters with optional relationship expansion.

Example: json { "filters": { "volume": {"adv30_usd_min": 50000000}, "technical": {"rsi_14": {"min": 30, "max": 70}} }, "include": {"levels": true, "patterns": true}, "sort": {"by": "dollar_volume", "order": "desc"}, "pagination": {"limit": 50} }

filters
Filters · object | null

All available screener filters.

include
IncludeOptions · object | null

Options for including related data in response.

sort
SortOptions · object | null

Sorting options.

pagination
Pagination · object | null

Pagination options.

Response

Options screener results

Screener response with results and metadata.

stocks
StockResult · object[]
required
metadata
ScreenerMetadata · object
required

Metadata about screener query execution.

source
string
default:realtime_sip

Market-data feed source label (entitlement layer): 'realtime_sip' | 'delayed' | 'byok'. Non-realtime_sip callers get 'delayed': the live overlay (VWAP/VWAP±σ/RSI/MACD + scores) is skipped and each stock's last_price is delayed to a clamped bar. Each stock also carries its own source label.