Introductie API Keys

Het Dataplatform van de gemeente Amsterdam gaat het gebruik van een identificatie key bij het aanroepen van haar API's vanaf 1 februari 2024 verplicht stellen. Vanaf 1 februari 2024 kun je de API's van het Dataplatform niet meer zonder een key gebruiken. Vraag tijdig een key aan via dit aanvraagformulier. Doe je dit niet, dan werkt je applicatie of website vanaf 1 februari 2024 niet meer. Dit geldt voor alle API's die op deze pagina gedocumenteerd zijn.

Door de API key kunnen we contact houden met de gebruikers van onze API's. Zo kunnen we gebruikers informeren over updates. Daarnaast krijgen we hiermee inzicht in het gebruik van de API's en in wie welke dataset via de API bevraagt. Ook voor dataeigenaren is dit waardevolle informatie.

Meer info:
Pagina API key aanvragen
Technische documentatie
Vragen? Mail naar dataplatform@amsterdam.nl

Toegang kan worden aangevraagd bij de uitgever: Datateam Basis- en Kernregistraties

Endpoints

Tabellen

Aantekeningen

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
beginGeldigheid Datetime Begindatum geldigheid object.
eindGeldigheid Datetime Einddatum geldigheid object.

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
aardOmschrijving BRK/RS Tekst Test op exacte waarde (==)
aardOmschrijving[in] BRK/RS Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
aardOmschrijving[like] BRK/RS Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
aardOmschrijving[isempty] BRK/RS true of false Test of de waarde leeg is (== '' / != '')
aardOmschrijving[not] BRK/RS None Test of waarde niet overeenkomt (!=).
aardOmschrijving[isnull] BRK/RS true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
beginGeldigheid BRK/RS yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] Test op exacte waarde (==)
beginGeldigheid[gte] BRK/RS None Test op groter dan of gelijk (>=).
beginGeldigheid[lt] BRK/RS None Test op kleiner dan (<).
beginGeldigheid[in] BRK/RS Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
beginGeldigheid[gt] BRK/RS None Test op groter dan (>).
beginGeldigheid[lte] BRK/RS None Test op kleiner dan of gelijk (<=).
beginGeldigheid[not] BRK/RS None Test of waarde niet overeenkomt (!=).
beginGeldigheid[isnull] BRK/RS true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
eindGeldigheid BRK/RS yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] Test op exacte waarde (==)
eindGeldigheid[gte] BRK/RS None Test op groter dan of gelijk (>=).
eindGeldigheid[lt] BRK/RS None Test op kleiner dan (<).
eindGeldigheid[in] BRK/RS Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
eindGeldigheid[gt] BRK/RS None Test op groter dan (>).
eindGeldigheid[lte] BRK/RS None Test op kleiner dan of gelijk (<=).
eindGeldigheid[not] BRK/RS None Test of waarde niet overeenkomt (!=).
eindGeldigheid[isnull] BRK/RS true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
geldigOp <code>yyyy-mm-dd</code> of <code>yyyy-mm-ddThh:mm[:ss[.ms]]</code> Test op exacte waarde (==)
hftBtrkOpKotIdentificatie BRK/RS Tekst Test op exacte waarde (==)
hftBtrkOpKotIdentificatie[in] BRK/RS Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
hftBtrkOpKotIdentificatie[like] BRK/RS Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
hftBtrkOpKotIdentificatie[isempty] BRK/RS true of false Test of de waarde leeg is (== '' / != '')
hftBtrkOpKotIdentificatie[not] BRK/RS None Test of waarde niet overeenkomt (!=).
hftBtrkOpKotIdentificatie[isnull] BRK/RS true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id BRK/RS Tekst Test op exacte waarde (==)
id[in] BRK/RS Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id[like] BRK/RS Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
id[isempty] BRK/RS true of false Test of de waarde leeg is (== '' / != '')
id[not] BRK/RS None Test of waarde niet overeenkomt (!=).
id[isnull] BRK/RS true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
identificatie BRK/RS Tekst Test op exacte waarde (==)
identificatie[in] BRK/RS Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
identificatie[like] BRK/RS Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
identificatie[isempty] BRK/RS true of false Test of de waarde leeg is (== '' / != '')
identificatie[not] BRK/RS None Test of waarde niet overeenkomt (!=).
identificatie[isnull] BRK/RS true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
omschrijving BRK/RS Tekst Test op exacte waarde (==)
omschrijving[in] BRK/RS Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
omschrijving[like] BRK/RS Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
omschrijving[isempty] BRK/RS true of false Test of de waarde leeg is (== '' / != '')
omschrijving[not] BRK/RS None Test of waarde niet overeenkomt (!=).
omschrijving[isnull] BRK/RS true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
volgnummer BRK/RS Geheel getal Test op exacte waarde (==)
volgnummer[gte] BRK/RS None Test op groter dan of gelijk (>=).
volgnummer[lt] BRK/RS None Test op kleiner dan (<).
volgnummer[in] BRK/RS Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
volgnummer[gt] BRK/RS None Test op groter dan (>).
volgnummer[lte] BRK/RS None Test op kleiner dan of gelijk (<=).
volgnummer[not] BRK/RS None Test of waarde niet overeenkomt (!=).
volgnummer[isnull] BRK/RS true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).