Equity Rank Options Screener API

openapi: 3.2.0
info:
  title: Equity Rank Com Options Screener API
  version: 0.1.0
  description: 'Operations tagged options-screener across 2 of this provider''s published API definitions: openapi.json, equity-rank-com-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: options-screener
paths:
  /api/options-screener/sectors:
    get:
      tags:
      - options-screener
      summary: Get Screener Sectors
      description: Return unique sectors present in the cached screener. Used to populate the sector filter.
      operationId: get_screener_sectors_api_options_screener_sectors_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Get Screener Sectors Api Options Screener Sectors Get
  /api/options-screener/covered-calls:
    get:
      tags:
      - options-screener
      summary: Covered Calls
      description: 'Public no-auth covered-call index (SEO-03).


        Lists undervalued underlyings (positive margin of safety) with covered-call

        income metrics: if-called return and downside protection. Premiums come from

        real option chains; when no real chain is available an ATM Black-Scholes

        estimate is used and labeled a model estimate. Reads the same cached data the

        authed options screener uses (no new query path); returns only non-gated

        public fields and is rate-limited per IP via the shared limiter.'
      operationId: covered_calls_api_options_screener_covered_calls_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/options-screener/earnings-implied-moves:
    get:
      tags:
      - options-screener
      summary: Earnings Implied Moves
      description: 'Public no-auth list: names reporting within 14 days, with the move the

        option market currently prices in, IV rank/percentile, and open-interest

        context.


        `implied_move_pct` is the ATM straddle on the first expiry at or after the

        report whenever one is quotable (`implied_move_basis == "straddle"`), and a

        7-day Black-Scholes figure off the 30-day ATM IV snapshot otherwise

        (`"iv_model"`, flagged by `implied_move_is_model_estimate`). Informational

        market data — not a forecast, recommendation, or directional view.'
      operationId: earnings_implied_moves_api_options_screener_earnings_implied_moves_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/options-screener:
    get:
      tags:
      - options-screener
      summary: Get Options Screener
      description: 'Return ranked options strategy opportunities.


        Each result includes a SAVE-score-derived directional signal, recommended

        options strategy, IV rank, IV percentile, put/call ratio, total OI,

        implied 7-day move, conviction score, margin of safety, and rationale bullets.


        When wheel_preset=true, results are filtered for the cash-secured put /

        covered-call wheel strategy: bullish/neutral direction, IV rank ≥ 40,

        earnings > 14 days out, and covered-call premium yield ≥ 1.5%/month.

        Use wheel_max_price to gate by account size (e.g. 50 for Standard, 200 for Enhanced).'
      operationId: get_options_screener_api_options_screener_get
      security:
      - HTTPBearer: []
      parameters:
      - name: direction
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'Filter by direction: bullish | bearish | neutral'
          title: Direction
        description: 'Filter by direction: bullish | bearish | neutral'
      - name: sector
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by sector name, e.g. 'Technology'
          title: Sector
        description: Filter by sector name, e.g. 'Technology'
      - name: min_iv_rank
        in: query
        required: false
        schema:
          anyOf:
          - type: number
            maximum: 100
            minimum: 0
          - type: 'null'
          description: Minimum IV rank (0-100)
          title: Min Iv Rank
        description: Minimum IV rank (0-100)
      - name: max_iv_rank
        in: query
        required: false
        schema:
          anyOf:
          - type: number
            maximum: 100
            minimum: 0
          - type: 'null'
          description: Maximum IV rank (0-100)
          title: Max Iv Rank
        description: Maximum IV rank (0-100)
      - name: earnings_within_14d
        in: query
        required: false
        schema:
          type: boolean
          description: Only show options where underlying has earnings within 14 days
          default: false
          title: Earnings Within 14D
        description: Only show options where underlying has earnings within 14 days
      - name: sort_by
        in: query
        required: false
        schema:
          type: string
          description: 'Sort field: ticker (default, A-Z) | conviction | iv_rank | save_score | implied_move | prob_of_profit'
          default: ticker
          title: Sort By
        description: 'Sort field: ticker (default, A-Z) | conviction | iv_rank | save_score | implied_move | prob_of_profit'
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Maximum results to return
          default: 30
          title: Limit
        description: Maximum results to return
      - name: force_refresh
        in: query
        required: false
        schema:
          type: boolean
          description: Bypass cache and re-fetch
          default: false
          title: Force Refresh
        description: Bypass cache and re-fetch
      - name: wheel_preset
        in: query
        required: false
        schema:
          type: boolean
          description: Filter for wheel-strategy candidates (iv_rank≥40, earnings>14d, cc_yield≥1.5%/mo)
          default: false
          title: Wheel Preset
        description: Filter for wheel-strategy candidates (iv_rank≥40, earnings>14d, cc_yield≥1.5%/mo)
      - name: wheel_max_price
        in: query
        required: false
        schema:
          anyOf:
          - type: number
            maximum: 5000
            minimum: 1
          - type: 'null'
          description: Max stock price for account-size gating (e.g. 50 or 200)
          title: Wheel Max Price
        description: Max stock price for account-size gating (e.g. 50 or 200)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Options Screener Api Options Screener Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/options-screener/rate:
    post:
      tags:
      - options-screener
      summary: Rate Option
      description: Admin-only. Upsert a good/bad rating for an options opportunity.
      operationId: rate_option_api_options_screener_rate_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RateRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Rate Option Api Options Screener Rate Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    RateRequest:
      properties:
        ticker:
          type: string
          title: Ticker
        strategy:
          type: string
          title: Strategy
        direction:
          type: string
          title: Direction
        rating:
          type: string
          title: Rating
      type: object
      required:
      - ticker
      - strategy
      - direction
      - rating
      title: RateRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- openapi.json
- equity-rank-com-openapi.yml