API

Introduction

REST API for Cyberyen Explorer. Schema is loaded from /api/v1/openapi.json. Prefer the branded docs here; interactive (Swagger) is also available.

Base URL

…/api/v1

Network path parameter

Most routes are under /api/v1/{network}/.... Allowed values: mainnet, testnet (and regtest when configured). Unknown networks return 404 problem+json.

Amounts

Monetary fields are JSON strings with exactly 8 decimal places (never floats), e.g. "1.50000000".

Errors

Failures use RFC 7807 application/problem+json:

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "…"
}

Server-sent events

Live tip and mempool updates over SSE (not fully typed in OpenAPI). Events: tip ({height,hash,time}), mempool ({count,vsize}). Heartbeat comments every ~15s.

const es = new EventSource("/api/v1/mainnet/events");
es.addEventListener("tip", (e) => {
  console.log(JSON.parse(e.data));
});
es.addEventListener("mempool", (e) => {
  console.log(JSON.parse(e.data));
});