DUO open onderwijsdata

Basisadres

https://onderwijsdata.duo.nl/api/3/action

Endpoints 8

• GET/package_listNamen van alle 56 datasets (bv. adressen_bo, 03_voex-v1, historische-leerlingenaantallen-po).
• GET/package_search?q=…&fq=…&rows=…Zoeken in de catalogus; met rows=0 alleen het aantal. Geeft per dataset ook alle resources (bestanden) met id, formaat en datastore_active.
• GET/package_show?id={naam}Eén dataset: beschrijving, licentie, metadata_modified en de resources met hun resource_id en download-URL.
• GET/resource_show?id={resource_id}Eén bestand: naam, formaat, last_modified, download-URL.
• GET/group_listDe acht onderwerpgroepen (basisonderwijs, voorgezet-onderwijs, hoger-onderwijs, inburgering …).
• GET/group_show?id={groep}Eén groep met titel en beschrijving.
• GET/datastore_search?resource_id={id}De rijen van één tabel, met filters, vrij zoeken, sorteren, kolomkeuze en paginering. Het antwoord noemt ook de kolommen met type.
• GET/dataset/{dataset-id}/resource/{resource_id}/download/{bestand}.csvHet hele bestand als CSV (pad zonder /api/3/action, op https://onderwijsdata.duo.nl).

Filteren getest

Geen querytaal: gelijk-aan-filters als JSON in filters (waarde of lijst van waarden), plus vrij zoeken met q. Geen groter-dan of kleiner-dan; datastore_search_sql is uitgeschakeld.

Parameters 10

Velden in de datastore (selectie: schooladviezen en adressen basisonderwijs) 8

Limieten en valkuilen

• Geen sleutel en geen gedocumenteerde rate limit. Standaard 100 rijen per aanroep; een limit van 40.000 werd geleverd. Pagineer met offset of _links.next. getest
• Alleen een deel van de CKAN-acties staat open (package_list, package_search, package_show, resource_show, group_list, group_show, datastore_search). getest
• Andere CKAN-acties (status_show, organization_list, tag_list, datastore_info, help_show) geven HTTP 200 met de HTML van de website, geen JSON-fout. Controleer altijd of het antwoord JSON is. datastore_search_sql geeft 400 "Action name not known". getest
• distinct=true telt goed (total 15 peiljaren in de schooladviezen) maar gaf maar één rij terug. Gebruik voor unieke waarden liever een kleine kolomselectie met een hoge limit. getest
• AVG: aantallen van 1 tot 4 staan als -1 in de API (in sommige bestanden als <5). Niet optellen als getal. getest
• Negen download-URL's in de catalogus wijzen naar een interne host (beheer-ggm-ckan-prd.apps.prd.duo.rijksapps.nl) die buiten DUO niet bestaat; vervang de host door onderwijsdata.duo.nl. getest
• Leerlingbestanden hebben alleen BRIN en vestigingscode; naam, adres en gemeente koppel je via de adressenbestanden (adressen_bo, adressen_vo …). Gemeentenummer zonder GM: plak er GM en voorloopnullen voor om met CBS te koppelen. ervaring
• Resource-id's veranderen niet bij een nieuwe levering; metadata_modified van de dataset en last_modified van de resource geven de versheid (adressen worden dagelijks ververst). ervaring

Probeer het HTTP 200 · 694 ms · 16 okt

https://onderwijsdata.duo.nl/api/3/action/datastore_search?resource_id=454c5dd4-6815-4b52-ae2f-b9eebc6afa6d&filters={"PEILJAAR"%3A2024}&sort=AANTAL_LEERLINGEN desc&limit=3

{
  "help": "https://onderwijsdata.duo.nl/api/3/action/help_show?name=datastore_search",
  "success": true,
  "result": {
    "filters": {
      "PEILJAAR": 2024
    },
    "include_total": true,
    "limit": 3,
    "records_format": "objects",
    "resource_id": "454c5dd4-6815-4b52-ae2f-b9eebc6afa6d",
    "sort": "AANTAL_LEERLINGEN desc",
    "total_estimation_threshold": null,
    "records": [
      {
        "_id": 104633,
        "INSTELLINGSCODE": "05VX",
        "VESTIGINGSCODE": "00",
        "TYPE_PO": "BO",
        "PEILJAAR": 2024,
        "ADVIES": 12,
        "AANTAL_LEERLINGEN": 234
      },
      {
        "_id": 492855,
        "INSTELLINGSCODE": "17ON",
        "VESTIGINGSCODE": "00",
        "TYPE_PO": "BO",
        "PEILJAAR": 2024,
        "ADVIES": 12,
        "AANTAL_LEERLINGEN": 78
      }
    ],
    "fields": [
      {
        "id": "_id",
        "type": "int"
      },
      {
        "id": "INSTELLINGSCODE",

Ingekort antwoord, opgeslagen bij het oogsten. Klik op het adres voor het echte, actuele antwoord.