Skip to main content
The indexer REST API is a separate service from the core-chain 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.

When to use which API

  • Live trading state (open orders, collateral, positions, transaction submit) → core Private REST-API and WebSocket streams.
  • OHLCV candles, fill history, portfolio curves, vault history, leaderboardIndexer 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 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 (swap the host for testnet or devnet). Use indexer Swagger to try requests interactively. The endpoint reference pages in this section mirror that contract.