> ## 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.

# crypto-index

> Access screener data for /spot/crypto-index. Returns filtered and aggregated metrics for screening purposes.



## OpenAPI

````yaml /api-reference/openapi.json get /spot/crypto-index
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:
  /spot/crypto-index:
    get:
      tags:
        - Screener
      summary: crypto-index
      description: >-
        Access screener data for /spot/crypto-index. Returns filtered and
        aggregated metrics for screening purposes.
      parameters:
        - name: categories
          in: query
          schema:
            type:
              - string
              - 'null'
        - name: symbols
          in: query
          schema:
            type:
              - string
              - 'null'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CryptoIndexResponse'
components:
  schemas:
    CryptoIndexResponse:
      type: object
      properties:
        market:
          type:
            - string
            - 'null'
        exchange:
          type:
            - string
            - 'null'
        categories:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/CryptoIndexCategorySummary'
      additionalProperties: false
    CryptoIndexCategorySummary:
      type: object
      properties:
        name:
          type:
            - string
            - 'null'
        basketSize:
          type: integer
          format: int32
        matchedCoins:
          type: integer
          format: int32
        coins:
          type:
            - array
            - 'null'
          items:
            type: string
        avgPrice24h:
          type: number
          format: double
        avgPrice1w:
          type: number
          format: double
        avgPrice30d:
          type: number
          format: double
        avgRsi1h:
          type: number
          format: double
        avgRsi4h:
          type: number
          format: double
        avgRsi24h:
          type: number
          format: double
        avgOi24h:
          type: number
          format: double
        totalOi:
          type: number
          format: double
        avgOiMarketCap:
          type: number
          format: double
        avgFunding:
          type: number
          format: double
        avgLsr:
          type: number
          format: double
        totalVolume:
          type: number
          format: double
        totalLiq24h:
          type: number
          format: double
        avgSentiment:
          type: number
          format: double
        strength:
          type: number
          format: double
      additionalProperties: false
  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.

````