Opvragen van informatie uit data.overheid.nl via de API

De inhoud van het Open Data Register op data.overheid.nl is (uiteraard) als open data beschikbaar. Het register is toegankelijk via de standaard CKAN API. Zie de CKAN website voor een uitleg over de werking van de API.

Met behulp van deze API kunnen organisaties een eigen toegang op het register ontwikkelen, zonder een kopie van de gegevens te hoeven maken. Het dataset register op data.overheid.nl blijft op deze manier het centrale register voor datasets van de hele Nederlandse overheid.

URL naar de api

De api van data.overheid.nl is te benaderen via

data.overheid.nl/data/api/3/action/{actie}

waarbij {actie} kan worden vervangen door een gewenste functienaam.

Voorbeelden van requests

Hieronder staan enkele voorbeelden van requests. De resultaten worden teruggegeven in JSON.
Raadpleeg voor een volledige omschrijving van alle mogelijkheden de documentatie op CKAN.org.

Alle datasets in de database:

https://data.overheid.nl/data/api/3/action/package_list

Alle informatie over de datasets in de databaase met een limiet van de eerste 10 datasets:

https://data.overheid.nl/data/api/3/action/package_search?start=0&rows=10

Zoeken met een zoekwoord:

https://data.overheid.nl/data/api/3/action/package_search?q=transport

Tips en tricks voor gebruik van de API

  • In de API wordt waar mogelijk gebruik gemaakt van URI's voor waarden in metadatavelden. Deze URI's verwijzen naar waardelijsten. Waardelijsten zijn onder andere te vinden in lijstoverzicht.
  • de volledige "mapping" van de velden in de API op DCAT, NGR en de veldlabels in de interface van data.overheid.nl is te vinden onder "standaarden en techniek".
  • In veel gevallen wordt de "displayname" van de URI als een apart veld toegevoegd in de resultaten vanuit de API.  De displayname kan in sommige gevallen niet up-to-date zijn met de waardelijst omdat deze alleen bij het uitvoeren van een import van de externe data-catalogi wordt bijgewerkt.