---
title: "Get index"
method: GET
path: "/indices/{name}"
tags: ["Indices"]
---

# Get index

`GET /indices/{name}`

## Request

- Base URL: `https://api.forum.market/v1`
- URL: `https://api.forum.market/v1/indices/{name}`
- Auth: none required

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.

## Path parameters

- `name` string, required

## Response `200`

The index.

- Index
  - `name` string, required: The index name.
  - `createdAt` string, date-time, required: When the index was created (ISO 8601, UTC).
  - `lastUpdate` string, date-time, nullable, required: When the latest value was published (ISO 8601, UTC), or null if none has been yet.
  - `currentValue` number, nullable, required: The latest published Attention Index value (after EMA smoothing), or null if none has been yet.
  - `sourceConfigs` IndexSource[], required: The sources that make up the index.
    - `name` string, required: Identifier of the source.
    - `displayName` string, required
    - `weight` number, required: The source's share of the index. Weights across an index's sources add up to 1.
    - `metrics` object[], required: The engagement metrics tracked on this source.
      - `displayName` string, required
    - `dayPercentChangeSigned` number, nullable, required
    - `weekPercentChangeSigned` number, nullable, required
    - `monthPercentChangeSigned` number, nullable, required
    - `yearPercentChangeSigned` number, nullable, required
    - `allTimePercentChangeSigned` number, nullable, required
  - `interval` integer, required: Seconds between index updates.
  - `ready` boolean, required: Whether the index has published at least one value.
  - `live` boolean, required: Whether the index is currently being updated.

## Other responses

- `404`: No index has this name.
- `429`: Too many requests from this IP address. Public endpoints allow 400 requests per minute per IP.

---

[API](https://skmtc.dev/forum/apis/forum-api.md) - [All operations](https://skmtc.dev/forum/apis/forum-api/llms.txt) - [OpenAPI document](https://skmtc.dev/forum/apis/forum-api/revisions/f6a39a5d4384?raw)