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

# Indexer REST-API

> Read-only historical and aggregated market data from the RocketChain indexer (ClickHouse).

The **indexer REST API** is a separate service from the core-chain **[REST API](/guides/public-rest-api)**. It serves **historical and aggregated** data from ClickHouse: candles, trades, order history, portfolio curves, funding events, bridge and vault events, leaderboard rankings, and instrument discovery with filters.

|                 | Core REST                                                                  | Indexer REST                                                                               |
| --------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| **Base path**   | `https://{host}`                                                           | `https://{host}/indexer`                                                                   |
| **Swagger**     | […/docs/](https://beta.rocket-cluster-1.com/docs/)                         | […/indexer/docs/](https://beta.rocket-cluster-1.com/indexer/docs/)                         |
| **OpenAPI**     | […/docs/openapi.json](https://beta.rocket-cluster-1.com/docs/openapi.json) | […/indexer/docs/openapi.json](https://beta.rocket-cluster-1.com/indexer/docs/openapi.json) |
| **Auth**        | SDK signing for writes; account in path for live state                     | **Read-only GET** — no API key on the wire                                                 |
| **Typical use** | Live instruments, positions, open orders, submit transactions              | Charts, history, portfolio PnL, leaderboard, backfills                                     |

## When to use which API

* **Live trading state** (open orders, collateral, positions, transaction submit) → core **[Private REST-API](/guides/private-rest-api)** and **[WebSocket streams](/guides/ws-private)**.
* **OHLCV candles, fill history, portfolio curves, vault history, leaderboard** → **[Indexer REST-API](/guides/indexer-rest-api)** endpoint reference.
* **Current instrument list with OI / funding snapshot** → core **GET /instruments**; **historical instrument rows** or **24h stats from the indexer** → indexer **GET /instruments** and **GET /instrument-details**.

## Hosts

See **[Environments](/guides/environments)** for beta, testnet, and devnet hosts. Indexer routes are always under the **`/indexer`** prefix on the same cluster hostname.

## OpenAPI contract

For codegen, CI, or third-party clients, use the hosted **[indexer OpenAPI](https://beta.rocket-cluster-1.com/indexer/docs/openapi.json)** (swap the host for testnet or devnet). Use **[indexer Swagger](https://beta.rocket-cluster-1.com/indexer/docs/)** to try requests interactively. The endpoint reference pages in this section mirror that contract.