> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vectrade.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Run Screener

> Run a stock screener query with custom filters for market cap, P/E ratio, sector, and more. Results are paginated.



## OpenAPI

````yaml GET /vq/screener
openapi: 3.1.0
info:
  title: VecTrade API
  version: 1.0.0
  description: |
    Financial data, AI-powered analysis, and trading intelligence.

    ## Authentication
    All requests require an API key in the `X-API-Key` header:
    ```
    X-API-Key: vq_your_key_here
    ```

    ## Rate Limits
    Response headers include rate limit info:
    - `X-VQ-RateLimit-Limit` — requests per window
    - `X-VQ-RateLimit-Remaining` — remaining requests
    - `X-VQ-RateLimit-Reset` — window reset timestamp (Unix)
  contact:
    name: VecTrade API Support
    email: api@vectrade.io
    url: https://docs.vectrade.io
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
  - url: https://api.vectrade.io/v1
    description: Production & Sandbox (mode determined by API key prefix)
security:
  - ApiKeyAuth: []
paths:
  /vq/screener:
    get:
      tags:
        - Screener
      summary: Run stock screener
      description: >-
        Run a stock screener query with custom filters for market cap, P/E
        ratio, sector, and more. Results are paginated.
      operationId: runScreener
      parameters:
        - name: market_cap_min
          in: query
          schema:
            type: number
          description: Minimum market capitalization
        - name: market_cap_max
          in: query
          schema:
            type: number
          description: Maximum market capitalization
        - name: pe_min
          in: query
          schema:
            type: number
          description: Minimum P/E ratio
        - name: pe_max
          in: query
          schema:
            type: number
          description: Maximum P/E ratio
        - name: dividend_yield_min
          in: query
          schema:
            type: number
          description: Minimum dividend yield
        - name: sector
          in: query
          schema:
            type: string
          description: Filter by sector
        - name: industry
          in: query
          schema:
            type: string
          description: Filter by industry
        - name: country
          in: query
          schema:
            type: string
            default: US
          description: Country code filter
        - name: sort_by
          in: query
          schema:
            type: string
            default: market_cap
            enum:
              - market_cap
              - pe_ratio
              - dividend_yield
              - volume
              - change_pct
          description: Sort field
        - name: sort_order
          in: query
          schema:
            type: string
            default: desc
            enum:
              - asc
              - desc
          description: Sort direction
        - name: volume_min
          in: query
          schema:
            type: integer
          description: Minimum trading volume
        - name: exchange
          in: query
          schema:
            type: string
            enum:
              - NYSE
              - NASDAQ
              - AMEX
          description: Exchange filter
        - name: cursor
          in: query
          schema:
            type: string
          description: Pagination cursor
        - name: limit
          in: query
          schema:
            type: integer
            default: 50
            maximum: 200
          description: Results per page
      responses:
        '200':
          description: Screener results (paginated)
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ScreenerResult'
                  page_info:
                    $ref: '#/components/schemas/PageInfo'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    ScreenerResult:
      type: object
      properties:
        symbol:
          type: string
        companyName:
          type: string
        price:
          type: number
        changePct:
          type: number
        marketCap:
          type: number
        peRatio:
          type: number
          nullable: true
        dividendYield:
          type: number
          nullable: true
        sector:
          type: string
        industry:
          type: string
        volume:
          type: integer
        rsi14:
          type: number
          nullable: true
    PageInfo:
      type: object
      properties:
        hasNext:
          type: boolean
        cursor:
          type: string
          nullable: true
        totalCount:
          type: integer
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - type
          properties:
            message:
              type: string
            type:
              type: string
            docs_url:
              type: string
        request_id:
          type: string
  responses:
    Unauthorized:
      description: Authentication failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ValidationError:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Rate limit exceeded
      headers:
        Retry-After:
          schema:
            type: number
        X-VQ-RateLimit-Limit:
          schema:
            type: integer
        X-VQ-RateLimit-Remaining:
          schema:
            type: integer
        X-VQ-RateLimit-Reset:
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: VecTrade API key (e.g., vq_live_...)

````