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

ID: 2
Versie: 0.0.1
Autorisatie: OPENBAAR
Licentie:
Eigenaar:
Uitgever: Datateam Stedelijke Ontwikkeling en Beheer
Bronhouder:

Endpoints

Swagger UI: /v1/aardgasvrijezones/

Tabellen

Buurt

Autorisatie: Geen, dit is openbare data.
REST URI: /v1/aardgasvrijezones/buurt/
CSV-export: /v1/aardgasvrijezones/buurt/?_format=csv
GeoJSON-export: /v1/aardgasvrijezones/buurt/?_format=geojson

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

Buurtinitiatief

Autorisatie: Geen, dit is openbare data.
REST URI: /v1/aardgasvrijezones/buurtinitiatief/
CSV-export: /v1/aardgasvrijezones/buurtinitiatief/?_format=csv
GeoJSON-export: /v1/aardgasvrijezones/buurtinitiatief/?_format=geojson

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