zkzkHeliosDocs

REST API

Read endpoints exposed by the zkHelios indexer for proofs, transactions, and stats.

The API is auto-documented from the backend's OpenAPI spec (Sessions 7–10). The endpoints below are the stable contract the dApp consumes today.

Stats

  • GET /api/stats/overview — tps, slot, epoch, totalProofs, proofs24h, …
  • GET /api/stats/timeseries?metric=proofs&period=24h|7d|30d
  • GET /api/stats/leaderboard?period=24h

Proofs & transactions

  • GET /api/proofs?authority&type&cursor
  • GET /api/proofs/:proofAccount
  • GET /api/transactions?pubkey&type&status&cursor
  • GET /api/transactions/:signature

WebSocket

ts
const ws = new WebSocket("wss://api.zkhelios.app/ws");
ws.send(JSON.stringify({ type: "subscribe", channel: "stats" }));
// channels: stats, proofs, proofs:circuit:{id}, user:notifications,
//           user:proofs, address:{pubkey}:txs
PreviousProgram referenceNextCircuits