Python function:
screenOptions()Product Overview
Overview
The Options Screener allows you to discover and filter option contracts for any underlying ticker. Given one or more underlying symbols, it returns all available option contracts with their Greeks, implied volatility, volume, and open interest — optionally filtered by contract type, days to expiry, strike range, expiry date range, and Greek/IV thresholds. The screener supports two modes:- Historical: Screen contracts as they existed on a specific past trading date.
- Live: Screen today’s available contracts (falls back to the previous trading day if today’s data is not yet published).
Data Pipeline
Historical Screening
Historical option chain data is sourced from archived daily snapshots:- Daily chain snapshots: Each trading day, a snapshot of all active option contracts is captured with Greeks, IV, volume, and open interest.
- Smoothed Greeks: Greeks and implied volatilities come from the same Smooth Market Value (SMV) pipeline described in the Options Greeks & Implied Volatility reference — ensuring consistent, non-arbitrageable values.
Live Screening
Live screening queries real-time option chain data:- Real-time chain: The current option chain is fetched from the live market data feed, including real-time Greeks computed from the latest 1-minute snapshots.
- Pagination: For underlyings with large option chains (thousands of strikes × multiple expirations), results are paginated and assembled automatically.
Coverage
- Underlying symbols: 5,000+ U.S. equities and ETFs with listed options.
- Contract types: Calls, puts, or both.
- Expirations: All standard and weekly expirations.
- History: Daily snapshots available for historical screening.
Supported Modes
Querying the Data
Basic Usage
Parameters
Column Definitions
Screen Options Schema
Typical Workflow
The options screener is typically the first step in an options analysis workflow:- Screen: Use
screenOptionsto discover available contracts matching your criteria. - Quote: Pass the resulting symbols to
getOptionsQuotesfor detailed quote data with full Greeks. - Analyze: Use the quote data for pricing analysis, strategy construction, or risk management.