REST route index

The indexer exposes 36 REST routes. The pages under Mobile REST API, Faucet and Block Endorsements document the ones an app integration needs in depth; this page is the complete inventory, so nothing is invisible just because it has no page yet. Base URL: https://api.54-237-170-237.sslip.io

Routes marked ▸ have a dedicated reference page. The rest are listed with the source file and line that defines them — read there before depending on one, since an undocumented route carries no stability promise.

Mobile

Method	Route	What it does	Source
POST	▸ `/api/mobile/register`	Register a device against an address	`mobile.ts`
POST	▸ `/api/mobile/heartbeat`	Periodic device liveness + battery/link	`mobile.ts`
POST	▸ `/api/mobile/engagement`	Submit one engagement action	`mobile.ts`
POST	`/api/mobile/engagement-batch`	Up to 50 actions in one call — use this for bulk and load, not a loop over the single endpoint	`mobile.ts`
POST	▸ `/api/mobile/engagement-onbehalf`	Server-signed action for another address	`mobile.ts`
POST	▸ `/api/mobile/claim`	Gasless claim of pending YCR (testnet path)	`mobile.ts`
GET	▸ `/api/mobile/profile/:address`	Engagement score, balances, rank	`mobile.ts`
GET	▸ `/api/mobile/rewards/:address`	Pending (unclaimed) YCR	`mobile.ts`
GET	▸ `/api/mobile/actions/:address`	Recorded actions for an address	`mobile.ts`
GET	▸ `/api/mobile/leaderboard`	Top addresses by engagement	`mobile.ts`
GET	▸ `/api/mobile/chain/status`	Height, block time, validator count	`mobile.ts`

Device fleet

Method	Route	What it does	Source
GET	`/api/devices/aggregate`	Fleet totals; a device counts as online if it was seen in the last 300 s	`mobile.ts:1076`
GET	`/api/devices/active`	Individual devices seen in that window (`?limit=`, max 500, default 100)	`mobile.ts:1136`
GET	`/api/recent-engagements`	Latest engagements across the network (`?limit=`, max 50, default 15)	`mobile.ts:996`

A device only appears here after it calls /api/mobile/register; without that the fleet reads zero no matter how much engagement arrives.

Rollup (optimistic engagement aggregator)

Method	Route	What it does	Source
POST	`/api/rollup/engagement`	Submit an action into the rollup batch instead of a direct tx	`sequencer.ts:577`
GET	`/api/rollup/status`	Sequencer readiness + on-chain state root, pending and finalized batch ids	`sequencer.ts:604`
GET	`/api/rollup/batch/:id`	One batch by id	`sequencer.ts:638`
GET	`/api/rollup/leaf/:address`	The address’s leaf in the rollup tree (`404` if it has none)	`sequencer.ts:670`
GET	`/api/rollup/exit/:address`	Merkle proof for a forced exit	`sequencer.ts:689`

Every rollup route answers 503 ROLLUP_DISABLED when the sequencer is not running. The sequencer connects to the node at boot; if it starts before the node is reachable it retries with backoff. After any cluster restart, confirm ready: true at /api/rollup/status before assuming the rollup path works.

Light client attestations

Method	Route	What it does	Source
POST	`/api/light/attestation`	A device submits a signed checkpoint attestation	`lightAttestations.ts`
GET	`/api/light/attestations`	Recent attestation epochs	`lightAttestations.ts:228`
GET	`/api/light/attestations/:epoch`	Attestations for one epoch	`lightAttestations.ts:203`

This is the path where a phone verifies the chain instead of trusting it — see Run a node and the yc-light crate.

Explorer / chain data

Method	Route	What it does	Source
GET	`/api/stats`	Chain height, tx count, aggregate stats	`api.ts:78`
GET	`/api/blocks`	Recent blocks	`api.ts`
GET	`/api/blocks/:numberOrHash`	One block	`api.ts`
GET	`/api/transactions`	Recent transactions	`api.ts`
GET	`/api/transactions/:hash`	One transaction	`api.ts`
GET	`/api/addresses/:address`	Address summary	`api.ts`
GET	`/api/validators`	Validator set as the indexer sees it	`api.ts`
GET	`/api/search?q=`	Block, tx or address by query (`400` without `q`)	`api.ts:240`

Faucet

Method	Route	What it does	Source
POST	▸ `/api/faucet`	Drip native YCE + tokens to an address	`faucet.ts`
GET	`/api/faucet/status/:address`	Cooldown / eligibility for that address	`faucet.ts`

Block endorsements

Method	Route	What it does	Source
POST	▸ `/api/validator-attest`	A device signs a block header	`attestations.ts`
GET	`/api/validator-attest/me/:address`	That address’s endorsement record	`attestations.ts`
GET	`/api/validator-attest/recent`	Recent endorsements	`attestations.ts`
GET	`/api/validator-attest/leaderboard`	Top endorsers	`attestations.ts`
GET	`/api/validator-attest/stats`	Endorsement totals	`attestations.ts`

Error shape

Every route returns errors in the same envelope, so a client can branch on code rather than parsing prose:

{ "error": { "code": "BAD_REQUEST", "message": "Invalid address" } }

Codes you will meet in practice: BAD_REQUEST (400), NOT_FOUND (404), ROLLUP_DISABLED (503), INVALID_EPOCH (400).

API Reference

JSON-RPC (Ethereum-compatible)

Mobile REST API

Faucet

Block Endorsements

Mobile

Device fleet

Rollup (optimistic engagement aggregator)

Light client attestations

Explorer / chain data

Faucet

Block endorsements

Error shape

​Mobile

​Device fleet

​Rollup (optimistic engagement aggregator)

​Light client attestations

​Explorer / chain data

​Faucet

​Block endorsements

​Error shape

Mobile

Device fleet

Rollup (optimistic engagement aggregator)

Light client attestations

Explorer / chain data

Faucet

Block endorsements

Error shape