API for åpne data

Uthenting av data gjøres via kall til tjenestens REST programmeringsgrensesnitt gjennom følgende URL / query string:

Angivelse av ressurs

Tjenesten benytter  https.
Tjenesten er tilgjengelig via URL data.norges-bank.no/api.
Ressursen for data spørringer er data.
I tillegg finnes det ressurser for å hente ut metadata om tilgjengelige data. Disse er beskrevet i SDMX REST spesifikasjonen. Metadataspørringer returnerer XML etter SDMX-ML spesifikasjonen.

Referanse til dataflyten («datasettet») som skal returneres.

Består av identifikatoren til dataflyten samt en valgfri angivelse av versjon (om det eksisterer flere versjoner) separert av komma. Utelates versjon vil siste versjon av dataflyten returneres.

Eksempel: EXR, 2.0 (med versjonering) EXR (uten versjonering) for valutakurs dataflyten.

En oversikt over hvilke dataflyter som er tilgjengelige finnes under tilgjengelige data.

En kan også benytte seg av tjenesten for maskinelt hente ut informasjon om hvilke data som er tilgjengelige (se spesifikasjonen). Et vidt spekter av metadata kan hentes ut, men gitt den begrensede mengden data Norges Bank publiserer vil det for de fleste behov være nok å hente ut informasjon om hvilke dataflyter som er tilgjengelige og detaljer for disse. Et kall til https://data.norges-bank.no/api/dataflow/all?references=children vil liste ut basisinformasjon om alle dataflyter som er tilgjengelige.

Spesifisering av data som skal returneres fra dataflyten. Hver dataflyt består av et sett dimensjoner som til sammen identifiserer hvilke data som skal hentes ut.

For eksempel består valutakursflyten av følgende dimensjoner:

  1. Frekvens for målingen (B for "Business day"/virkedag)
  2. Basisvaluta (valuta det skal veksles til, f.eks. CHF)
  3. Valutakurs (alltid NOK)
  4. Type kurs (alltid SP for spot)

Dimensjonene settes sammen med punktum for å konstruere en identifikator for data som skal returneres. For eksempelet over vil dette da bli: B.USD.NOK.SP

Detaljert informasjon over dimensjoner, attributter og tillatte verdier i en dataflyt finner man under tilgjengelige data. Denne informasjonen kan en også hente ut med et kall til REST APIet. For EXR (valutakurser) dataflyten vil kallet se slik ut: https://data.norges-bank.no/api/dataflow/all/EXR?detail=full&references=descendants

Wildcard kan benyttes ved å utelate en verdi for dimensjonen. B..NOK.SP vil returnere kurser for alle valutaer.

OR (eller) operatoren kan spesifiseres med et pluss tegn. D.CHF+USD.NOK.SP vil returnere kurser for sveitsiske franc og amerikanske dollar.

Parametere

Begrenser hvilke observasjoner som skal hentes ut i tid. Verdiene som gis må formatteres etter ISO 8601. Formatet vil avhenge av hvilke frekvenser dataflyten tilbyr.
  • År: YYYY (2012)
  • Kvartal YYY-MM-DD (2012-Q4)
  • Måned: YYYY-MM (2012-11)
  • Dag: YYYY-MM-DD (2012-11-05)

StartPeriod=2011&EndPeriod=2015 vil hente ut data fra 2011 til 2015.

StartPeriod=2011 vil hente ut data fra 2011 til siste tilgjengelige data.

EndPeriod=2015 vil hente ut data fra første observasjon til 2015.

Kan benyttes for å spesifisere et antall observasjoner å returnere fra starten eller slutten av en serie.

Gitt at en serie starter i 1990 vil firstNObservations=3 returnere data for 1990, 1991 og 1992.

Gitt at en serie ender i 2016 vil lastNObservations=3 returnere data for 2014, 2015 og 2016.

Benyttes for å spesifisere detaljeringsgraden til informasjonen returnert fra tjenesten.

Gitt Norges Banks begrensede omfang av åpne data vil det i de aller fleste tilfeller ikke være nødvendig å angi noe for denne parameteren men alltid returnere full informasjon som er normalverdien. Andre mulige verdier er:

  • full – Alt returneres (normalverdi)
  • dataonly – Attributter vil utelates fra svaret
  • serieskeysonly – Kun serier uten data eller attributter. Kan benyttes for å se hvilke serier som matcher en spørring.
  • nodata – Serier og attributter returneres men ingen data.

Benyttes for å spesifisere formatet til svaret fra tjenesten. Om ingenting blir angitt settes dette til XML (SDMX structure specific).

FormatAngivelse
XML  
JSON

Formatet er i beta.

Excel
  • Kun koderexcel-false
  • Med navnexcel-true
CSV

Flatfiler spesifiseres på format csv-:-skilletegn-brukfullenavn-aksefortid

Skilletegn
  • comma
  • semicolon
  • tab
  • space
Brukfullenavn
  • true - Koder oversettes til navn
  • false - Kun koder returneres
Akse for tid
  • flat - returnerer tid som rader i et flatt resultatsett uten header og footer
  • x - tid legges som kolonner
  • y - tid legges som verdi i rader

csv-:-semicolon-true-x vil for eksempel returnere en fil hvor kolonner er separert av semikolon, alle koder har både kode og navn og tid legges som kolonner bortover i filen.

Man kan også angi formatet ved HTTP content negotiation. Se teknisk seksjonen for mer informasjon.

Formatet er i beta.

Benytt parameteret for å angi et eget navn på filen returnert fra tjenesten.

Eksempler

Sist publiserte (lastNObservations=1) virkedag (B) kurs for alle valuta (tom verdi signaliserer "alle") i JSON format (format=sdmx-json) fra EXR dataflyten:
https://data.norges-bank.no/api/data/EXR/B..NOK.SP?lastNObservations=1&format=sdmx-json
Månedlig (M) kurs for sveitsiske franc (CHF) og (+) amerikanske dollar (USD) siden 2010 (startPeriod=2010) som XML (format=sdmx-compact-2.1) fra EXR dataflyten.
https://data.norges-bank.no/api/data/EXR/M.CHF+USD.NOK.SP?startPeriod=2010&format=sdmx-compact-2.1
Alle (ingen spesifikasjon av tidsperiode i parametere) månedlige (M) noteringer for sveitsiske franc (CHF) som komma (comma) separarert fil (csv) med koder beriket med navn (yes) i et flatt resultatsett med tid som rader (flat).
https://data.norges-bank.no/api/data/EXR/M.CHF.NOK.SP?format=csv-:-comma-true-flat
Publisert 19. mai 2017 13:00

Kontakt

Vi hører gjerne fra deg dersom du har forslag til forbedringer eller har spørsmål.

data@norges-bank.no