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

# Get index

> Returns an Attention Index's latest value and the sources that make it up, with each source's weight, the metrics it tracks and how its score has changed.



## OpenAPI

````yaml /openapi.yaml get /indices/{name}
openapi: 3.1.0
info:
  title: Forum API
  version: '1.0'
  description: Public, read-only access to Attention Index data.
  contact:
    name: Forum Support
    email: contact@forum.market
    url: https://forum.market
servers:
  - url: https://api.forum.market/v1
    description: Production
security: []
tags:
  - name: Indices
    description: Attention Index data.
paths:
  /indices/{name}:
    get:
      tags:
        - Indices
      summary: Get index
      description: >-
        Returns an Attention Index's latest value and the sources that make it
        up, with each source's weight, the metrics it tracks and how its score
        has changed.
      operationId: getIndex
      parameters:
        - $ref: '#/components/parameters/IndexName'
      responses:
        '200':
          description: The index.
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Index'
        '404':
          description: No index has this name.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: NOT_FOUND
                  message: Index not found
        '429':
          $ref: '#/components/responses/RateLimited'
      security: []
components:
  parameters:
    IndexName:
      name: name
      in: path
      required: true
      schema:
        type: string
      description: >-
        The index name, which is the index’s ticker followed by `-IDX`. `GET
        /indices` returns every name.
      example: FORTNITE-IDX
  headers:
    X-RateLimit-Limit:
      description: Requests allowed per minute from this IP address.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests remaining in the current window.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Unix time (seconds) when the oldest request in the window expires.
      schema:
        type: integer
  schemas:
    Index:
      type: object
      required:
        - name
        - createdAt
        - lastUpdate
        - currentValue
        - sourceConfigs
        - interval
        - ready
        - live
      properties:
        name:
          type: string
          description: The index name.
          example: FORTNITE-IDX
        createdAt:
          type: string
          format: date-time
          description: When the index was created (ISO 8601, UTC).
          example: '2026-02-19T07:31:25.840Z'
        lastUpdate:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When the latest value was published (ISO 8601, UTC), or null if none
            has been yet.
          example: '2026-10-23T00:03:00.091Z'
        currentValue:
          type:
            - number
            - 'null'
          description: >-
            The latest published Attention Index value (after EMA smoothing), or
            null if none has been yet.
          example: 56.49316952023987
        sourceConfigs:
          type: array
          description: The sources that make up the index.
          items:
            $ref: '#/components/schemas/IndexSource'
        interval:
          type: integer
          description: Seconds between index updates.
          example: 900
        ready:
          type: boolean
          description: Whether the index has published at least one value.
          example: true
        live:
          type: boolean
          description: Whether the index is currently being updated.
          example: true
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: INVALID_PARAMETER
            message:
              type: string
            details:
              type: object
              additionalProperties: true
    IndexSource:
      type: object
      required:
        - name
        - displayName
        - weight
        - metrics
        - dayPercentChangeSigned
        - weekPercentChangeSigned
        - monthPercentChangeSigned
        - yearPercentChangeSigned
        - allTimePercentChangeSigned
      description: >
        A source of engagement data. The `*PercentChangeSigned` fields compare
        the source's latest score with its score that long ago, as a signed
        fraction: `0.05` is a 5% rise and `-0.05` a 5% fall. They are null when
        there is no earlier score to compare with.
      properties:
        name:
          type: string
          description: Identifier of the source.
          example: youtube
        displayName:
          type: string
          example: YouTube
        weight:
          type: number
          minimum: 0
          maximum: 1
          description: >-
            The source's share of the index. Weights across an index's sources
            add up to 1.
          example: 0.28
        metrics:
          type: array
          description: The engagement metrics tracked on this source.
          items:
            type: object
            required:
              - displayName
            properties:
              displayName:
                type: string
                example: views
        dayPercentChangeSigned:
          type:
            - number
            - 'null'
          example: -0.06600241738463546
        weekPercentChangeSigned:
          type:
            - number
            - 'null'
          example: -0.006974672947391339
        monthPercentChangeSigned:
          type:
            - number
            - 'null'
          example: 0.007944788333089727
        yearPercentChangeSigned:
          type:
            - number
            - 'null'
          example: 0.02636748709447335
        allTimePercentChangeSigned:
          type:
            - number
            - 'null'
          example: 0.016051085659686215
  responses:
    RateLimited:
      description: >-
        Too many requests from this IP address. Public endpoints allow 400
        requests per minute per IP.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: RATE_LIMIT_EXCEEDED
              message: Rate limit exceeded. Retry after 12 seconds
              details:
                retryAfter: 12

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.