> For the complete documentation index, see [llms.txt](https://ogroute.gitbook.io/ogroute-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ogroute.gitbook.io/ogroute-docs/developer-guide/api.md).

# API reference

The indexer serves a read-only REST API over the folded chain data. It is public and unauthenticated — everything it exposes is already on-chain. It accepts no writes; those go directly to Soroban RPC from the user's wallet.

**Base URL:** your indexer deployment (locally `http://localhost:8080`).

> All integer amounts are serialized as **strings**, because they are `bigint` raw token units and JSON numbers cannot hold them safely. Parse with `BigInt(...)`.

## `GET /health`

```json
{ "ok": true, "lastLedger": 1284591 }
```

`lastLedger` is the last ledger the poller processed. If it stops advancing, the indexer is stuck.

## `GET /circles`

Query parameters: `status` (`Open` | `Active` | `Completed` | `Cancelled`), `limit` (default 50, max 200), `offset`.

```json
{
  "total": 12,
  "items": [
    {
      "id": 3,
      "creator": "GCJDSDNBS5PYOEKUO2PUCE2HRJ6V5IUPC4YBN65XQ4LB5EWKUQBPKHYR",
      "token": "CDLZFC3SYJYDZT7K67VZ75HPJVIEUVNIXF47ZG2FB2RMQQVU2HHGCYSC",
      "contribution": "100000000",
      "deposit": "150000000",
      "size": 3,
      "periodSecs": "604800",
      "status": "Active",
      "startedAt": "1784021895",
      "currentCycle": 1,
      "memberCount": 3
    }
  ]
}
```

## `GET /circles/:id`

The circle, its members in join order, and the full event timeline.

```json
{
  "id": 3,
  "creator": "GCJD…",
  "contribution": "100000000",
  "status": "Active",
  "currentCycle": 1,
  "members": [
    {
      "circleId": 3,
      "address": "GCJD…",
      "joinOrder": 0,
      "depositRemaining": "150000000",
      "received": true,
      "defaulted": false
    }
  ],
  "events": [
    {
      "eventId": "0001284511-0000000001",
      "kind": "payout",
      "member": "GCJD…",
      "amount": "300000000",
      "cycle": 0,
      "txHash": "9829798c24f7bb03411951fc475dd1bbb6993b7a49c2d58bdd8b7e743b1b7767",
      "ledger": 1284511,
      "timestamp": "2026-07-14T10:41:35.000Z"
    }
  ]
}
```

Returns `404` with `{ "error": "not found" }` for an unknown id.

`kind` is one of `create`, `join`, `start`, `contrib`, `slash`, `default`, `payout`, `complete`, `cancel`.

## `GET /members/:address`

Everything about one member: reputation, memberships, and recent activity.

```json
{
  "address": "GCJD…",
  "reputation": { "address": "GCJD…", "completed": 1, "defaulted": 0 },
  "memberships": [
    {
      "circleId": 3,
      "address": "GCJD…",
      "joinOrder": 0,
      "depositRemaining": "150000000",
      "received": true,
      "defaulted": false,
      "circle": { "id": 3, "status": "Active", "contribution": "100000000" }
    }
  ],
  "events": []
}
```

An address with no history returns zeroed reputation and empty arrays rather than a 404.

## `GET /stats`

```json
{
  "circles": 12,
  "active": 4,
  "completed": 7,
  "valueLocked": "1800000000",
  "paidOut": "9000000000"
}
```

`valueLocked` is the sum of all outstanding member deposits. `paidOut` is the sum of every `payout` event.

## Notes for integrators

* **The API is a convenience, not the source of truth.** For anything a user is about to act on — a circle's status, whether they have paid this cycle, the deadline — read the contract directly via the [SDK](/ogroute-docs/developer-guide/sdk.md). The indexer can lag; the chain cannot.
* **CORS is open**, so a browser client can call it directly.
* **History depth is bounded by RPC retention** (\~7 days of events) from the indexer's first run. Live state is always complete regardless.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ogroute.gitbook.io/ogroute-docs/developer-guide/api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.