Tutorial · API quickstart
GET /api/health returns aggregate service and freshness status without sign-in. It does not return market prices or forecasts. Market data through the API works in a signed-in browser session; there are no separate keys for external clients yet.
Overall state: operational, degraded, or outage.
Aggregate state for the workspace, API, market data, and decision support.
Status of source groups, not prices or hourly observations.
When this public status was assembled.
Public URL: https://alvo.energy/api/health.
Run the curl command or the fetch example on an Alvo page.
Check state and services; an outage may produce HTTP 503.
Sign in for market data.
/api/health returns no prices, forecasts, or tradable signals.
Public status needs no session or API key; this is not a market-data request.
curl -i https://alvo.energy/api/health
Run this JavaScript on an Alvo page, on the same origin.
// Run on an Alvo page in your browser.
const response = await fetch("/api/health", { cache: "no-store" });
const status = await response.json();
console.log(response.status, status.state, status.services);The developer page explains signed-in access, OpenAPI, and the integration boundary.