Dataexport

API-dokumentation

För dig som vill exportera data och insikter från Vården i Siffror programmatiskt. Här hittar du dokumentation och ett testverktyg för vårt export-API.

Export API

Hämta data programmatiskt från Vården i Siffror. Filtrera på indikatorer, regioner, tidsperiod och format.

REST APIJSON / CSVPaginering

POST

/api/workspace/vardenisiffror/export

indicators

Required

regions

Alla enheter (standard)

startYear / endYear

2021

→

2025

gender

Totalt

Män

Kvinnor

format

metadata

light

full

limit

Svar

Välj minst en indikator och klicka Skicka

cURL

curl "https://vardenisiffror.se/api/workspace/vardenisiffror/export?startYear=2021&endYear=2025&gender=total&format=json&limit=100"

Dokumentation

Kom igång i 3 steg

1. Hämta indikatorkatalogen

curl "/api/workspace/vardenisiffror/options" # → indicators[].apiId ger ID:n att använda nedan

2. Hämta data för valda indikatorer

curl "/api/workspace/vardenisiffror/export?indicators=<apiId>&startYear=2023&endYear=2025&limit=1000"

3. Paginera vid stora uttag

offset = 0 while true: resp = GET /export?indicators=...&limit=10000&offset={offset} process(resp.data) if not resp.meta.hasMore: break offset = resp.meta.nextOffset

Parametrar

Parameter	Typ	Beskrivning
indicatorsRequired	string	Kommaseparerade indikator-ID:n (obligatorisk)
regions	string	Enhets-ID:n (item_*) eller SKR-koder. Se /units.
startYear	integer	Startår (1990–nu)
endYear	integer	Slutår (1990–nu)
gender	string	total, male, female (kommaseparerat)
format	string	json (default) eller csv
metadata	string	light (default) eller full
limit	integer	Max poster (default 10 000, max 1 000 000)
offset	integer	Hoppa över N poster (paginering)

Svarsformat (JSON, metadata=light)

{ "meta": { "exportDate": "2024-01-15T10:30:00.000Z", "totalRecords": 150, "indicators": 3, "units": ["01", "09"], "genders": ["total", "female"], "timeRange": { "startYear": 2020, "endYear": 2024 }, "metadata": "light", "limit": 10000, "offset": 0, "hasMore": false, "nextOffset": null }, "data": [ { "measureId": "7002952f-...", "measureName": "Andel med god glykemisk kontroll", "gender": "Kvinnor", "organizationId": "item_abc123", "organizationCode": "01", "organizationName": "Region Stockholm", "organizationType": "Region", "period": "2023", "periodType": "År", "status": "", "value": 52.3, "numerator": 1234, "denominator": 2360, "confidenceIntervalLow": 50.1, "confidenceIntervalHigh": 54.5 } ] }

Kataloger

/options — Indikatorkatalog

Alla indikatorer med metadata (typ, datakälla, beskrivning, önskvärd riktning).

GET /api/workspace/vardenisiffror/options

/units — Enhetskatalog

Regioner, kommuner, sjukhus med ID och SKR-koder. Filtrera med ?type=region.

GET /api/workspace/vardenisiffror/units

Begränsningar

Max 1 000 000 poster per anrop (default 10 000)
Minst en indikator krävs
meta.hasMore + meta.nextOffset för paginering
CSV ger ~50% mindre svar än JSON
metadata=light (default) ger ~50% mindre svar än full