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
id String ☑
identificatie String ☑ Landelijke identificerende sleutel.
volgnummer Integer ☑ Volgnummer van de nummeraanduiding in de administratie van de bronhouder.
huisnummer Integer Een door het bevoegde gemeentelijke orgaan ten aanzien van een adresseerbaar object toegekende nummering.
huisletter String Een door het bevoegde gemeentelijke orgaan ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.
huisnummertoevoeging String Een door het bevoegde gemeentelijke orgaan ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.
postcode String De door PostNL vastgestelde code bestaande uit 4 cijfers en 2 letters (1234AB).
beginGeldigheid Datetime De datum waarop de nummeraanduiding geldig is geworden.
eindGeldigheid Datetime De datum waarop de nummeraanduiding niet meer geldig is.
typeAdres String Hiermee wordt aangegeven of het een relatie betreft vanuit een hoofdadres. Anders is er sprake van een nevenadres (Hoofdadres, Nevenadres).
adresseertVerblijfsobjectIdentificatie String Het verblijfsobject (landelijke identificatie) dat door de nummeraanduiding wordt aangeduid.
openbareruimteTypeCode Integer De aard van de zodanig benoemde openbare ruimte (01 Weg, 02 Water, 03 Spoorbaan, 04 Terrein, 05 Kunstwerk, 06 Landschappelijk gebied, 07 Administratief gebied) code
openbareruimteIdentificatie String Landelijke identificerende sleutel.
openbareruimteNaam String Officiële naam openbare ruimte (80 tekens).
woonplaatsIdentificatie String Landelijke identificerende code woonplaats Amsterdam 3594 en woonplaats Weesp 3631.
woonplaatsNaam String Officiële naam woonplaats.
verblijfsobjectIdentificatie String Landelijke identificerende sleutel.
verblijfsobjectVolgnummer Integer Uniek volgnummer van de toestand van het object.
verblijfsobjectGeometrie Geometry De locatie van het verblijfsobject in het Nationale Rijksdriehoekstelsel.

De volgende query-parameters zijn te gebruiken:

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