PxWebApi 1 vil leve videre parallelt med det nye API-et i flere år framover. Vær obs på at PxWebApi 2.0 beta inntil videre ikke er tilgjengelig om morgenen i tidsrommet kl. 05.00-08.15, samt lørdag og søndag.
Les om hvordan PxWebApi 2.0 fungerer:
https://github.com/statisticssweden/PxApiSpecs/blob/master/specs.md
Grenser, utformater og defaultverdier
https://data.ssb.no/api/pxwebapi/v2-beta/config
Navigere i emneoversikt
https://data.ssb.no/api/pxwebapi/v2-beta/navigation
Søk etter en bestemt tekst i alle tabeller
https://data.ssb.no/api/pxwebapi/v2-beta/tables?query=restaurant
Om trefflista går over flere sider, vil det nederst være lenke til neste og siste side.
Metadata for en gitt tabell (5-sifret tabellnummer)
https://data.ssb.no/api/pxwebapi/v2-beta/tables/03013/metadata?outputformat=json-stat2
Data (utsnitt) for en tabell
https://data.ssb.no/api/pxwebapi/v2-beta/tables/03013/data
Vær obs på at dette gir et utsnitt av data (benyttes som start-tabell i PxWeb), altså ikke alle data. For å få ut alle data, må du i spørringen ta med de ulike variablene «dimension» og be om alle verdier (=*).
Asterisk som trunkeringstegn
Tid= 2020* vil i tabell 03013 gi alle måneder i 2020:
https://data.ssb.no/api/pxwebapi/v2-beta/tables/03013/data?outputformat=json-stat2&lang=no&valueCodes[Konsumgrp]=01&valueCodes[ContentsCode]=KpiIndMnd&valueCodes[Tid]=2020*
Kan sløyfe outputformat og lang om man ønsker default utformat og språk (se config):
https://data.ssb.no/api/pxwebapi/v2-beta/tables/03013/data?valueCodes[Konsumgrp]=01&valueCodes[ContentsCode]=KpiIndMnd&valueCodes[Tid]=2020*
Asterisk for å hente alle konsumgrupper
Spørsmålstegn for å angi antall tegn i koden av en verdi
valueCodes[Konsumgrp]=?? vil i tabell 03013 gi alle konsumgrupper med tosifret kode:
https://data.ssb.no/api/pxwebapi/v2-beta/tables/03013/data?valueCodes[Konsumgrp]=??&valueCodes[ContentsCode]=KpiIndMnd&valueCodes[Tid]=2020*
Top eller bottom for å angi de x første eller siste verdiene i en liste
valueCodes[Tid]=top(3) gir de tre nyeste månedene i tabellen:
https://data.ssb.no/api/pxwebapi/v2-beta/tables/03013/data?valueCodes[Konsumgrp]=??&valueCodes[ContentsCode]=KpiIndMnd&valueCodes[Tid]=top(3)
From eller to for å angi startverdi eller sluttverdi fra en liste
valueCodes[Tid]=from(2022M01) gir alle måneder fra og med 2022M01:
https://data.ssb.no/api/pxwebapi/v2-beta/tables/03013/data?valueCodes[Konsumgrp]=??&valueCodes[ContentsCode]=KpiIndMnd&valueCodes[Tid]=from(2022M01)
Range for å angi start- og sluttverdi fra en liste
valueCodes[Konsumgrp]=[range(01.1,02.2)] gir alle konsumgrupper fra og med kode 01.1 til og med kode 02.2:
https://data.ssb.no/api/pxwebapi/v2-beta/tables/03013/data?valueCodes[Konsumgrp]=[range(01.1,02.2)]&valueCodes[ContentsCode]=KpiIndMnd&valueCodes[Tid]=from(2022M01)
Man kan bare oppgi gyldige (eksisterende) verdier som start og slutt.
Eliminasjon (utelate en variabel fra spørringen)
Utelater (eliminerer) her alder, kjønn og region, og får da totaltallene i stedet:
https://data.ssb.no/api/pxwebapi/v2-beta/tables/07459/data?valueCodes[ContentsCode]=Personer1&valueCodes[Tid]=from(2018)
Vær obs på at tid ikke kan elimineres i dette API-et.
Begrense til verdier i en gitt verdimengde
Henter alle enkeltverdiene i verdimengden vs_Fylker:
https://data.ssb.no/api/pxwebapi/v2-beta/tables/01222/data?valueCodes[Region]=*&valueCodes[ContentsCode]=Folketallet1&valueCodes[Tid]=from(2022K1)&codelist[Region]=vs_Fylker
Begrense til verdier i en gitt gruppering
Henter alle aggregerte verdier fra grupperingen agg_KommSummer i tabell 01222:
https://data.ssb.no/api/pxwebapi/v2-beta/tables/01222/data?valueCodes[Region]=*&valueCodes[ContentsCode]=Folketallet1&valueCodes[Tid]=from(2021K1)&codelist[Region]=agg_KommSummer&outputValues[Region]=aggregated
Henter alle enkeltverdiene i gruppering agg_FylkerGjeldende i tabell 13536:
https://data.ssb.no/api/pxwebapi/v2-beta/tables/13536/data?valueCodes[Region]=*&valueCodes[ContentsCode]=Gjennomsnittsalder,Medianalder&valueCodes[Tid]=from(2022)&codelist[Region]=agg_FylkerGjeldende&outputValues[Region]=single
Både http GET og http POST
Man kan velge om å bruke GET- eller POST-kall i dette nye API-et. Det er en grense på rundt 2500 tegn i URL-en for GET-kall. Man vil få en feilmelding om man forsøker med URL som overstiger dette. Da kan man enten bruke POST i stedet, eller man kan omformulere spørringen for eksempel ved hjelp av trunkeringstegn, «from» eller «range».
Nye metadata
Det nye API-et tilbyr mer metadata enn tidligere.
Under “extension” finner man blant annet “contents”, som viser første del av den tabelltittelen som blir generert i PxWeb når brukeren velger variabler selv.
Om det er flere verdimengder eller grupperinger tilknyttet en variabel, er disse listet opp under «codeLists».
Under “extension” finner man blant annet “contents”, som viser første del av den tabelltittelen som blir generert i PxWeb når brukeren velger variabler selv.
Kjente feil
Under endepunkt metadata fungerer ikke lenker som inneholder codeLists.
"subject-code" viser konstant "al" og "subject-area" viser "Arbeid og lønn". Dette er selvsagt ikke riktig for alle tabeller.
Under arbeid
API-et er under utvikling. Blant annet vil endepunkt data bli endret, og default format for metadata bli byttet til json-stat2.
PxWeb viser foreløpig bare POST-spørringer for PxWebApi 1, men vi vil også senere vise GET-spørring for PxWebApi 2.0.
Kontakt
Kontakt statistikkbanken@ssb.no om du har spørsmål til tabellene eller API-et.
Det er også mulig å gi tilbakemeldinger på GitHub: