Kodeeksempel
Ferdige utklipp som viser korleis du kallar API-ane og lastar ned datasett. For interaktiv dokumentasjon per endepunkt, sjå API-referansen.
Byt ut YOUR_KEY med ein ekte nøkkel frå framsida.
URL-ane peikar på test-gatewayen. På produksjonsportalen blir api.test.data.regjeringen.no erstatta med api.data.regjeringen.no.
Kall eit API med nøkkel
API-ar som krev nøkkel blir lesne med headeren Ocp-Apim-Subscription-Key. Hent ein nøkkel på framsida, og byt ut YOUR_KEY nedanfor. language er påkravd.
curl
curl -H "Ocp-Apim-Subscription-Key: YOUR_KEY" \
"https://api.test.data.regjeringen.no/content/GetDocList?language=nb&pageSize=10"JavaScript
const res = await fetch(
"https://api.test.data.regjeringen.no/content/GetDocList?language=nb&pageSize=10",
{ headers: { "Ocp-Apim-Subscription-Key": "YOUR_KEY" } },
);
const docs = await res.json();
console.log(docs);Python
import requests
res = requests.get(
"https://api.test.data.regjeringen.no/content/GetDocList",
params={"language": "nb", "pageSize": 10},
headers={"Ocp-Apim-Subscription-Key": "YOUR_KEY"},
)
res.raise_for_status()
docs = res.json()
print(docs)Last ned eit datasett (utan nøkkel)
Dei nattlege eksportane er opne og blir serverte gzippa. Bruk --compressed så curl pakkar ut automatisk.
curl
curl --compressed -o content.json \
https://api.test.data.regjeringen.no/exports/content.jsonJavaScript
// fetch() transparently decodes gzip.
const res = await fetch("https://api.test.data.regjeringen.no/exports/content.json");
const documents = await res.json();
console.log(documents.length, "documents");Python
import requests
# requests transparently decodes gzip.
res = requests.get("https://api.test.data.regjeringen.no/exports/content.json")
res.raise_for_status()
documents = res.json()
print(len(documents), "documents")Paginer og aggreger dokument
Eit meir komplett eksempel: hent alle pressemeldingar i ein datoperiode ved å følgje pagineringa (page/pageSize), og tel dei per departement. Bruk showOwner=true for å få med eigar.
curl
#!/usr/bin/env bash
# Fetch every press release from 2024, page by page (needs jq).
key="YOUR_KEY"
base="https://api.test.data.regjeringen.no/content/GetDocList"
query="language=nb&type=pressemelding&fromDate=2024.01.01&toDate=2024.12.31&showOwner=true&pageSize=100"
page=1
while :; do
batch=$(curl -s -H "Ocp-Apim-Subscription-Key: $key" "$base?$query&page=$page")
# Documents live under data.items; the owner is an object (use .owner.depName).
echo "$batch" | jq -c '.data.items[] | { title, date, ministry: .owner.depName }'
[ "$page" -ge "$(echo "$batch" | jq '.data.pager.totalPages')" ] && break
page=$((page + 1))
doneJavaScript
const KEY = "YOUR_KEY";
const BASE = "https://api.test.data.regjeringen.no/content/GetDocList";
// Follow the pager until the last page is reached.
async function fetchAll(params) {
const all = [];
for (let page = 1; ; page++) {
const url = new URL(BASE);
url.search = new URLSearchParams({ ...params, page, pageSize: "100" });
const res = await fetch(url, {
headers: { "Ocp-Apim-Subscription-Key": KEY },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
// Documents are under data.items; data.pager.totalPages drives pagination.
const { data } = await res.json();
all.push(...data.items);
if (page >= data.pager.totalPages) break;
}
return all;
}
const docs = await fetchAll({
language: "nb",
type: "pressemelding",
fromDate: "2024.01.01",
toDate: "2024.12.31",
showOwner: "true",
});
// Count press releases per owning ministry (owner is an object).
const byMinistry = {};
for (const doc of docs) {
const ministry = doc.owner?.depName ?? "(ukjent)";
byMinistry[ministry] = (byMinistry[ministry] ?? 0) + 1;
}
console.table(byMinistry);Python
import requests
from collections import Counter
KEY = "YOUR_KEY"
BASE = "https://api.test.data.regjeringen.no/content/GetDocList"
def fetch_all(**params):
"""Follow pagination until a short (final) page is returned."""
documents = []
page = 1
while True:
res = requests.get(
BASE,
params={**params, "page": page, "pageSize": 100},
headers={"Ocp-Apim-Subscription-Key": KEY},
)
res.raise_for_status()
# Documents are under data.items; data.pager.totalPages drives pagination.
data = res.json()["data"]
documents.extend(data["items"])
if page >= data["pager"]["totalPages"]:
break
page += 1
return documents
docs = fetch_all(
language="nb",
type="pressemelding",
fromDate="2024.01.01",
toDate="2024.12.31",
showOwner="true",
)
# Count press releases per owning ministry (owner is an object).
by_ministry = Counter(
(doc.get("owner") or {}).get("depName", "(ukjent)") for doc in docs
)
for ministry, count in by_ministry.most_common():
print(f"{count:4} {ministry}")