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

Peilmerken

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
identificatie String Het nummer van het peilmerk
hoogteTovNap Number Geeft de hoogte ten opzichte van NAP in meters. Bij een positieve waarde ligt het peilmerk boven NAP. Bij een negatieve waarde ligt het peilmerk onder NAP
jaar Integer Het jaar van waterpassing, behorende bij de hoogte
merkCode String Gebruikte peilmerk code
merkOmschrijving String Gebruikte peilmerk omschrijving
omschrijving String Beschrijving van het object waarin het peilmerk zich bevindt
windrichting String De windrichting van het muurvlak is die zijde waarheen het vlak van de muur, waarin het peilmerk zich bevindt, is gericht. Is er 'Z' aangegeven, dan ligt het betreffende muurvlak op het zuiden
xCoordinaatMuurvlak Number De muurvlakcoördinaten (in centimeters) geven de positie aan van het peilmerk op het betreffende muurvlak. De horizontale maat (x) is de maat ten opzichte van een van de uiteinden van het muurvlak
yCoordinaatMuurvlak Number De muurvlakcoördinaten (in centimeters) geven de positie aan van het peilmerk op het betreffende muurvlak. De verticale maat (y) is de maat ten opzichte van het ondereinde van het muurvlak (positief) of ten opzichte van het boveneinde van het muurvlak (negatief)
rwsNummer String Nummer dat Rijkswaterstaat hanteert voor een meetbout
geometrie Geometry Geometrische ligging van het peilmerk
statusCode Integer Status van het peilmerk code
statusOmschrijving String Status van het peilmerk omschrijving
vervaldatum Date Vervaldatum van het peilmerk
ligtInBouwblok Object (relatie) Het bouwblok waarbinnen het peilmerk ligt
ligtInBouwblok.identificatie String (relatie) Het bouwblok waarbinnen het peilmerk ligt
ligtInBouwblok.volgnummer Integer (relatie) Het bouwblok waarbinnen het peilmerk ligt
publiceerbaar Boolean Publiceerbaar ja of nee

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
geometrie GeoJSON of GEOMETRY(x y ...) Test op exacte waarde (==)
hoogteTovNap Getal Test op exacte waarde (==)
hoogteTovNap[lt] Test op kleiner dan (<).
hoogteTovNap[not] Test of waarde niet overeenkomt (!=).
hoogteTovNap[gte] Test op groter dan of gelijk (>=).
hoogteTovNap[gt] Test op groter dan (>).
hoogteTovNap[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
hoogteTovNap[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
hoogteTovNap[lte] Test op kleiner dan of gelijk (<=).
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).
jaar Geheel getal Test op exacte waarde (==)
jaar[lt] Test op kleiner dan (<).
jaar[not] Test of waarde niet overeenkomt (!=).
jaar[gte] Test op groter dan of gelijk (>=).
jaar[gt] Test op groter dan (>).
jaar[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
jaar[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
jaar[lte] Test op kleiner dan of gelijk (<=).
ligtInBouwblok.identificatie Tekst Test op exacte waarde (==)
ligtInBouwblok.identificatie[isempty] true | false Test of de waarde leeg is (== '' / != '')
ligtInBouwblok.identificatie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
ligtInBouwblok.identificatie[not] Test of waarde niet overeenkomt (!=).
ligtInBouwblok.identificatie[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
ligtInBouwblok.identificatie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
ligtInBouwblok.volgnummer Geheel getal Test op exacte waarde (==)
ligtInBouwblok.volgnummer[lt] Test op kleiner dan (<).
ligtInBouwblok.volgnummer[not] Test of waarde niet overeenkomt (!=).
ligtInBouwblok.volgnummer[gte] Test op groter dan of gelijk (>=).
ligtInBouwblok.volgnummer[gt] Test op groter dan (>).
ligtInBouwblok.volgnummer[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
ligtInBouwblok.volgnummer[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
ligtInBouwblok.volgnummer[lte] Test op kleiner dan of gelijk (<=).
merkCode Tekst Test op exacte waarde (==)
merkCode[isempty] true | false Test of de waarde leeg is (== '' / != '')
merkCode[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
merkCode[not] Test of waarde niet overeenkomt (!=).
merkCode[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
merkCode[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
merkOmschrijving Tekst Test op exacte waarde (==)
merkOmschrijving[isempty] true | false Test of de waarde leeg is (== '' / != '')
merkOmschrijving[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
merkOmschrijving[not] Test of waarde niet overeenkomt (!=).
merkOmschrijving[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
merkOmschrijving[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
omschrijving Tekst Test op exacte waarde (==)
omschrijving[isempty] true | false Test of de waarde leeg is (== '' / != '')
omschrijving[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
omschrijving[not] Test of waarde niet overeenkomt (!=).
omschrijving[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
omschrijving[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
publiceerbaar true | false Test op exacte waarde (==)
publiceerbaar[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
rwsNummer Tekst Test op exacte waarde (==)
rwsNummer[isempty] true | false Test of de waarde leeg is (== '' / != '')
rwsNummer[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
rwsNummer[not] Test of waarde niet overeenkomt (!=).
rwsNummer[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
rwsNummer[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
statusCode Geheel getal Test op exacte waarde (==)
statusCode[lt] Test op kleiner dan (<).
statusCode[not] Test of waarde niet overeenkomt (!=).
statusCode[gte] Test op groter dan of gelijk (>=).
statusCode[gt] Test op groter dan (>).
statusCode[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
statusCode[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
statusCode[lte] Test op kleiner dan of gelijk (<=).
statusOmschrijving Tekst Test op exacte waarde (==)
statusOmschrijving[isempty] true | false Test of de waarde leeg is (== '' / != '')
statusOmschrijving[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
statusOmschrijving[not] Test of waarde niet overeenkomt (!=).
statusOmschrijving[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
statusOmschrijving[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
vervaldatum yyyy-mm-dd Test op exacte waarde (==)
vervaldatum[lt] Test op kleiner dan (<).
vervaldatum[not] Test of waarde niet overeenkomt (!=).
vervaldatum[gte] Test op groter dan of gelijk (>=).
vervaldatum[gt] Test op groter dan (>).
vervaldatum[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
vervaldatum[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
vervaldatum[lte] Test op kleiner dan of gelijk (<=).
windrichting Tekst Test op exacte waarde (==)
windrichting[isempty] true | false Test of de waarde leeg is (== '' / != '')
windrichting[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
windrichting[not] Test of waarde niet overeenkomt (!=).
windrichting[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
windrichting[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
xCoordinaatMuurvlak Getal Test op exacte waarde (==)
xCoordinaatMuurvlak[lt] Test op kleiner dan (<).
xCoordinaatMuurvlak[not] Test of waarde niet overeenkomt (!=).
xCoordinaatMuurvlak[gte] Test op groter dan of gelijk (>=).
xCoordinaatMuurvlak[gt] Test op groter dan (>).
xCoordinaatMuurvlak[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
xCoordinaatMuurvlak[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
xCoordinaatMuurvlak[lte] Test op kleiner dan of gelijk (<=).
yCoordinaatMuurvlak Getal Test op exacte waarde (==)
yCoordinaatMuurvlak[lt] Test op kleiner dan (<).
yCoordinaatMuurvlak[not] Test of waarde niet overeenkomt (!=).
yCoordinaatMuurvlak[gte] Test op groter dan of gelijk (>=).
yCoordinaatMuurvlak[gt] Test op groter dan (>).
yCoordinaatMuurvlak[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
yCoordinaatMuurvlak[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
yCoordinaatMuurvlak[lte] Test op kleiner dan of gelijk (<=).

Insluitbare relaties

De volgende velden kunnen ingesloten worden met ?_expandScope=...:

Relatie Tabel Omschrijving
ligtInBouwblok gebieden:bouwblokken