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

# screener

> Access screener data for /screener. Returns filtered and aggregated metrics for screening purposes.



## OpenAPI

````yaml /api-reference/openapi.json get /screener
openapi: 3.1.1
info:
  title: Alphractal API
  version: 0.3.0
  description: >-
    Alphractal API provides comprehensive cryptocurrency on-chain data including
    mining metrics, address analytics, block information, fee data, market
    indicators, supply metrics, exchange flows, and more.
servers:
  - url: https://api.alphractal.com
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /screener:
    get:
      tags:
        - Screener
      summary: screener
      description: >-
        Access screener data for /screener. Returns filtered and aggregated
        metrics for screening purposes.
      parameters:
        - name: Crypto
          in: query
          schema:
            type:
              - string
              - 'null'
          description: 'Parameter: Crypto.'
          example: example
        - name: Type
          in: query
          schema:
            type:
              - ScreenerChartType
              - 'null'
          description: 'Parameter: Type.'
        - description: >-
            Start date for filtering results (inclusive). Format: ISO 8601
            date-time.
          name: startDate
          in: query
          schema:
            format: date-time
            type: string
            nullable: true
          required: false
        - description: >-
            End date for filtering results (inclusive). Format: ISO 8601
            date-time.
          name: endDate
          in: query
          schema:
            format: date-time
            type: string
            nullable: true
          required: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    data:
                      type:
                        - object
                        - 'null'
                      additionalProperties:
                        nullable: true
                  additionalProperties: false
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        API Key authentication. Include your API key in the X-Api-Key header for
        all requests.

````