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

Buurt

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id Integer ☑ Unieke aanduiding voor de (deels) gerealiseerde of geplande aardgasvrije buurt.
geometry Geometry Polygoon definitie van de (deels) gerealiseerde of geplande aardgasvrije buurt.
buurtCode String Code van de (deels) gerealiseerde of geplande aardgasvrije buurt.
buurtNaam String Naam van de (deels) gerealiseerde of geplande aardgasvrije buurt.
toelichting String Toelichting op inhoud van de (deels) gerealiseerde of geplande aardgasvrije buurt.
aandeelKookgas String Aandeel van hoeveelheid kookgas die van toepassing is op de (deels) gerealiseerde of geplande aardgasvrije buurt.

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
aandeelKookgas Tekst Test op exacte waarde (==)
aandeelKookgas[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
aandeelKookgas[isempty] true of false Test of de waarde leeg is (== '' / != '')
aandeelKookgas[not] None Test of waarde niet overeenkomt (!=).
aandeelKookgas[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
aandeelKookgas[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
buurtCode Tekst Test op exacte waarde (==)
buurtCode[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
buurtCode[isempty] true of false Test of de waarde leeg is (== '' / != '')
buurtCode[not] None Test of waarde niet overeenkomt (!=).
buurtCode[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
buurtCode[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
buurtNaam Tekst Test op exacte waarde (==)
buurtNaam[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
buurtNaam[isempty] true of false Test of de waarde leeg is (== '' / != '')
buurtNaam[not] None Test of waarde niet overeenkomt (!=).
buurtNaam[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
buurtNaam[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
geometry GeoJSON of GEOMETRY(x y ...) Test op exacte waarde (==)
id Geheel getal Test op exacte waarde (==)
id[gt] None Test op groter dan (>).
id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id[not] None Test of waarde niet overeenkomt (!=).
id[lte] None Test op kleiner dan of gelijk (<=).
id[lt] None Test op kleiner dan (<).
id[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[gte] None Test op groter dan of gelijk (>=).
toelichting Tekst Test op exacte waarde (==)
toelichting[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
toelichting[isempty] true of false Test of de waarde leeg is (== '' / != '')
toelichting[not] None Test of waarde niet overeenkomt (!=).
toelichting[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
toelichting[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).

Buurtinitiatief

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id Integer ☑ Unieke aanduiding voor het buurtinitiatief.
geometry Geometry Punt definitie van voor het buurtinitiatief.
buurtinitiatiefType String Type buurtinitiatief: Dit kan zijn CityDeal-Buurt, particulier of beide.
buurtNaam String Naam van de buurt.
xCoordinaat Number X coördinaat van het buurtinitiatief.
yCoordinaat Number Y coördinaat van het buurtinitiatief.

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
buurtNaam Tekst Test op exacte waarde (==)
buurtNaam[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
buurtNaam[isempty] true of false Test of de waarde leeg is (== '' / != '')
buurtNaam[not] None Test of waarde niet overeenkomt (!=).
buurtNaam[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
buurtNaam[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
buurtinitiatiefType Tekst Test op exacte waarde (==)
buurtinitiatiefType[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
buurtinitiatiefType[isempty] true of false Test of de waarde leeg is (== '' / != '')
buurtinitiatiefType[not] None Test of waarde niet overeenkomt (!=).
buurtinitiatiefType[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
buurtinitiatiefType[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
geometry GeoJSON of GEOMETRY(x y ...) Test op exacte waarde (==)
id Geheel getal Test op exacte waarde (==)
id[gt] None Test op groter dan (>).
id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id[not] None Test of waarde niet overeenkomt (!=).
id[lte] None Test op kleiner dan of gelijk (<=).
id[lt] None Test op kleiner dan (<).
id[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[gte] None Test op groter dan of gelijk (>=).
xCoordinaat Getal Test op exacte waarde (==)
xCoordinaat[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
xCoordinaat[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
xCoordinaat[not] None Test of waarde niet overeenkomt (!=).
xCoordinaat[lte] None Test op kleiner dan of gelijk (<=).
xCoordinaat[lt] None Test op kleiner dan (<).
xCoordinaat[gt] None Test op groter dan (>).
xCoordinaat[gte] None Test op groter dan of gelijk (>=).
yCoordinaat Getal Test op exacte waarde (==)
yCoordinaat[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
yCoordinaat[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
yCoordinaat[not] None Test of waarde niet overeenkomt (!=).
yCoordinaat[lte] None Test op kleiner dan of gelijk (<=).
yCoordinaat[lt] None Test op kleiner dan (<).
yCoordinaat[gt] None Test op groter dan (>).
yCoordinaat[gte] None Test op groter dan of gelijk (>=).