API: Documentatie

Op deze pagina is de documentatie te vinden voor versie 3 van de vertraagd.com API.

De API biedt gegevens aan in XML- of JSON-formaat. Je vraagt gegevens op door een variant van de volgende URL te gebruiken:


https://api.vertraagd.com/3
/KEY
/DATA
/VERVOERDER
/OUTPUT


We bespreken de belangrijkste onderdelen stuk voor stuk. Aan het eind van dit document staan de foutmeldingen die je kunt verwachten als er iets misgaat.

HTTPS

Gebruik van HTTPS is verplicht. Omdat je key zichtbaar is in de url, is het veiliger om via een beveiligde verbinding met onze API te praten. Als je de API via HTTP probeert te bereiken, krijg je een foutmelding.

KEY

Dit is simpel. Hier vul je de API-key in die je bij het aanmelden hebt gekregen. Bescherm deze key met je leven. Het is je sleutel tot de API.

DATA

Hier vertel je onze server welke gegevens je wilt ontvangen. Er zijn een paar verschillende typen data die je kunt opvragen:


actueel: de huidige status op het spoor. Hoeveel procent rijdt nu op tijd en hoeveel treinen zijn vertraagd of uitgevallen?


gisteren: hoeveel procent van de treinen reed gisteren op tijd? Dit is het dagpercentage dat we op de site melden.


ranking: welke vervoerder presteerde gisteren het beste? De elementen zijn gerangschikt van hoog naar laag. Dit is de ranking die we op de site melden.


VERVOERDER

Je kunt ook data per vervoerder opvragen. Geldige waarden zijn de namen van alle vervoerders (ns, arriva, qbuzz, keolis, connexxion, breng, nsinternational, abellio) en de vervoerder all, voor gegevens over het hele spoornet.

OUTPUT

Je kunt de gegevens uit onze API in twee formaten krijgen: XML en JSON. Om te kiezen, voeg je gewoon xml of json (beide lowercase) toe aan het eind van de url. Deze parameter is verplicht, er is geen fallback naar eens standaardwaarde.



Vraag toegang aan


Foutmeldingen

We hopen natuurlijk dat je geen foutmeldingen te zien krijgt. Maar als het toch gebeurt, dan kun je hieronder lezen wat ze betekenen.


ERROR 403: Ongeldige API-key of gebruiker geblokkeerd. Deze foutmelding geeft aan dat je API key niet geaccepteerd is. Dit kan komen door een typefout of omdat we je geblokkeerd hebben. Kopieer de key vanaf de site, op de pagina waar je toegang krijgt. Kom je er niet uit, stuur een mail naar [email protected]


ERROR 404: API-functie niet gevonden. Deze foutmelding krijg je als de URL niet klopt. Het kan zijn dat je een waarde hebt gebruikt die niet bestaat. Ook als je een waarde bij OUTPUT weglaat, krijg je deze foutmelding.


ERROR 405: Ongeldige output gekozen. Alleen 'xml' en 'json' worden ondersteund. Deze foutmelding spreekt voor zich. Je kunt alleen xml of json kiezen als output.


ERROR 426: de API vereist het gebruik van HTTPS. Maak verbinding via https://api.vertraagd.com/.. Verander HTTP aan het begin van de URL in HTTPS en het zou moeten werken.

  • 97.3%

    van 186 treinen rijdt nu op tijd.

      5 vertraagd

    NSArrivaKeolisConnexxionQbuzzAbellioBrengNS Int

    Eerder op het spoor

    97.5% van de treinen reed gisteren op tijd. Benieuwd hoe dat eruitziet in een toffe grafiek, of hoe het eergisteren of vorige maand was?

    Bekijk grafieken

    Laatste blogposts


    Wat is dit?

    vertraagd.com is een onafhankelijke site die je laat zien hoeveel procent van de treinen in Nederland op tijd is. Wij weten welke treinen (zouden moeten) rijden, en dus ook wanneer ze vertraagd of uitgevallen zijn.

    Meer over ons

    Aan de slag met onze data?

    We stellen een deel van onze data beschikbaar aan ontwikkelaars via een API. Zo kun je de actuele punctualiteit bijvoorbeeld op je site of in je app laten zien.

    Meer informatie