API Overview & Quickstart
Welcome to the WSO Options Data API. This REST API provides US equity options chains, Greek derivations, gamma exposure (GEX), options flow prints filtered by premium, and a multi-factor option screener.
Authentication
Bearer tokens, wso_live_ key format, and security best practices.
Rate Limits
Per-minute rate limits, concurrency caps, query clamping, and response headers.
Errors & Troubleshooting
Error envelope schema, status codes, backoff guidance, and solutions.
Option Screener Guide
Filter contracts by Greeks, liquidity, yields, and volatility metrics.
Base URL
All API requests must be served over HTTPS. Non-TLS plaintext HTTP requests are refused.
Quickstart in 3 Steps
Obtain an API Key
Sign in to the API Dashboard with your WheelStrategyOptions account. In the API Keys tab, create a new secret key. Keys follow the wso_live_... format.
Execute Your First Request
Query the AAPL option chain matrix. Pass your API key in the Authorization HTTP header.
export WSO_API_KEY="wso_live_…" # your key from the dashboard
curl -s "https://api.wheelstrategyoptions.com/v1/chain/AAPL" \
-H "Authorization: Bearer $WSO_API_KEY"Inspect Rate Limit Headers
Successful responses on an active plan carry rate-limit headers, so you can track your remaining per-minute allowance and replenishment timing on every call; see Rate Limits for details. For the chain call above (your plan's limits are on the pricing page):
HTTP/2 200
content-type: application/json; charset=utf-8
x-request-id: 3f6c2a1e-8b4d-4c7a-9e2f-5d1b0a7c9e44
x-ratelimit-limit: <requests per minute on your plan>
x-ratelimit-remaining: <requests left in the current window>
x-ratelimit-reset: <seconds until your per-minute allowance is fully restored>X-RateLimit-Reset for the exact number of seconds until your per-minute allowance is fully restored.