API

API för att läsa nyckeltal

Det är möjligt att hämta data för Koladas alla nyckeltal automatiserat till en egen hemsida, en applikation eller en databas. Detta görs genom anrop mot ett s.k. API (Application Programming Interface). På den här sidan beskrivs hur anropen till Koladas API konstrueras och används. Sidan är i huvudsak riktad till användare som sedan tidigare har erfarenhet att jobba med API:er.

Vi är tacksamma för synpunkter och förslag på hur vårt API kan utvecklas vidare, via mail till: rka@rka.nu.

Användarvillkor

Utnyttjande av data från Koladas API är avgiftsfritt och kräver inget avtal.
Om du använder data från Kolada i en tjänst, ska källan anges ('Källa: Kolada').
Gör du egna bearbetningar på vår data, får inte Kolada anges som källa.
Det är tillåtet att använda vår data för kommersiella ändamål.
API:et får inte användas för att sprida skadlig kod.
Du får inte presentera den tjänst du utvecklat som ett 'officiellt samarbete' eller 'partnerskap' med RKA/Kolada.
Tjänsten tillhandahålls i befintligt skick.
Publicering av data i Kolada sker löpande under året i enlighet med respektive statistikkällas publiceringstidpunkt.
Revideringar av data i Kolada kan ske och aviseras inte särskilt.
Enskilda nyckeltal kan tas bort ur Kolada t.ex. pga. att underlag för nyckeltalen förändras, vilket inte aviseras.

Om version 3

Version 3 av Koladas API släpptes den 2025-04-04. Version 2 kommer finnas tillgänglig och användbar i ungefär sex månader efter att version 3 släpptes. Se därför till att uppdatera era script, applikationer och liknande i god tid.

Använda Swagger för att testa Koladas API

För att förenkla åtkomst och testning av vårt API kan du använda Swagger UI, ett webbaserat gränssnitt som gör det lätt att utforska API:ets funktioner och skicka förfrågningar.

Metadata beskriver nyckeltal i detalj

Varje nyckeltal i Kolada har en uppsättning metadata som beskriver nyckeltalet i detalj. I API:et beskrivs dessa metadata på engelska. Nedan förklaras varje metadata med dess engelska och svenska benämning samt beskrivning av dess innebörd.

”id” – nyckeltalsid.
Varje nyckeltal har ett unikt ID som börjar på bokstaven ’N’ eller ’U’, följt av fem siffror.

”title” – nyckeltalsnamn.
Kortnamnet är det nyckeltalsnamn som visas i Kolada.

”description” – beskrivning.
Beskrivningen är en mer utförlig beskrivning som tydliggör hur nyckeltalet beräknats, vad det står för och dess källa.

”is_divided_by_gender” – könsindelad.
Om nyckeltalet kan ha könsuppdelad statistik har detta värdet TRUE.

”municipality_type” – områdestyp.
Anger vilka områdestyper som nyckeltalet har värden för. Om ”K” är angivet för nyckeltalet finns det värden för kommuner och riket. Om ”L” är angivet för nyckeltalet finns det värden för regionerna och riket. Om ”A” är angivet har samtliga områdestyper värden.

”auspice” – regi.
I fältet regi anges vilken regi nyckeltalet avser, om det t.ex. är egen regi, privat regi eller något annat. Möjliga värden är:

X – inte relevant (till exempel för antal invånare)
T – total regi, dvs för all verksamhet oavsett regi
P – privat regi
O – offentlig regi (alla utförare i kommun, region eller stat)
E – egen regi
A – annan regi än egen

"operating_area" - verksamhet.
Indikerar vilken verksamhet nyckeltalet tillhör, till exempel "Hälso- och sjukvård" och "Förskoleverksamhet".

"perspective" - perspektiv.
Varje nyckeltal fokuserar ett av fyra möjliga perspektiv:

Kvalitet och resultat - Kvalitet och resultat i verksamheten. Utifrån medborgarens/brukarens perspektiv. Kan vara en kvantitet av något önskvärt (utbud). Även rutiner mm redovisas här.
Resurser - Resursförbrukning, resurshushållning, resursanvändning och resursernas egenskaper.
Volymer - Volymer i verksamheten. Speglar de behov och den efterfrågan som finns på kommunens tjänster. Avser den mängd personer som nyttjar en tjänst eller mängden insatser av tjänsten. Kan också vara egenskaper hos den som nyttjar tjänsten.
Övrigt - Allt som inte kan redovisas i någon av de andra perspektiven. T.ex. nyckeltal som berör kvalitet, resurs eller volym i största allmänhet men inte i verksamheten. Alternativt berör verksamheten men inte kvalitet, resurs, volym.

"prel_publication_date" - preliminärt publiceringsdatum.
Vissa nyckeltal publiceras och ompubliceras flera gånger per år. Alla publiceringar fram till den definitiva publiceringen klassas som preliminärpubliceringar och detta datum anges här. Är värdet 'null' betyder det att nyckeltalet bara publiceras en gång under året och det är den definitiva publiceringen.

"publication_date" - publiceringsdatum.
Det datum som är satt för publicering av detta nyckeltal. Vi försöker i så stor utsträckning som möjligt publicera samtidigt som källan publicerar data.

"publication_period" - referensår.
Referensåret för den data som publiceras på nästa publiceringsdatum.

"has_ou_data" - enhetsdata.
Anger om det finns enhetsdata publicerat på nyckeltalet. Enhetsdata är data på enhetsnivå exempelvis en specifik grundskola, förskola eller äldreboende. Om enhetsdata finns publicerat på nyckeltalet har detta värdet TRUE.

Hämta data på enhetsnivå

API:et erbjuder flera olika alternativ för att hämta data på enhetsnivå. Alla enheter har ett unikt ID som börjar på bokstaven V. Beroende på vilken typ av enhet det är (till exempel grundskola, gymnasieskola eller LSS daglig verksamhet) följs bokstaven av två siffror. För att identifiera vilken typ av enhet en viss V-kod avser listas alla nedan:

V11 - Förskola
V15 - Grundskola F-9
V17 - Gymnasieskola
V21 - Hemtjänst, äldre
V23 - Särskilt boende, äldre
V25 - LSS boende med särskild service
V26 - LSS daglig verksamhet
V29 - Gruppbostad LSS
V30 - Servicebostad LSS
V31 - SoL Boendestöd
V32 - SoL Boende med särskild service
V34 - SoL Sysselsättning
V45 - Våld i nära relationer (dessa enheter avser bara stadsdelar i Stockholm och Göteborg)
V60 - Fastigheter - region

För Python-utvecklare

En användare har utvecklat KoladaPy - ett Python-bibliotek anpassat för Koladas API v3. Läs mer här.