Docs / API: Service

Service health

Returns a small health summary. It does not count against your rate limit.

GET/api/v1/health

Property	Value
Authentication	Optional. A key raises your limit.
Rate-limit cost	0 units
Status	Live

#Request

curl -s "https://farbeamlabs.com/api/v1/health"

const res = await fetch("https://farbeamlabs.com/api/v1/health");
const { data, meta, error } = await res.json();
if (error) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os, requests

res = requests.get(
    "https://farbeamlabs.com/api/v1/health",
    timeout=30,
)
body = res.json()
if "error" in body:
    raise RuntimeError(body["error"]["code"])
print(body["data"])

You can send this request now in the API playground.

#Response

This response is real. It was captured from the running API when this page was built. Arrays are cut to two items.

JSON

{
  "data": {
    "status": "ok",
    "chains_ok": 7,
    "chains_total": 7
  },
  "meta": {
    "request_id": "req_8c6d28a39bff",
    "as_of": "2026-11-04T20:10:50.206Z"
  }
}

#Fields

Field	Type	Description
`data.status`	string	`ok` while the API process is running.
`data.chains_ok`	integer	Chains whose poller is healthy now.
`data.chains_total`	integer	Chains the service polls.

PreviousAPI reference index NextStatus