DocsAPI ReferenceWheelScreener

Screener

The full QuantWheel screener over HTTPS: strategies, derived option filters, company financials and technicals.

Run a screen

POST/screener

Derived data only

The public screener excludes quote-level data by design: responses carry no bid/ask, IV, or greeks, and minIv/minBid-style filters are rejected with a 400. Rank with the derived scores (rating, wapr, riskOfAssignment) and confirm live pricing at your broker.

curl -X POST "https://quantwheel.com/api/v1/screener" \
  -H "Authorization: Bearer qw_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "strategies": ["Cash Secured Put"],
    "minDays": 21,
    "maxDays": 45,
    "minYearly": 20,
    "maxRisk": 0.3,
    "minOi": 100,
    "includesEarnings": "no",
    "sortBy": "rating",
    "limit": 10
  }'

Response

200 OK

{
  "options": [
    {
      "underlyingTicker": "AMD",
      "strategy": "Cash Secured Put",
      "strikePrice": 165,
      "expirationDate": "2026-08-28",
      "daysToExpire": 29,
      "stockPrice": 172.4,
      "yield": 0.62,
      "ypw": 0.31,
      "wapr": 23.8,
      "rating": 87,
      "riskOfAssignment": 0.21,
      "openInterest": 1250,
      "diff": 4.2,
      "includesEarnings": false,
      "marketCap": 278000000000,
      "zScore": 6.1,
      "fScore": 7
    }
  ],
  "count": 64,
  "pagination": {
    "currentPage": 1,
    "itemsPerPage": 10,
    "totalItems": 64,
    "totalPages": 7
  }
}

Available filters

Filter	Type	Description
tickers	string[]	Restrict to specific symbols. Empty = all US equities.
strategies	string[]	Any of `Cash Secured Put`, `Covered Calls`, `Buy Write`, `Long Call`, `Long Put`.
minDays / maxDays	number	Days to expiration window.
minYield / maxYield	number	Weekly yield %.
minYearly / maxYearly	number	Annualized return % (WAPR).
minRating / maxRating	number	QuantWheel rating (0-150).
minRisk / maxRisk	number	Assignment risk (0-1).
minStrike / maxStrike, minDiff / maxDiff	number	Strike bounds and % distance to spot.
minOi	number	Minimum open interest (liquidity).
includesEarnings	string	`no` excludes contracts spanning earnings; `yes` only those that do.
minMarketCap, minZScore, minFScore, minPeRatio, minRoic, minPeg, minEpsGrowth (+max)	number	Company financial filters.
minRsi, rsiTrend, sma20Trend, sma50Trend, minEm30, minSkew25, minMomentum, minSentiment (+max)	mixed	Technical filters; add `showTechnicals: true` to include the values per row.
sortBy / sortDirection	string	`rating`, `yield`, `wapr`, `riskOfAssignment`, `daysToExpire`, ...
limit / page / groupByTicker	mixed	Pagination (limit 1-100, default 50) and best-contract-per-ticker collapsing.

Journal

Optimal Roll