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

Opafstapplaats

Deze dataset bevat de gegevens over op- en afstaplocaties voor pleziervaart, passagiersvaart en transport over het water. De gemeente wil daarbij voldoende ruimte voor bewoners creëren, onder andere doorbeheersing van het aantal vaarbewegingen en het spreiden van plezier- en passagiersvaart.

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id String Uniek identificerend kenmerk van het record
volgnr String Volgnummer van het object
tekstOnMouseover String Volgnummer + locatiebeschrijving
kleurOpKaart String Gewenste kleurweergave op de kaart
opEnAfstap String Indicatie ove opstap of afstaplocatie
laadLos String Indicatie voor laad en los doeleinden.
eLaadpunt String Indicatie electrische laadpunt voorziening.
geometrie Geometry Geometrie in RD (epsg:28992)
verwerkingsdatum Date Datum waarop het object in het systeem is geregistreerd
gbdBuurt String (relatie) Unieke identificatie van het object

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
eLaadpunt Tekst Test op exacte waarde (==)
eLaadpunt[not] Test of waarde niet overeenkomt (!=).
eLaadpunt[isempty] true | false Test of de waarde leeg is (== '' / != '')
eLaadpunt[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
eLaadpunt[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
eLaadpunt[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
gbdBuurt.identificatie Tekst Test op exacte waarde (==)
gbdBuurt.identificatie[not] Test of waarde niet overeenkomt (!=).
gbdBuurt.identificatie[isempty] true | false Test of de waarde leeg is (== '' / != '')
gbdBuurt.identificatie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
gbdBuurt.identificatie[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
gbdBuurt.identificatie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
geometrie GeoJSON of GEOMETRY(x y ...) Test op exacte waarde (==)
geometrie[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
geometrie[contains] Kommagescheiden lijst Test of er een intersectie is met de waarde.
geometrie[intersects] GeoJSON of POLYGON(x y ...) Test of er een intersectie is met de waarde.
geometrie[not] Test of waarde niet overeenkomt (!=).
id Tekst Test op exacte waarde (==)
id[not] Test of waarde niet overeenkomt (!=).
id[isempty] true | false Test of de waarde leeg is (== '' / != '')
id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
kleurOpKaart Tekst Test op exacte waarde (==)
kleurOpKaart[not] Test of waarde niet overeenkomt (!=).
kleurOpKaart[isempty] true | false Test of de waarde leeg is (== '' / != '')
kleurOpKaart[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
kleurOpKaart[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
kleurOpKaart[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
laadLos Tekst Test op exacte waarde (==)
laadLos[not] Test of waarde niet overeenkomt (!=).
laadLos[isempty] true | false Test of de waarde leeg is (== '' / != '')
laadLos[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
laadLos[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
laadLos[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
opEnAfstap Tekst Test op exacte waarde (==)
opEnAfstap[not] Test of waarde niet overeenkomt (!=).
opEnAfstap[isempty] true | false Test of de waarde leeg is (== '' / != '')
opEnAfstap[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
opEnAfstap[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
opEnAfstap[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
tekstOnMouseover Tekst Test op exacte waarde (==)
tekstOnMouseover[not] Test of waarde niet overeenkomt (!=).
tekstOnMouseover[isempty] true | false Test of de waarde leeg is (== '' / != '')
tekstOnMouseover[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
tekstOnMouseover[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
tekstOnMouseover[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
verwerkingsdatum yyyy-mm-dd Test op exacte waarde (==)
verwerkingsdatum[not] Test of waarde niet overeenkomt (!=).
verwerkingsdatum[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
verwerkingsdatum[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
verwerkingsdatum[gte] Test op groter dan of gelijk (>=).
verwerkingsdatum[lte] Test op kleiner dan of gelijk (<=).
verwerkingsdatum[lt] Test op kleiner dan (<).
verwerkingsdatum[gt] Test op groter dan (>).
volgnr Tekst Test op exacte waarde (==)
volgnr[not] Test of waarde niet overeenkomt (!=).
volgnr[isempty] true | false Test of de waarde leeg is (== '' / != '')
volgnr[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
volgnr[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
volgnr[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.

Insluitbare relaties

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

Relatie Tabel Omschrijving
gbdBuurt gebieden:buurten Amsterdam is opgedeeld in buurten ten behoeve van statistieken, een buurt is aaneengesloten gedeelte binnen een wijk, waarvan de grenzen zo veel mogelijk gebaseerd zijn op topografische elementen

Ligplaats

Deze dataset bevat de gegevens over de ligplaatsen register in Amsterdam.

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id String Uniek identificerend kenmerk van het record
naamVaartuig String Naam van vaartuig.
naamKlantKvk String Naam van klant volgens KvK
ligplaatsSegment String Categorie van lengte van vaartuigen
kenmerkVergunning String Kenmerk van ligplaastvergunning
datumEindeVergunning String Einde van verleende vergunning
idLigplaats String Id veld (niet uniek)
verwerkingsdatum Date
gbdBuurt String (relatie) Unieke identificatie van het object
locatieAdres String Locatie beschrijving
geometrie Geometry Geometrie in RD (epsg:28992)

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
datumEindeVergunning Tekst Test op exacte waarde (==)
datumEindeVergunning[not] Test of waarde niet overeenkomt (!=).
datumEindeVergunning[isempty] true | false Test of de waarde leeg is (== '' / != '')
datumEindeVergunning[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
datumEindeVergunning[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
datumEindeVergunning[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
gbdBuurt.identificatie Tekst Test op exacte waarde (==)
gbdBuurt.identificatie[not] Test of waarde niet overeenkomt (!=).
gbdBuurt.identificatie[isempty] true | false Test of de waarde leeg is (== '' / != '')
gbdBuurt.identificatie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
gbdBuurt.identificatie[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
gbdBuurt.identificatie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
geometrie GeoJSON of GEOMETRY(x y ...) Test op exacte waarde (==)
geometrie[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
geometrie[contains] Kommagescheiden lijst Test of er een intersectie is met de waarde.
geometrie[intersects] GeoJSON of POLYGON(x y ...) Test of er een intersectie is met de waarde.
geometrie[not] Test of waarde niet overeenkomt (!=).
id Tekst Test op exacte waarde (==)
id[not] Test of waarde niet overeenkomt (!=).
id[isempty] true | false Test of de waarde leeg is (== '' / != '')
id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
idLigplaats Tekst Test op exacte waarde (==)
idLigplaats[not] Test of waarde niet overeenkomt (!=).
idLigplaats[isempty] true | false Test of de waarde leeg is (== '' / != '')
idLigplaats[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
idLigplaats[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
idLigplaats[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
kenmerkVergunning Tekst Test op exacte waarde (==)
kenmerkVergunning[not] Test of waarde niet overeenkomt (!=).
kenmerkVergunning[isempty] true | false Test of de waarde leeg is (== '' / != '')
kenmerkVergunning[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
kenmerkVergunning[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
kenmerkVergunning[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
ligplaatsSegment Tekst Test op exacte waarde (==)
ligplaatsSegment[not] Test of waarde niet overeenkomt (!=).
ligplaatsSegment[isempty] true | false Test of de waarde leeg is (== '' / != '')
ligplaatsSegment[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
ligplaatsSegment[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
ligplaatsSegment[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
locatieAdres Tekst Test op exacte waarde (==)
locatieAdres[not] Test of waarde niet overeenkomt (!=).
locatieAdres[isempty] true | false Test of de waarde leeg is (== '' / != '')
locatieAdres[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
locatieAdres[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
locatieAdres[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
naamKlantKvk Tekst Test op exacte waarde (==)
naamKlantKvk[not] Test of waarde niet overeenkomt (!=).
naamKlantKvk[isempty] true | false Test of de waarde leeg is (== '' / != '')
naamKlantKvk[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
naamKlantKvk[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
naamKlantKvk[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
naamVaartuig Tekst Test op exacte waarde (==)
naamVaartuig[not] Test of waarde niet overeenkomt (!=).
naamVaartuig[isempty] true | false Test of de waarde leeg is (== '' / != '')
naamVaartuig[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
naamVaartuig[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
naamVaartuig[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
verwerkingsdatum yyyy-mm-dd Test op exacte waarde (==)
verwerkingsdatum[not] Test of waarde niet overeenkomt (!=).
verwerkingsdatum[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
verwerkingsdatum[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
verwerkingsdatum[gte] Test op groter dan of gelijk (>=).
verwerkingsdatum[lte] Test op kleiner dan of gelijk (<=).
verwerkingsdatum[lt] Test op kleiner dan (<).
verwerkingsdatum[gt] Test op groter dan (>).

Insluitbare relaties

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

Relatie Tabel Omschrijving
gbdBuurt gebieden:buurten Amsterdam is opgedeeld in buurten ten behoeve van statistieken, een buurt is aaneengesloten gedeelte binnen een wijk, waarvan de grenzen zo veel mogelijk gebaseerd zijn op topografische elementen