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