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

# Screen stocks by fundamental metrics

> Filter and sort stocks using fundamental financial metrics.



## OpenAPI

````yaml /api/openapi.json post /api/graph/v1/research/screener
openapi: 3.1.0
info:
  title: Sequency Graph API
  description: >

    # Sequency Graph-Native Trading API


    Graph-native API for trading intelligence, built on FalkorDB.


    ## Features


    - **Screener**: Filter stocks using graph-native queries with relationship
    expansion

    - **Stock Detail**: Complete stock context with all relationships

    - **Confluence Scoring**: Setup quality assessment with weighted components

    - **Strategy Matching**: Find matching options strategies via graph
    traversal

    - **Market Context**: Current market-wide context for trading decisions


    ## Data Sources


    All data is sourced from the FalkorDB knowledge graph, populated by:

    - Pattern detector (Go) - Technical indicators, patterns

    - Graph sync service - Levels, volume profiles, news, day classification
  version: 1.0.0
servers: []
security: []
paths:
  /api/graph/v1/research/screener:
    post:
      tags:
        - Research
      summary: Screen stocks by fundamental metrics
      description: Filter and sort stocks using fundamental financial metrics.
      operationId: research_screener_api_graph_v1_research_screener_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResearchScreenerRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResearchScreenerResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ResearchScreenerRequest:
      properties:
        filters:
          anyOf:
            - $ref: '#/components/schemas/ResearchScreenerFilters'
            - type: 'null'
        sort:
          anyOf:
            - $ref: '#/components/schemas/SortConfig'
            - type: 'null'
        pagination:
          anyOf:
            - $ref: '#/components/schemas/PaginationConfig'
            - type: 'null'
      type: object
      title: ResearchScreenerRequest
    ResearchScreenerResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/ResearchScreenerResult'
          type: array
          title: Results
        total_matched:
          type: integer
          title: Total Matched
        returned:
          type: integer
          title: Returned
        offset:
          type: integer
          title: Offset
        query_ms:
          type: number
          title: Query Ms
      type: object
      required:
        - results
        - total_matched
        - returned
        - offset
        - query_ms
      title: ResearchScreenerResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ResearchScreenerFilters:
      properties:
        sector:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Sector
        market_cap:
          anyOf:
            - $ref: '#/components/schemas/MetricRange'
            - type: 'null'
        pe_ratio:
          anyOf:
            - $ref: '#/components/schemas/MetricRange'
            - type: 'null'
        pb_ratio:
          anyOf:
            - $ref: '#/components/schemas/MetricRange'
            - type: 'null'
        ps_ratio:
          anyOf:
            - $ref: '#/components/schemas/MetricRange'
            - type: 'null'
        ev_ebitda:
          anyOf:
            - $ref: '#/components/schemas/MetricRange'
            - type: 'null'
        gross_margin:
          anyOf:
            - $ref: '#/components/schemas/MetricRange'
            - type: 'null'
        operating_margin:
          anyOf:
            - $ref: '#/components/schemas/MetricRange'
            - type: 'null'
        net_margin:
          anyOf:
            - $ref: '#/components/schemas/MetricRange'
            - type: 'null'
        roe:
          anyOf:
            - $ref: '#/components/schemas/MetricRange'
            - type: 'null'
        roa:
          anyOf:
            - $ref: '#/components/schemas/MetricRange'
            - type: 'null'
        debt_to_equity:
          anyOf:
            - $ref: '#/components/schemas/MetricRange'
            - type: 'null'
        current_ratio:
          anyOf:
            - $ref: '#/components/schemas/MetricRange'
            - type: 'null'
        dividend_yield:
          anyOf:
            - $ref: '#/components/schemas/MetricRange'
            - type: 'null'
        fcf_yield:
          anyOf:
            - $ref: '#/components/schemas/MetricRange'
            - type: 'null'
        earnings_yield:
          anyOf:
            - $ref: '#/components/schemas/MetricRange'
            - type: 'null'
      type: object
      title: ResearchScreenerFilters
    SortConfig:
      properties:
        field:
          type: string
          title: Field
          default: marketCap
        order:
          type: string
          title: Order
          default: desc
      type: object
      title: SortConfig
    PaginationConfig:
      properties:
        limit:
          type: integer
          title: Limit
          default: 50
        offset:
          type: integer
          title: Offset
          default: 0
      type: object
      title: PaginationConfig
    ResearchScreenerResult:
      properties:
        symbol:
          type: string
          title: Symbol
        company_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Company Name
        sector:
          anyOf:
            - type: string
            - type: 'null'
          title: Sector
        industry:
          anyOf:
            - type: string
            - type: 'null'
          title: Industry
        metrics:
          additionalProperties: true
          type: object
          title: Metrics
      type: object
      required:
        - symbol
        - metrics
      title: ResearchScreenerResult
    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
    MetricRange:
      properties:
        min:
          anyOf:
            - type: number
            - type: 'null'
          title: Min
        max:
          anyOf:
            - type: number
            - type: 'null'
          title: Max
      type: object
      title: MetricRange

````