Complete documentation and validation for all 109 endpoints of the Unusual Whales API.
Last Updated: 2025-10-22 API Version: Latest Documentation Status: ✅ Complete (109/109 endpoints)
- API Base URL:
https://api.unusualwhales.com - Authentication
- Getting Started
- All Endpoints by Category
- OpenAPI Specification
This repository contains comprehensive documentation for all Unusual Whales API endpoints, including:
- ✅ 109 Fully Documented Endpoints
- ✅ 20 Categories of market data
- ✅ Real API Testing with validated responses
- ✅ Code Examples in cURL, Python, and JavaScript
- ✅ Complete Request/Response Schemas
- ✅ Error Handling Documentation
This documentation does not contain any API keys or credentials.
All example code uses placeholder YOUR_API_KEY - you must replace this with your own API key from Unusual Whales.
Never commit API keys to version control. Use environment variables or secure credential management.
https://api.unusualwhales.com
All endpoints require API key authentication using Bearer token:
Authorization: Bearer YOUR_API_KEYcurl -X GET "https://api.unusualwhales.com/api/stock/AAPL/info" \
-H "Authorization: Bearer YOUR_API_KEY"- Get Your API Key: Sign up at Unusual Whales
- Choose an Endpoint: Browse categories below
- Review Documentation: Each endpoint has detailed docs with examples
- Test the API: Use provided code examples
- Build Your Integration: Integrate with your application
Market-wide indicators, correlations, economic calendar, and sector statistics.
- Market Tide & Sector Tide
- Economic Calendar & FDA Calendar
- Correlations & Spike Index
- Top Net Impact & Options Volume
- Insider Buy/Sells & OI Change
Comprehensive stock and options data including greeks, flow, volatility, and technical indicators.
- Greek Exposure & Flow (7 endpoints)
- Options Flow & Alerts (5 endpoints)
- Open Interest Analysis (3 endpoints)
- Volatility Metrics (6 endpoints)
- Stock Information & State (8 endpoints)
- Options Chains & Contracts (5 endpoints)
- Technical Indicators (7 endpoints)
Configure and retrieve user alerts for market events and trading signals.
Track congressional trading activity and stock transactions by members of Congress.
Access darkpool trading data and recent darkpool transactions.
Earnings calendar data including premarket and afterhours reports.
ETF holdings, exposure, flows, and sector weights.
Options greek flow grouped by various criteria.
Monitor insider trading activity by sector, ticker, and transactions.
Institutional holdings, activity, and 13F filings.
View Institution Endpoints → | View Institutions List →
Net premium flow analysis by expiration and moneyness.
Financial news headlines and market-moving events.
Detailed option contract data including flow, historical data, and volume profiles.
View Option Contract Endpoints →
Options flow alerts and full tape data.
View Option Trades Endpoints →
Track politician stock portfolios (Enterprise tier required).
View Politician Portfolio Endpoints →
Powerful screening tools for stocks, options, and analyst ratings.
Seasonal performance patterns for stocks and markets.
Short interest, failures to deliver, volume, and exchange data.
Real-time streaming data for prices, flow alerts, news, and GEX.
unusual-whales-documentation/
├── README.md # This file
├── openapi-spec.yaml # OpenAPI specification
├── ENDPOINT_TEMPLATE.md # Template used for all docs
├── MASTER_INDEX.md # Detailed endpoint index
├── docs/ # All endpoint documentation
│ ├── alerts/
│ │ ├── README.md
│ │ ├── get-alerts.md
│ │ └── alert-configurations.md
│ ├── stock/
│ │ ├── README.md
│ │ └── [41 endpoint files]
│ └── [18 more categories...]
└── [supporting files]
All endpoints have been tested with real API calls:
| Category | Endpoints | Success Rate |
|---|---|---|
| Alerts | 2 | 100% |
| Congress | 3 | 100% |
| Darkpool | 2 | 100% |
| Earnings | 3 | 100% |
| ETFs | 5 | 100% |
| Group Flow | 2 | Documented |
| Insider | 4 | 100% |
| Institution | 4 | Documented |
| Institutions | 2 | 100% |
| Market | 12 | 100% |
| Net Flow | 1 | 100% |
| News | 1 | 100% |
| Option Contract | 4 | 100% |
| Option Trades | 2 | 100% |
| Politician Portfolios | 3 | Enterprise Required |
| Screener | 3 | 100% |
| Seasonality | 4 | 100% |
| Shorts | 5 | 100% |
| Socket | 6 | 100% |
| Stock | 41 | 97.6% |
| TOTAL | 109 | ~98% |
Standard API rate limits apply. Specific limits may vary by subscription tier:
- Free tier: Limited requests per minute
- Premium tier: Higher rate limits
- Enterprise tier: Highest rate limits + exclusive endpoints
See individual endpoint documentation for specific details.
- Documentation Issues: Open an issue
- API Support: Contact Unusual Whales support
- Official Docs: https://docs.unusualwhales.com
This documentation was generated through comprehensive API testing and validation. To contribute:
- Test endpoints with real API calls
- Follow the ENDPOINT_TEMPLATE.md structure
- Include real response examples
- Document all parameters and errors
- Submit updates with validation results
This documentation is for educational and development purposes. API access requires an Unusual Whales subscription.
- API Provider: Unusual Whales
- Documentation Generated: 2025-10-22
- Total Endpoints Documented: 109
- Categories Covered: 20
- Code Examples: 300+ (cURL, Python, JavaScript)
Ready to get started? Choose a category above and explore the endpoints!