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

Tenaamstellingen

De volgende velden zijn beschikbaar:

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

De volgende query-parameters zijn te gebruiken:

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