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

Indicatoren

Alle indicatoren (variabelen) en hun metadata

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id Integer ☑ Unieke identificatie van de indicator
naam String Unieke naam van de indicator
label String Beknopte label van de indicator t.b.v. weergave
labelUk String Beknopte label van de indicator in het Brits-Engels t.b.v. weergave
definitie String Definitie, die ten grondslag ligt van de indicator
definitieUk String Definitie in het Brits-Engels, die ten grondslag ligt van de indicator
beschrijving String Beschrijving en overige informatie over de indicator
berekening String Rekenformule, die is gebruikt om de waarde van de indicator te berekenen
bron String Herkomst van de indicator en bijhorende definitie
thema String Thematische indeling waaronder de indicator valt
eenheid String Eenheid waarin de indicator wordt uitgedrukt
symbool String Symbool, behorende bij de eenheid
decimalen Integer Aantal decimalen, waarin de waarde van de indicator moet worden gepubliceerd
dimensieNaam String Naam van de dimensie, waartoe de indicator behoort
dimensieCode String Code van de dimensie, waartoe de dimensie behoort
dimensieBeschrijving String Beschrijving van de dimensie, waartoe de dimensie behoort
extraAttributen Json Vrij veld om aanvullende attributen met hun waarde op te slaan, die nodig kunnen zijn voor verdere visualisatie
parent String Naam van een indicator, waartoe de indicator behoort
verantwoordelijke String Naam van het team binnen de organisatie, dat verantwoordelijk is voor de indicator

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
berekening Tekst Test op exacte waarde (==)
berekening[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
berekening[not] None Test of waarde niet overeenkomt (!=).
berekening[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
berekening[isempty] true of false Test of de waarde leeg is (== '' / != '')
berekening[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
beschrijving Tekst Test op exacte waarde (==)
beschrijving[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
beschrijving[not] None Test of waarde niet overeenkomt (!=).
beschrijving[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
beschrijving[isempty] true of false Test of de waarde leeg is (== '' / != '')
beschrijving[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
bron Tekst Test op exacte waarde (==)
bron[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
bron[not] None Test of waarde niet overeenkomt (!=).
bron[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
bron[isempty] true of false Test of de waarde leeg is (== '' / != '')
bron[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
decimalen Geheel getal Test op exacte waarde (==)
decimalen[gte] None Test op groter dan of gelijk (>=).
decimalen[lte] None Test op kleiner dan of gelijk (<=).
decimalen[not] None Test of waarde niet overeenkomt (!=).
decimalen[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
decimalen[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
decimalen[gt] None Test op groter dan (>).
decimalen[lt] None Test op kleiner dan (<).
definitie Tekst Test op exacte waarde (==)
definitie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
definitie[not] None Test of waarde niet overeenkomt (!=).
definitie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
definitie[isempty] true of false Test of de waarde leeg is (== '' / != '')
definitie[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
definitieUk Tekst Test op exacte waarde (==)
definitieUk[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
definitieUk[not] None Test of waarde niet overeenkomt (!=).
definitieUk[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
definitieUk[isempty] true of false Test of de waarde leeg is (== '' / != '')
definitieUk[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
dimensieBeschrijving Tekst Test op exacte waarde (==)
dimensieBeschrijving[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
dimensieBeschrijving[not] None Test of waarde niet overeenkomt (!=).
dimensieBeschrijving[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
dimensieBeschrijving[isempty] true of false Test of de waarde leeg is (== '' / != '')
dimensieBeschrijving[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
dimensieCode Tekst Test op exacte waarde (==)
dimensieCode[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
dimensieCode[not] None Test of waarde niet overeenkomt (!=).
dimensieCode[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
dimensieCode[isempty] true of false Test of de waarde leeg is (== '' / != '')
dimensieCode[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
dimensieNaam Tekst Test op exacte waarde (==)
dimensieNaam[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
dimensieNaam[not] None Test of waarde niet overeenkomt (!=).
dimensieNaam[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
dimensieNaam[isempty] true of false Test of de waarde leeg is (== '' / != '')
dimensieNaam[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
eenheid Tekst Test op exacte waarde (==)
eenheid[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
eenheid[not] None Test of waarde niet overeenkomt (!=).
eenheid[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
eenheid[isempty] true of false Test of de waarde leeg is (== '' / != '')
eenheid[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id Geheel getal Test op exacte waarde (==)
id[gte] None Test op groter dan of gelijk (>=).
id[lte] None Test op kleiner dan of gelijk (<=).
id[lt] None Test op kleiner dan (<).
id[not] None Test of waarde niet overeenkomt (!=).
id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id[gt] None Test op groter dan (>).
id[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
label Tekst Test op exacte waarde (==)
label[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
label[not] None Test of waarde niet overeenkomt (!=).
label[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
label[isempty] true of false Test of de waarde leeg is (== '' / != '')
label[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
labelUk Tekst Test op exacte waarde (==)
labelUk[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
labelUk[not] None Test of waarde niet overeenkomt (!=).
labelUk[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
labelUk[isempty] true of false Test of de waarde leeg is (== '' / != '')
labelUk[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
naam Tekst Test op exacte waarde (==)
naam[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
naam[not] None Test of waarde niet overeenkomt (!=).
naam[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
naam[isempty] true of false Test of de waarde leeg is (== '' / != '')
naam[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
parent Tekst Test op exacte waarde (==)
parent[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
parent[not] None Test of waarde niet overeenkomt (!=).
parent[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
parent[isempty] true of false Test of de waarde leeg is (== '' / != '')
parent[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
symbool Tekst Test op exacte waarde (==)
symbool[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
symbool[not] None Test of waarde niet overeenkomt (!=).
symbool[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
symbool[isempty] true of false Test of de waarde leeg is (== '' / != '')
symbool[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
thema Tekst Test op exacte waarde (==)
thema[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
thema[not] None Test of waarde niet overeenkomt (!=).
thema[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
thema[isempty] true of false Test of de waarde leeg is (== '' / != '')
thema[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
verantwoordelijke Tekst Test op exacte waarde (==)
verantwoordelijke[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
verantwoordelijke[not] None Test of waarde niet overeenkomt (!=).
verantwoordelijke[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
verantwoordelijke[isempty] true of false Test of de waarde leeg is (== '' / != '')
verantwoordelijke[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).

Cijfers

Alle cijfers, gerelateerd aan de bijhorende indicatoren en dimensies

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id Integer ☑ Unieke identificatie van het cijfer i.c.m. de bijhorende indicator en dimensies
ruimtelijkeDimensieType String Type ruimtelijke indeling
ruimtelijkeDimensieDatum Date Datum waarop de ruimtelijke indeling van kracht is geworden
ruimtelijkeDimensieCode String Unieke code van de ruimtelijke indeling binnen hetzelfde type en datum
ruimtelijkeDimensieNaam String Unieke naam van de ruimtelijke indeling binnen hetzelfde type en datum
temporeleDimensieType String Type van de tijddimensie. Dit kan een vaste peildatum zijn of een periode
begindatum Datetime Begindatum waarop de tijddimensie is begonnen
einddatum Datetime Einddatum waarop de tijddimensie is geëindigd
indicator String Naam van de indicator waarop het cijfer betrekking heeft
waarde Number Waarde van het cijfer met het aantal decimalen, zoals vastgelegd bij de indicator

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
begindatum yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] Test op exacte waarde (==)
begindatum[gte] None Test op groter dan of gelijk (>=).
begindatum[lte] None Test op kleiner dan of gelijk (<=).
begindatum[not] None Test of waarde niet overeenkomt (!=).
begindatum[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
begindatum[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
begindatum[gt] None Test op groter dan (>).
begindatum[lt] None Test op kleiner dan (<).
einddatum yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] Test op exacte waarde (==)
einddatum[gte] None Test op groter dan of gelijk (>=).
einddatum[lte] None Test op kleiner dan of gelijk (<=).
einddatum[not] None Test of waarde niet overeenkomt (!=).
einddatum[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
einddatum[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
einddatum[gt] None Test op groter dan (>).
einddatum[lt] None Test op kleiner dan (<).
id Geheel getal Test op exacte waarde (==)
id[gte] None Test op groter dan of gelijk (>=).
id[lte] None Test op kleiner dan of gelijk (<=).
id[lt] None Test op kleiner dan (<).
id[not] None Test of waarde niet overeenkomt (!=).
id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id[gt] None Test op groter dan (>).
id[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
indicator Tekst Test op exacte waarde (==)
indicator[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
indicator[not] None Test of waarde niet overeenkomt (!=).
indicator[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
indicator[isempty] true of false Test of de waarde leeg is (== '' / != '')
indicator[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
ruimtelijkeDimensieCode Tekst Test op exacte waarde (==)
ruimtelijkeDimensieCode[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
ruimtelijkeDimensieCode[not] None Test of waarde niet overeenkomt (!=).
ruimtelijkeDimensieCode[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
ruimtelijkeDimensieCode[isempty] true of false Test of de waarde leeg is (== '' / != '')
ruimtelijkeDimensieCode[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
ruimtelijkeDimensieDatum yyyy-mm-dd Test op exacte waarde (==)
ruimtelijkeDimensieDatum[gte] None Test op groter dan of gelijk (>=).
ruimtelijkeDimensieDatum[lte] None Test op kleiner dan of gelijk (<=).
ruimtelijkeDimensieDatum[not] None Test of waarde niet overeenkomt (!=).
ruimtelijkeDimensieDatum[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
ruimtelijkeDimensieDatum[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
ruimtelijkeDimensieDatum[gt] None Test op groter dan (>).
ruimtelijkeDimensieDatum[lt] None Test op kleiner dan (<).
ruimtelijkeDimensieNaam Tekst Test op exacte waarde (==)
ruimtelijkeDimensieNaam[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
ruimtelijkeDimensieNaam[not] None Test of waarde niet overeenkomt (!=).
ruimtelijkeDimensieNaam[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
ruimtelijkeDimensieNaam[isempty] true of false Test of de waarde leeg is (== '' / != '')
ruimtelijkeDimensieNaam[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
ruimtelijkeDimensieType Tekst Test op exacte waarde (==)
ruimtelijkeDimensieType[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
ruimtelijkeDimensieType[not] None Test of waarde niet overeenkomt (!=).
ruimtelijkeDimensieType[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
ruimtelijkeDimensieType[isempty] true of false Test of de waarde leeg is (== '' / != '')
ruimtelijkeDimensieType[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
temporeleDimensieType Tekst Test op exacte waarde (==)
temporeleDimensieType[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
temporeleDimensieType[not] None Test of waarde niet overeenkomt (!=).
temporeleDimensieType[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
temporeleDimensieType[isempty] true of false Test of de waarde leeg is (== '' / != '')
temporeleDimensieType[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
waarde Getal Test op exacte waarde (==)
waarde[gte] None Test op groter dan of gelijk (>=).
waarde[lte] None Test op kleiner dan of gelijk (<=).
waarde[not] None Test of waarde niet overeenkomt (!=).
waarde[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
waarde[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
waarde[gt] None Test op groter dan (>).
waarde[lt] None Test op kleiner dan (<).

Toepassingen

Alle cijfers, gerelateerd aan de bijhorende indicatoren en dimensies

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id Integer ☑ Unieke identificatie
naam String Naam van de toepassing
versie String Versie van de toepassing
ruimtelijkeDimensie String Ruimtelijke indeling
temporeleDimensie String Type van de tijddimensie. Dit kan een vaste peildatum zijn of een periode
indicator String Naam van de indicator

De volgende query-parameters zijn te gebruiken:

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