Tutorial · API quickstart
The quickstart endpoint reads the live market price layer through the API and returns a compact payload: request, endpoint links, source/freshness and the latest trading day with hourly sample.
Tutorial · API quickstart
alvo-api-quickstart, the stable payload marker.
month, market, zone and number of sample hours.
Links to /api/quickstart and /api/market/prices for the same request.
source, freshness, unit, days and latestDay.sampleHours.
Production proxy: https://alvo.energy/api. Locally, the Nest API runs on http://localhost:3004.
market=DAM, zone=IPS and hours=6 give a compact payload for the first check.
Do not build a decision when freshness says stale/unavailable or latestDay is empty.
After quickstart, move to /api/market/prices for the full monthly book.
Quickstart replies with Cache-Control: no-store so integrations see the current state.
The endpoint has a read access guard; production may require an API key or Bearer token.
The payload exposes source/freshness; do not label stale data as live.
Tutorial · API quickstart
Protected tenants add x-alvo-api-key; the open demo may answer without a key.
ALVO_API_URL="https://alvo.energy/api" curl -s "$ALVO_API_URL/quickstart?market=DAM&zone=IPS&hours=6" \ -H "x-alvo-api-key: $ALVO_API_KEY"
Minimal server-side JavaScript example with no caching.
const base = "https://alvo.energy/api";
const params = new URLSearchParams({
market: "DAM",
zone: "IPS",
hours: "6"
});
const response = await fetch(`${base}/quickstart?${params}`, {
headers: { "x-alvo-api-key": process.env.ALVO_API_KEY ?? "" },
cache: "no-store"
});
console.log(await response.json());OpenAPI describes the rest of the REST surface: prices, forecast, risk, audit and deterministic AI brief.