# WSO Options Data API
> REST API for US equity options chains, gamma exposure (GEX), options flow prints filtered by premium, and option contract screening.

Base URL: https://api.wheelstrategyoptions.com
OpenAPI Spec: https://api.wheelstrategyoptions.com/openapi.json
Dashboard: https://api.wheelstrategyoptions.com/dashboard

## Core Guides
- [/docs](https://api.wheelstrategyoptions.com/docs): API overview, authentication quickstart, and response headers.
- [/docs/authentication](https://api.wheelstrategyoptions.com/docs/authentication): Bearer token format (wso_live_...), 5-key quota, and security hygiene.
- [/docs/rate-limits](https://api.wheelstrategyoptions.com/docs/rate-limits): Per-minute rate limits, concurrency caps, headers, 429 handling, and clamping.
- [/docs/errors](https://api.wheelstrategyoptions.com/docs/errors): Error envelope format, error codes reference, and backoff guidance.
- [/docs/screener](https://api.wheelstrategyoptions.com/docs/screener): Option screener guide with filter operators and worked examples.
- [/docs/field-conventions](https://api.wheelstrategyoptions.com/docs/field-conventions): Field naming conventions, percent and ratio unit rules across endpoints.
- [/pricing](https://api.wheelstrategyoptions.com/pricing): the Basic plan, its price and limits.
- [/sandbox](https://api.wheelstrategyoptions.com/sandbox): Send live requests to any endpoint from the browser with your API key.

## API Reference
- [/docs/reference/health](https://api.wheelstrategyoptions.com/docs/reference/health): GET /health — Service health check probe
- [/docs/reference/ready](https://api.wheelstrategyoptions.com/docs/reference/ready): GET /ready — Dependency readiness probe
- [/docs/reference/openapi-spec](https://api.wheelstrategyoptions.com/docs/reference/openapi-spec): GET /openapi.json — OpenAPI 3.1.0 contract document
- [/docs/reference/v1-openapi-spec](https://api.wheelstrategyoptions.com/docs/reference/v1-openapi-spec): GET /v1/openapi.json — OpenAPI contract document alias
- [/docs/reference/verify-auth](https://api.wheelstrategyoptions.com/docs/reference/verify-auth): GET /v1/auth/verify — Verify credentials and entitlement
- [/docs/reference/usage](https://api.wheelstrategyoptions.com/docs/reference/usage): GET /v1/usage — Get account usage and limits
- [/docs/reference/quote](https://api.wheelstrategyoptions.com/docs/reference/quote): GET /v1/quotes/{symbol} — Get equity spot price quote
- [/docs/reference/option-quote](https://api.wheelstrategyoptions.com/docs/reference/option-quote): GET /v1/options/quotes/{optionSymbol} — Get single option contract quote
- [/docs/reference/option-quotes-batch](https://api.wheelstrategyoptions.com/docs/reference/option-quotes-batch): GET /v1/options/quotes — Batch fetch multiple option quotes
- [/docs/reference/expirations](https://api.wheelstrategyoptions.com/docs/reference/expirations): GET /v1/expirations/{symbol} — Get option expiration schedule
- [/docs/reference/chain](https://api.wheelstrategyoptions.com/docs/reference/chain): GET /v1/chain/{symbol} — Get filtered option chain matrix
- [/docs/reference/screenContracts](https://api.wheelstrategyoptions.com/docs/reference/screenContracts): POST /v1/contracts/screen — Screen option contracts with multi-factor filters
- [/docs/reference/earnings](https://api.wheelstrategyoptions.com/docs/reference/earnings): GET /v1/earnings — Get earnings calendar events
- [/docs/reference/dividends](https://api.wheelstrategyoptions.com/docs/reference/dividends): GET /v1/dividends — Get dividend ex-date calendar
- [/docs/reference/iv](https://api.wheelstrategyoptions.com/docs/reference/iv): GET /v1/iv/{symbol} — Get implied volatility context
- [/docs/reference/top-iv](https://api.wheelstrategyoptions.com/docs/reference/top-iv): GET /v1/stocks/top-iv — Get stocks with highest implied volatility
- [/docs/reference/top-ivr](https://api.wheelstrategyoptions.com/docs/reference/top-ivr): GET /v1/stocks/top-ivr — Get stocks with highest IV rank
- [/docs/reference/gex](https://api.wheelstrategyoptions.com/docs/reference/gex): GET /v1/gex/{symbol} — Get dealer gamma exposure profile
- [/docs/reference/gex-heatmap](https://api.wheelstrategyoptions.com/docs/reference/gex-heatmap): GET /v1/gex/{symbol}/heatmap — Get 2D gamma exposure heatmap matrix
- [/docs/reference/flow](https://api.wheelstrategyoptions.com/docs/reference/flow): GET /v1/flow — Get options flow trades
- [/docs/reference/flow-net](https://api.wheelstrategyoptions.com/docs/reference/flow-net): GET /v1/flow/net — Get 1-minute net flow bars and summary
- [/docs/reference/public_announcement](https://api.wheelstrategyoptions.com/docs/reference/public_announcement): GET /public/announcement — Public announcement broadcast
- [/docs/reference/public-plans](https://api.wheelstrategyoptions.com/docs/reference/public-plans): GET /public/plans — Public plans and pricing metadata