Regionkoll för utvecklare

Hämta regional statistik till er webbplats, dashboard eller app, eller bädda in färdiga diagram.

Kom igång

Skapa en API-nyckel under API-nycklar i appen (kräver behörighet). Skicka den i varje anrop som Authorization: Bearer … eller X-API-Key. Nyckeln hör hemma på er server eller i er app, aldrig i en webbsida.

curl https://www.regionkoll.se/api/public/query \
  -H "Authorization: Bearer rs_xxxxxxxx_…" \
  -H "Content-Type: application/json" \
  -d '{ "indicators": ["unemployment_rate_bas_16_64"], "regions": { "ids": ["kommun:1280"], "include_comparisons": ["parent:lan", "riket"] }, "periods": { "last": 5 } }'

Anropen begränsas per organisation, per minut och per månad. Svaren har rubrikerna X-RateLimit-Limit och X-RateLimit-Remaining; över gränsen svarar API:et 429 med Retry-After.

Data följer sina licenser: ett svar ges bara om licensen för varje datakälla bakom indikatorerna tillåter API-åtkomst, annars 403. Svaret innehåller licensen.

Anrop

GET/api/public/indicators– List indicators

Published indicators the caller may see: public ones, those opened to them, and their own.

ParameterVarBeskrivning
qquerySearch in names and keys
categoryquery
authorizationheader
x-api-keyheader

GET/api/public/indicators/{key}– One indicator

ParameterVarBeskrivning
key *pathstring
authorizationheader
x-api-keyheader

GET/api/public/regions– List regions at a level

ParameterVarBeskrivning
level *querykommun, lan, la, fa, nuts1-3 or riket
editionqueryLA/FA edition, e.g. LA2023
qquery
authorizationheader
x-api-keyheader

POST/api/public/query– Values for indicators × regions × periods

The same query and answer as the web app: series per region with comparisons, indicator metadata and the data licence. Refused with 403 when the licence of any dataset behind the indicators does not allow API access.

ParameterVarBeskrivning
authorizationheader
x-api-keyheader
{
  "indicators": ["unemployment_rate_bas_16_64"],
  "regions": { "ids": ["kommun:1280"], "include_comparisons": ["parent:lan", "riket"] },
  "periods": { "last": 5 }
}

POST/api/public/embeds/{public_id}/token– Token for a private embed

For embeds published as private ("token"): your server mints a short-lived token with its API key and puts it in the page it serves, e.g. an intranet page for signed-in staff: `<rs-chart id="…" token="…">` or `/embed/c/{public_id}?token=…`. Never mint tokens in the browser: the API key must stay on your server.

ParameterVarBeskrivning
public_id *pathstring
authorizationheader
x-api-keyheader

OpenAPI-specifikation (JSON)

Bädda in diagram

Publicera ett diagram med ”Bädda in” i Utforska och klistra in koden. Diagrammet följer senaste data, har läsarens filter och en tabell för skärmläsare, och anpassar sin höjd.

<script src="https://www.regionkoll.se/embed.js" async></script>
<rs-chart id="PUBLIC_ID" lang="sv"></rs-chart>

Utseendet styrs med CSS-variabler på elementet: --rs-accent (diagrammets första färg), --rs-border, --rs-radius och --rs-min-height.

Privata inbäddningar (t.ex. på ett intranät) visas bara med en token. Er server hämtar den med API-nyckeln, högst en timme i taget:

curl -X POST https://www.regionkoll.se/api/public/embeds/PUBLIC_ID/token \
  -H "Authorization: Bearer rs_xxxxxxxx_…" -H "Content-Type: application/json" \
  -d '{"ttl_seconds": 900}'
# → {"token": "…", "expires_at": 1790000000, "url": "https://www.regionkoll.se/embed/c/PUBLIC_ID?token=…"}

<rs-chart id="PUBLIC_ID" token="TOKEN"></rs-chart>

Redo att se er region i ett nytt ljus?

Välj en plan och ansök om ett konto, eller prova plattformen gratis i 14 dagar. Har ni redan ett konto? Logga in högst upp.