Setup
1
Get an API key
Sign up at unusualwhales.com/pricing and get your API key from the API dashboard.
2
Set environment variable
3
Start using
Options Flow
The core feature — detect unusual options activity, sweeps, and large premium prints.- Python
- CLI
Dark Pool
Institutional block trades executed off-exchange.- Python
- CLI
Congress Trades
Track stock trades disclosed by members of Congress (STOCK Act).- Python
- CLI
Insider Transactions
SEC Form 4 filings — officer, director, and 10% owner trades.- Python
- CLI
Greek Exposure & IV
Options positioning analytics — gamma exposure (GEX), delta exposure (DEX), IV rank, and term structure.- Python
- CLI
Short Interest
Short interest, short volume, and failures to deliver.- Python
- CLI
Market Sentiment
Proprietary market-wide indicators.- Python
- CLI
Screeners
Scan stocks and option chains for setups.- Python
- CLI
Calendars & Earnings
Economic events, FDA catalysts, and earnings schedules.- Python
- CLI
Additional Endpoints
Rate Limits
Rate limit headers are returned with every response:
x-uw-daily-req-count, x-uw-req-per-minute-remaining.
MCP Tools
All functions are available via theunusual_whales compound MCP tool with an action parameter:
options_flow, stock_flow, dark_pool, congress_trades, congress_trader, insider_trades, market_tide, spike, economic_calendar, fda_calendar, stock_info, stock_state, earnings, earnings_schedule, seasonality, greek_exposure, greek_exposure_by_strike, greek_exposure_by_expiry, iv_rank, vol_term_structure, max_pain, option_chains, short_interest, short_volume, ftd, screener_stocks, screener_options, etf_holdings, etf_flow, institutions, institution_holdings, institution_ownership, news, prediction_whales, prediction_unusual, crypto_whales.