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 definities

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
sort Integer
variabele String
begrotingsProgramma String
thema String
label String
labelKort String
definitie String
bron String
peildatum String
verschijningsfrequentie String
rekeneenheid Integer
symbool String
groep String
format String
berekendeVariabelen String
themaKerncijfertabel String
tussenkopjeKerncijfertabel String
kleurenpalet Integer
legendaCode Integer
sdMinimumBevTotaal Integer
sdMinimumWvoorBag Integer
topicArea String
label1 String
definition String
referenceDate String
frequency String

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
begrotingsProgramma Tekst Test op exacte waarde (==)
begrotingsProgramma[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
begrotingsProgramma[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
begrotingsProgramma[not] Test of waarde niet overeenkomt (!=).
begrotingsProgramma[isempty] true | false Test of de waarde leeg is (== '' / != '')
begrotingsProgramma[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
berekendeVariabelen Tekst Test op exacte waarde (==)
berekendeVariabelen[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
berekendeVariabelen[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
berekendeVariabelen[not] Test of waarde niet overeenkomt (!=).
berekendeVariabelen[isempty] true | false Test of de waarde leeg is (== '' / != '')
berekendeVariabelen[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
bron Tekst Test op exacte waarde (==)
bron[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
bron[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
bron[not] Test of waarde niet overeenkomt (!=).
bron[isempty] true | false Test of de waarde leeg is (== '' / != '')
bron[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
definitie Tekst Test op exacte waarde (==)
definitie[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
definitie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
definitie[not] Test of waarde niet overeenkomt (!=).
definitie[isempty] true | false Test of de waarde leeg is (== '' / != '')
definitie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
definition Tekst Test op exacte waarde (==)
definition[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
definition[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
definition[not] Test of waarde niet overeenkomt (!=).
definition[isempty] true | false Test of de waarde leeg is (== '' / != '')
definition[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
format Tekst Test op exacte waarde (==)
format[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
format[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
format[not] Test of waarde niet overeenkomt (!=).
format[isempty] true | false Test of de waarde leeg is (== '' / != '')
format[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
frequency Tekst Test op exacte waarde (==)
frequency[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
frequency[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
frequency[not] Test of waarde niet overeenkomt (!=).
frequency[isempty] true | false Test of de waarde leeg is (== '' / != '')
frequency[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
groep Tekst Test op exacte waarde (==)
groep[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
groep[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
groep[not] Test of waarde niet overeenkomt (!=).
groep[isempty] true | false Test of de waarde leeg is (== '' / != '')
groep[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
kleurenpalet Geheel getal Test op exacte waarde (==)
kleurenpalet[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
kleurenpalet[gt] Test op groter dan (>).
kleurenpalet[lt] Test op kleiner dan (<).
kleurenpalet[lte] Test op kleiner dan of gelijk (<=).
kleurenpalet[not] Test of waarde niet overeenkomt (!=).
kleurenpalet[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
kleurenpalet[gte] Test op groter dan of gelijk (>=).
label Tekst Test op exacte waarde (==)
label[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
label[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
label[not] Test of waarde niet overeenkomt (!=).
label[isempty] true | false Test of de waarde leeg is (== '' / != '')
label[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
label1 Tekst Test op exacte waarde (==)
label1[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
label1[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
label1[not] Test of waarde niet overeenkomt (!=).
label1[isempty] true | false Test of de waarde leeg is (== '' / != '')
label1[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
labelKort Tekst Test op exacte waarde (==)
labelKort[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
labelKort[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
labelKort[not] Test of waarde niet overeenkomt (!=).
labelKort[isempty] true | false Test of de waarde leeg is (== '' / != '')
labelKort[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
legendaCode Geheel getal Test op exacte waarde (==)
legendaCode[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
legendaCode[gt] Test op groter dan (>).
legendaCode[lt] Test op kleiner dan (<).
legendaCode[lte] Test op kleiner dan of gelijk (<=).
legendaCode[not] Test of waarde niet overeenkomt (!=).
legendaCode[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
legendaCode[gte] Test op groter dan of gelijk (>=).
peildatum Tekst Test op exacte waarde (==)
peildatum[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
peildatum[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
peildatum[not] Test of waarde niet overeenkomt (!=).
peildatum[isempty] true | false Test of de waarde leeg is (== '' / != '')
peildatum[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
referenceDate Tekst Test op exacte waarde (==)
referenceDate[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
referenceDate[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
referenceDate[not] Test of waarde niet overeenkomt (!=).
referenceDate[isempty] true | false Test of de waarde leeg is (== '' / != '')
referenceDate[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
rekeneenheid Geheel getal Test op exacte waarde (==)
rekeneenheid[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
rekeneenheid[gt] Test op groter dan (>).
rekeneenheid[lt] Test op kleiner dan (<).
rekeneenheid[lte] Test op kleiner dan of gelijk (<=).
rekeneenheid[not] Test of waarde niet overeenkomt (!=).
rekeneenheid[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
rekeneenheid[gte] Test op groter dan of gelijk (>=).
sdMinimumBevTotaal Geheel getal Test op exacte waarde (==)
sdMinimumBevTotaal[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
sdMinimumBevTotaal[gt] Test op groter dan (>).
sdMinimumBevTotaal[lt] Test op kleiner dan (<).
sdMinimumBevTotaal[lte] Test op kleiner dan of gelijk (<=).
sdMinimumBevTotaal[not] Test of waarde niet overeenkomt (!=).
sdMinimumBevTotaal[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
sdMinimumBevTotaal[gte] Test op groter dan of gelijk (>=).
sdMinimumWvoorBag Geheel getal Test op exacte waarde (==)
sdMinimumWvoorBag[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
sdMinimumWvoorBag[gt] Test op groter dan (>).
sdMinimumWvoorBag[lt] Test op kleiner dan (<).
sdMinimumWvoorBag[lte] Test op kleiner dan of gelijk (<=).
sdMinimumWvoorBag[not] Test of waarde niet overeenkomt (!=).
sdMinimumWvoorBag[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
sdMinimumWvoorBag[gte] Test op groter dan of gelijk (>=).
sort Geheel getal Test op exacte waarde (==)
sort[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
sort[gt] Test op groter dan (>).
sort[lt] Test op kleiner dan (<).
sort[lte] Test op kleiner dan of gelijk (<=).
sort[not] Test of waarde niet overeenkomt (!=).
sort[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
sort[gte] Test op groter dan of gelijk (>=).
symbool Tekst Test op exacte waarde (==)
symbool[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
symbool[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
symbool[not] Test of waarde niet overeenkomt (!=).
symbool[isempty] true | false Test of de waarde leeg is (== '' / != '')
symbool[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
thema Tekst Test op exacte waarde (==)
thema[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
thema[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
thema[not] Test of waarde niet overeenkomt (!=).
thema[isempty] true | false Test of de waarde leeg is (== '' / != '')
thema[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
themaKerncijfertabel Tekst Test op exacte waarde (==)
themaKerncijfertabel[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
themaKerncijfertabel[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
themaKerncijfertabel[not] Test of waarde niet overeenkomt (!=).
themaKerncijfertabel[isempty] true | false Test of de waarde leeg is (== '' / != '')
themaKerncijfertabel[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
topicArea Tekst Test op exacte waarde (==)
topicArea[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
topicArea[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
topicArea[not] Test of waarde niet overeenkomt (!=).
topicArea[isempty] true | false Test of de waarde leeg is (== '' / != '')
topicArea[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
tussenkopjeKerncijfertabel Tekst Test op exacte waarde (==)
tussenkopjeKerncijfertabel[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
tussenkopjeKerncijfertabel[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
tussenkopjeKerncijfertabel[not] Test of waarde niet overeenkomt (!=).
tussenkopjeKerncijfertabel[isempty] true | false Test of de waarde leeg is (== '' / != '')
tussenkopjeKerncijfertabel[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
variabele Tekst Test op exacte waarde (==)
variabele[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
variabele[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
variabele[not] Test of waarde niet overeenkomt (!=).
variabele[isempty] true | false Test of de waarde leeg is (== '' / != '')
variabele[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
verschijningsfrequentie Tekst Test op exacte waarde (==)
verschijningsfrequentie[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
verschijningsfrequentie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
verschijningsfrequentie[not] Test of waarde niet overeenkomt (!=).
verschijningsfrequentie[isempty] true | false Test of de waarde leeg is (== '' / != '')
verschijningsfrequentie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).

Kerncijfers

Kerncijfers op het niveau van de meest gebruikte gebiedsindelingen in Amsterdam: stadsdelen, de 22 gebieden van het gebiedsgericht werken, wijken, buurten, winkel- en werkgebieden, PC4 en twee alternatieve buurtindelingen van de stadsdelen.

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id String
jaar Integer
gebiedcode15 String
waarde Number
indicatorDefinitie String (relatie) De variabele in kwestie.

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
gebiedcode15 Tekst Test op exacte waarde (==)
gebiedcode15[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
gebiedcode15[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
gebiedcode15[not] Test of waarde niet overeenkomt (!=).
gebiedcode15[isempty] true | false Test of de waarde leeg is (== '' / != '')
gebiedcode15[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id Tekst Test op exacte waarde (==)
id[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
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).
indicatorDefinitie.variabele Tekst Test op exacte waarde (==)
indicatorDefinitie.variabele[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
indicatorDefinitie.variabele[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
indicatorDefinitie.variabele[not] Test of waarde niet overeenkomt (!=).
indicatorDefinitie.variabele[isempty] true | false Test of de waarde leeg is (== '' / != '')
indicatorDefinitie.variabele[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
jaar Geheel getal Test op exacte waarde (==)
jaar[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
jaar[gt] Test op groter dan (>).
jaar[lt] Test op kleiner dan (<).
jaar[lte] Test op kleiner dan of gelijk (<=).
jaar[not] Test of waarde niet overeenkomt (!=).
jaar[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
jaar[gte] Test op groter dan of gelijk (>=).
waarde Getal Test op exacte waarde (==)
waarde[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
waarde[gt] Test op groter dan (>).
waarde[lt] Test op kleiner dan (<).
waarde[lte] Test op kleiner dan of gelijk (<=).
waarde[not] Test of waarde niet overeenkomt (!=).
waarde[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
waarde[gte] Test op groter dan of gelijk (>=).

Insluitbare relaties

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

Relatie Tabel Omschrijving
indicatorDefinitie bbga:indicatorenDefinities

Statistieken

Stedelijke gemiddelden en standaardafwijkingen.

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id String
jaar Integer
gemiddelde Number
standaardafwijking Number
bron String
indicatorDefinitie String (relatie) De variabele in kwestie.

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
bron Tekst Test op exacte waarde (==)
bron[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
bron[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
bron[not] Test of waarde niet overeenkomt (!=).
bron[isempty] true | false Test of de waarde leeg is (== '' / != '')
bron[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
gemiddelde Getal Test op exacte waarde (==)
gemiddelde[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
gemiddelde[gt] Test op groter dan (>).
gemiddelde[lt] Test op kleiner dan (<).
gemiddelde[lte] Test op kleiner dan of gelijk (<=).
gemiddelde[not] Test of waarde niet overeenkomt (!=).
gemiddelde[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
gemiddelde[gte] Test op groter dan of gelijk (>=).
id Tekst Test op exacte waarde (==)
id[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
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).
indicatorDefinitie.variabele Tekst Test op exacte waarde (==)
indicatorDefinitie.variabele[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
indicatorDefinitie.variabele[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
indicatorDefinitie.variabele[not] Test of waarde niet overeenkomt (!=).
indicatorDefinitie.variabele[isempty] true | false Test of de waarde leeg is (== '' / != '')
indicatorDefinitie.variabele[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
jaar Geheel getal Test op exacte waarde (==)
jaar[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
jaar[gt] Test op groter dan (>).
jaar[lt] Test op kleiner dan (<).
jaar[lte] Test op kleiner dan of gelijk (<=).
jaar[not] Test of waarde niet overeenkomt (!=).
jaar[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
jaar[gte] Test op groter dan of gelijk (>=).
standaardafwijking Getal Test op exacte waarde (==)
standaardafwijking[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
standaardafwijking[gt] Test op groter dan (>).
standaardafwijking[lt] Test op kleiner dan (<).
standaardafwijking[lte] Test op kleiner dan of gelijk (<=).
standaardafwijking[not] Test of waarde niet overeenkomt (!=).
standaardafwijking[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
standaardafwijking[gte] Test op groter dan of gelijk (>=).

Insluitbare relaties

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

Relatie Tabel Omschrijving
indicatorDefinitie bbga:indicatorenDefinities