Skip to content
Epic Cash Status

API

Routes

10 of them · v1 · no key
GET

/api/v1/status.json

everything

The whole board: network summary, then every node, relay and pool.

chain=floonet
The test network instead of mainnet. One chain per document.
Network summary
curl -s https://status.btlabs.uk/api/v1/status.json \
  | python3 -c 'import sys,json; print(json.load(sys.stdin)["network"])'
Returns
{
  "meta": { "describes": ..., "states": ..., "absent": [...] },
  "generated_at": "2026-09-22T18:10:14Z",
  "stale": false,
  "prober":  { "id": ..., "region": ..., "measures": ... },
  "network": { "tip_height": ..., "health_score": ..., ... },
  "nodes":   [ ... ],
  "epicbox": [ ... ],
  "pools":   [ ... ]
}

Endpoint URLs, for a wallet config or a failover list.

healthy=true
Only nodes answering and at the tip.
chain=floonet
The test network instead of mainnet.
Endpoints you can point a wallet at
curl -s 'https://status.btlabs.uk/api/v1/nodes.json?healthy=true'
Returns
{
  "meta": {
    "describes": "Epic Cash mainnet public node endpoints",
    "filtered": "healthy",
    "count": 3,
    "total_monitored": 3,
    "refreshed_every_s": 5.0,
    "measured_from": "btlabs-lon",
    "docs": "https://status.btlabs.uk/api"
  },
  "generated_at": "2026-09-22T18:10:14Z",
  "chain": "mainnet",
  "tip_height": 3721882,
  "nodes": ["https://node.btlabs.uk", ...]
}

Relay hosts, same shape.

healthy=true
Only relays that completed a handshake.
chain=floonet
The test network instead of mainnet.
Relays reachable now
curl -s 'https://status.btlabs.uk/api/v1/epicbox.json?healthy=true'
Returns
{
  "meta": { "describes": "Epicbox relay hosts, ...", "filtered": "healthy", ... },
  "generated_at": "2026-09-22T18:10:14Z",
  "epicbox": ["epicbox.epiccash.com", ...]
}

Pool hosts, same shape.

healthy=true
Only pools returning valid stats.
chain=floonet
The test network instead of mainnet.
Pools answering
curl -s 'https://status.btlabs.uk/api/v1/pools.json?healthy=true'
Returns
{
  "meta": { "describes": "Mining pools whose stats API answered", ... },
  "generated_at": "2026-09-22T18:10:14Z",
  "pools": ["epicmine.io", ...]
}

A server's icon, as linked from its `icon` in status.json: a square PNG, 128 or 256 px, named by its content hash and cached for a year. Only approved icons are served. `icon: null` means none: show the initials.

Every node that has an icon
curl -s https://status.btlabs.uk/api/v1/status.json \
  | python3 -c 'import sys,json; [print(n["id"], n["icon"]["url"]) for n in json.load(sys.stdin)["nodes"] if n["icon"]]'
Returns
"icon": {
  "url": "https://status.btlabs.uk/api/v1/icons/3f9c0a6d1b2e4c5f7a8b-256.png",
  "urls": { "128": ".../3f9c0a6d1b2e4c5f7a8b-128.png", "256": "..." },
  "hash": "3f9c0a6d1b2e4c5f7a8b",
  "updated_at": "2026-10-24T15:40:00Z"
}
GET

/api/v1/events.json

incidents

The incident log: outages, reorgs, forks, stalls and certificates close to expiry. One entry per source per 24 hours, with repeats counted in `occurrences`; `ended_at` is null while the latest one lasts.

min=warn
Drop routine one-block reorgs and notices.
limit=50
Up to 200, newest first.
chain=floonet
The test network instead of mainnet.
What is still going on
curl -s 'https://status.btlabs.uk/api/v1/events.json?min=warn' \
  | python3 -c 'import sys,json; [print(e["kind"], e["subject"]) for e in json.load(sys.stdin)["events"] if e["ended_at"] is None]'
Returns
{
  "chain": "mainnet",
  "min_severity": "warn",
  "events": [{
    "kind": "down", "severity": "warn",
    "subject": "node.example.org:3413", "detail": "timed out",
    "started_at": "2026-09-29T20:14:05Z", "ended_at": null, ...
  }]
}
GET

/feed.atom

subscribe

The same log as Atom, for a feed reader or a feed-to-chat bot. An incident is one entry, updated in place when it resolves.

min=info
Include one-block reorgs and notices.
chain=floonet
The test network instead of mainnet.
Newest entry
curl -s https://status.btlabs.uk/feed.atom | grep -m1 '<title>Down'
Returns
<title>Down — node.example.org:3413</title>
GET

/badge/{id}.svg

embed

An SVG badge with a target's state and 30-day uptime, for a README. Drawn here, so embedding it discloses readers to nobody else.

kind=epicbox
When a node and a relay share an id.
label=my node
Replace the left-hand text.
Markdown
![status](https://status.btlabs.uk/badge/node.epiccash.com.svg)
Returns
epic node | healthy · 99.97%
GET

/api/v1/health

this service

Liveness of this monitor, not of Epic Cash. 503 when the snapshot is stale. Point alerting here, not at the board.

Exit status is what matters
curl -sf https://status.btlabs.uk/api/v1/health > /dev/null || echo down
Returns
200
{
  "service": "epic-status",
  "version": "0.1.0",
  "prober_id": "btlabs-lon",
  "has_data": true,
  "stale": false,
  "generated_at": "2026-09-22T18:16:27Z"
}
POST

/api/v1/submit

open

Request a server. Checked automatically, then reviewed before it appears.

kind
node, epicbox or pool.
host
Hostname, with a port if it is not the default.
operator
Optional. Who runs it.
icon
Optional file, as multipart/form-data. PNG, JPEG or WebP, up to 1 MB and 2048 px, not animated; no SVG. Re-encoded here and shown only once approved.
Submit a node, with an icon
curl -X POST https://status.btlabs.uk/api/v1/submit \
  -F kind=node \
  -F host=node.example.org:3413 \
  -F operator="Example Pool" \
  -F icon=@logo.png
Returns
202
{
  "ok": true,
  "message": "example.org:3413 received. It will be checked 3 times...",
  "next": {
    "review_required": true,
    "probed_automatically": true,
    "checks_required": 3,
    "check_interval_s": 60.0,
    "then": "reviewed by an operator before it appears on the board"
  }
}

Caching

Send the ETag back; an unchanged snapshot returns 304
etag=$(curl -sI https://status.btlabs.uk/api/v1/status.json | grep -i ^etag | cut -d' ' -f2)
curl -s -o /dev/null -w '%{http_code}\n' \
  -H "if-none-match: $etag" https://status.btlabs.uk/api/v1/status.json
304

openapi.json · source · run your own instance