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

Endpoints

Tabellen

Bagzoek

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
beginGeldigheid Datetime De datum waarop de nummeraanduiding geldig is geworden.
eindGeldigheid Datetime De datum waarop de nummeraanduiding niet meer geldig is.

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
adresseertVerblijfsobjectIdentificatie Tekst Test op exacte waarde (==)
adresseertVerblijfsobjectIdentificatie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
adresseertVerblijfsobjectIdentificatie[isempty] true of false Test of de waarde leeg is (== '' / != '')
adresseertVerblijfsobjectIdentificatie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
adresseertVerblijfsobjectIdentificatie[not] None Test of waarde niet overeenkomt (!=).
adresseertVerblijfsobjectIdentificatie[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
beginGeldigheid yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] Test op exacte waarde (==)
beginGeldigheid[lt] None Test op kleiner dan (<).
beginGeldigheid[gte] None Test op groter dan of gelijk (>=).
beginGeldigheid[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
beginGeldigheid[lte] None Test op kleiner dan of gelijk (<=).
beginGeldigheid[not] None Test of waarde niet overeenkomt (!=).
beginGeldigheid[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
beginGeldigheid[gt] None Test op groter dan (>).
eindGeldigheid yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] Test op exacte waarde (==)
eindGeldigheid[lt] None Test op kleiner dan (<).
eindGeldigheid[gte] None Test op groter dan of gelijk (>=).
eindGeldigheid[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
eindGeldigheid[lte] None Test op kleiner dan of gelijk (<=).
eindGeldigheid[not] None Test of waarde niet overeenkomt (!=).
eindGeldigheid[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
eindGeldigheid[gt] None Test op groter dan (>).
geldigOp <code>yyyy-mm-dd</code> of <code>yyyy-mm-ddThh:mm[:ss[.ms]]</code> Test op exacte waarde (==)
huisletter Tekst Test op exacte waarde (==)
huisletter[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
huisletter[isempty] true of false Test of de waarde leeg is (== '' / != '')
huisletter[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
huisletter[not] None Test of waarde niet overeenkomt (!=).
huisletter[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
huisnummer Geheel getal Test op exacte waarde (==)
huisnummer[lt] None Test op kleiner dan (<).
huisnummer[gte] None Test op groter dan of gelijk (>=).
huisnummer[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
huisnummer[lte] None Test op kleiner dan of gelijk (<=).
huisnummer[not] None Test of waarde niet overeenkomt (!=).
huisnummer[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
huisnummer[gt] None Test op groter dan (>).
huisnummertoevoeging Tekst Test op exacte waarde (==)
huisnummertoevoeging[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
huisnummertoevoeging[isempty] true of false Test of de waarde leeg is (== '' / != '')
huisnummertoevoeging[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
huisnummertoevoeging[not] None Test of waarde niet overeenkomt (!=).
huisnummertoevoeging[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
identificatie Tekst Test op exacte waarde (==)
identificatie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
identificatie[isempty] true of false Test of de waarde leeg is (== '' / != '')
identificatie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
identificatie[not] None Test of waarde niet overeenkomt (!=).
identificatie[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
openbareruimteIdentificatie Tekst Test op exacte waarde (==)
openbareruimteIdentificatie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
openbareruimteIdentificatie[isempty] true of false Test of de waarde leeg is (== '' / != '')
openbareruimteIdentificatie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
openbareruimteIdentificatie[not] None Test of waarde niet overeenkomt (!=).
openbareruimteIdentificatie[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
openbareruimteNaam Tekst Test op exacte waarde (==)
openbareruimteNaam[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
openbareruimteNaam[isempty] true of false Test of de waarde leeg is (== '' / != '')
openbareruimteNaam[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
openbareruimteNaam[not] None Test of waarde niet overeenkomt (!=).
openbareruimteNaam[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
openbareruimteTypeCode Geheel getal Test op exacte waarde (==)
openbareruimteTypeCode[lt] None Test op kleiner dan (<).
openbareruimteTypeCode[gte] None Test op groter dan of gelijk (>=).
openbareruimteTypeCode[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
openbareruimteTypeCode[lte] None Test op kleiner dan of gelijk (<=).
openbareruimteTypeCode[not] None Test of waarde niet overeenkomt (!=).
openbareruimteTypeCode[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
openbareruimteTypeCode[gt] None Test op groter dan (>).
postcode Tekst Test op exacte waarde (==)
postcode[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
postcode[isempty] true of false Test of de waarde leeg is (== '' / != '')
postcode[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
postcode[not] None Test of waarde niet overeenkomt (!=).
postcode[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
typeAdres Tekst Test op exacte waarde (==)
typeAdres[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
typeAdres[isempty] true of false Test of de waarde leeg is (== '' / != '')
typeAdres[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
typeAdres[not] None Test of waarde niet overeenkomt (!=).
typeAdres[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
verblijfsobjectGeometrie GeoJSON of GEOMETRY(x y ...) Test op exacte waarde (==)
verblijfsobjectIdentificatie Tekst Test op exacte waarde (==)
verblijfsobjectIdentificatie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
verblijfsobjectIdentificatie[isempty] true of false Test of de waarde leeg is (== '' / != '')
verblijfsobjectIdentificatie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
verblijfsobjectIdentificatie[not] None Test of waarde niet overeenkomt (!=).
verblijfsobjectIdentificatie[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
verblijfsobjectVolgnummer Geheel getal Test op exacte waarde (==)
verblijfsobjectVolgnummer[lt] None Test op kleiner dan (<).
verblijfsobjectVolgnummer[gte] None Test op groter dan of gelijk (>=).
verblijfsobjectVolgnummer[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
verblijfsobjectVolgnummer[lte] None Test op kleiner dan of gelijk (<=).
verblijfsobjectVolgnummer[not] None Test of waarde niet overeenkomt (!=).
verblijfsobjectVolgnummer[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
verblijfsobjectVolgnummer[gt] None Test op groter dan (>).
volgnummer Geheel getal Test op exacte waarde (==)
volgnummer[lt] None Test op kleiner dan (<).
volgnummer[gte] None Test op groter dan of gelijk (>=).
volgnummer[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
volgnummer[lte] None Test op kleiner dan of gelijk (<=).
volgnummer[not] None Test of waarde niet overeenkomt (!=).
volgnummer[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
volgnummer[gt] None Test op groter dan (>).
woonplaatsIdentificatie Tekst Test op exacte waarde (==)
woonplaatsIdentificatie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
woonplaatsIdentificatie[isempty] true of false Test of de waarde leeg is (== '' / != '')
woonplaatsIdentificatie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
woonplaatsIdentificatie[not] None Test of waarde niet overeenkomt (!=).
woonplaatsIdentificatie[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
woonplaatsNaam Tekst Test op exacte waarde (==)
woonplaatsNaam[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
woonplaatsNaam[isempty] true of false Test of de waarde leeg is (== '' / != '')
woonplaatsNaam[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
woonplaatsNaam[not] None Test of waarde niet overeenkomt (!=).
woonplaatsNaam[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).