---
title: "API Index"
method: GET
path: "/api/index.json"
tags: ["Discovery"]
---

# API Index

`GET /api/index.json`

Discovery endpoint with all available endpoints, capabilities, and metadata. This is the recommended starting point for API consumers - it provides a complete map of all endpoints, valid intervals (day/week/month/lifetime), character system tiers and classes, and available focus areas. Useful for building tools that need to dynamically discover API capabilities.

## Response `200`

API discovery metadata with all available endpoints and capabilities

- APIIndexResponse
  - `version` string, required
  - `baseUrl` string, uri, required
  - `documentation` string, uri, required
  - `openapi` string, uri, required
  - `endpoints` object, required
    - `leaderboard` object
      - `monthly` string, uri
      - `weekly` string, uri
      - `lifetime` string, uri
    - `profiles` object
      - `pattern` string
      - `example` string, uri
    - `summaries` object
      - `overall` object
        - `pattern` string
        - `intervals` string[]
      - `contributors` object
        - `pattern` string
        - `intervals` string[]
  - `capabilities` object, required
    - `search` object
      - `byUsername` boolean
      - `byRank` boolean
      - `byTier` boolean
      - `byFocusArea` boolean
    - `intervals` string[]
    - `characterSystem` object
      - `tiers` string[]
      - `classes` string[]
      - `focusAreas` string[]

---

[API](https://skmtc.net/elizaos/apis/hiscores-api.md) · [All operations](https://skmtc.net/elizaos/apis/hiscores-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elizaos/hiscores-api/versions/69daa3a55ca9/schema)