API Documentation

Authentication

All API requests require an API key passed via the X-API-Key header. Generate a key from your Account page.

Base URL

Endpoints

Strategies

Pass one of the following strategy codes as the strategy parameter.

Parameters

All parameters are passed as query string parameters. Only strategy is required.

Response

All successful responses return a JSON envelope with paginated results. The response is gzip-compressed.

{
  "success": true,
  "data": [
    {
      "ticker": "AAPL",
      "score": 92.5,
      "strike": 195,
      "stock_price": 198.50,
      "delta": 0.30,
      "days_to_expiration": 21,
      "implied_volatility": 0.28,
      "annualized_return": 18.4,
      "volume": 1250,
      "open_interest": 8400,
      "market_cap": 3050000000000,
      "sector": "Technology",
      "industry": "Consumer Electronics",
      ...
    },
    ...
  ],
  "total": 1842,
  "page": 1,
  "page_size": 25
}

Code Examples

Call the REST API directly from any language. All examples fetch covered calls sorted by score.

curl --compressed \
  -H "X-API-Key: optionscreener_live_YOUR_KEY" \
  "https://option-screener.com/api/getOptionsData?strategy=CC&min_score=80&order_by=score&order_direction=desc&page=1&page_size=25"

Error Codes

Error responses return a JSON object with success: false and an error message.

{ "success": false, "error": "Invalid or missing API key" }