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

Objecten

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id String ☑
volgnummer Integer ☑ Uniek volgnummer van de toestand van het object.
registratiedatum Datetime De datum waarop de toestand is geregistreerd.
wozobjectnummer String ☑ De unieke identificatie van een WOZ-object
gebruik Object Nadere aanduiding van het feitelijk gebruik van een WOZ-object zoals dat ten grondslag heeft gelegen aan de waardebepaling en voor zover relevant voor de afnemers, uitgedrukt in een code.
gebruik.gebruikCode Integer
gebruik.gebruikOmschrijving String
soortObject Object Aanduiding van het soort object ten behoeve van een correcte bepaling van de waarde.
soortObject.soortObjectCode Integer
soortObject.soortObjectOmschrijving String
beginGeldigheid Date De begindatum van een periode waarin één of meer gegevens die worden bijgehouden over een WOZ-object, een wijziging hebben ondergaan
eindGeldigheid Date De einddatum van een periode waarin één of meer gegevens die worden bijgehouden over een WOZ-object, een wijziging hebben ondergaan
bevatBrkKadastraalobject Array Relatie naar kadastraal object
bevatBrkKadastraalobject.identificatie String
bevatBrkKadastraalobject.volgnummer Integer
bevatBrkKadastraalobject.beginGeldigheid Date
bevatBrkKadastraalobject.eindGeldigheid Date
bestaatUitWozDeelobjecten Array Relatie naar de deelobjecten
bestaatUitWozDeelobjecten.wozdeelobjectnummer String
bestaatUitWozDeelobjecten.volgnummer Integer
bestaatUitWozDeelobjecten.beginGeldigheid Date
bestaatUitWozDeelobjecten.eindGeldigheid Date

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
beginGeldigheid yyyy-mm-dd Test op exacte waarde (==)
beginGeldigheid[gte] Test op groter dan of gelijk (>=).
beginGeldigheid[lt] Test op kleiner dan (<).
beginGeldigheid[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
beginGeldigheid[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
beginGeldigheid[lte] Test op kleiner dan of gelijk (<=).
beginGeldigheid[gt] Test op groter dan (>).
beginGeldigheid[not] Test of waarde niet overeenkomt (!=).
bestaatUitWozDeelobjecten value1,value2 Test op exacte waarde (==)
bestaatUitWozDeelobjecten[contains] Kommagescheiden lijst Test of er een intersectie is met de waarde.
bestaatUitWozDeelobjecten[not] Test of waarde niet overeenkomt (!=).
bestaatUitWozDeelobjecten[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
bestaatUitWozDeelobjecten[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
bevatBrkKadastraalobject value1,value2 Test op exacte waarde (==)
bevatBrkKadastraalobject[contains] Kommagescheiden lijst Test of er een intersectie is met de waarde.
bevatBrkKadastraalobject[not] Test of waarde niet overeenkomt (!=).
bevatBrkKadastraalobject[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
bevatBrkKadastraalobject[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
eindGeldigheid yyyy-mm-dd Test op exacte waarde (==)
eindGeldigheid[gte] Test op groter dan of gelijk (>=).
eindGeldigheid[lt] Test op kleiner dan (<).
eindGeldigheid[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
eindGeldigheid[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
eindGeldigheid[lte] Test op kleiner dan of gelijk (<=).
eindGeldigheid[gt] Test op groter dan (>).
eindGeldigheid[not] Test of waarde niet overeenkomt (!=).
geldigOp yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] Test op exacte waarde (==)
id Tekst Test op exacte waarde (==)
id[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
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[isempty] true | false Test of de waarde leeg is (== '' / != '')
id[not] Test of waarde niet overeenkomt (!=).
registratiedatum yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] Test op exacte waarde (==)
registratiedatum[gte] Test op groter dan of gelijk (>=).
registratiedatum[lt] Test op kleiner dan (<).
registratiedatum[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
registratiedatum[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
registratiedatum[lte] Test op kleiner dan of gelijk (<=).
registratiedatum[gt] Test op groter dan (>).
registratiedatum[not] Test of waarde niet overeenkomt (!=).
volgnummer Geheel getal Test op exacte waarde (==)
volgnummer[gte] Test op groter dan of gelijk (>=).
volgnummer[lt] Test op kleiner dan (<).
volgnummer[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
volgnummer[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
volgnummer[lte] Test op kleiner dan of gelijk (<=).
volgnummer[gt] Test op groter dan (>).
volgnummer[not] Test of waarde niet overeenkomt (!=).
wozobjectnummer Tekst Test op exacte waarde (==)
wozobjectnummer[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
wozobjectnummer[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
wozobjectnummer[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
wozobjectnummer[isempty] true | false Test of de waarde leeg is (== '' / != '')
wozobjectnummer[not] Test of waarde niet overeenkomt (!=).

Insluitbare relaties

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

Relatie Tabel Omschrijving
bestaatUitWozDeelobjecten woz:deelobjecten
bevatBrkKadastraalobject brk2:kadastraleobjecten

Deelobjecten

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id String ☑
volgnummer Integer ☑ Uniek volgnummer van de toestand van het object.
registratiedatum Datetime De datum waarop de toestand is geregistreerd.
wozdeelobjectnummer String ☑ De unieke identificatie van een WOZ-deelobject
deelnummer String Unieke identificatie WOZ-deelobject binnen het WOZ-object
wozobjectnummer String Van welk WOZ-object is dit WOZ-deelobject een onderdeel
soortObject Object Aanduiding van het soort object ten behoeve van een correcte bepaling van de waarde.
soortObject.soortObjectCode Integer
soortObject.soortObjectOmschrijving String
beginGeldigheid Date Een aanduiding op welk tijdstip het object is ontstaan
eindGeldigheid Date Een aanduiding op welk tijdstip het object is beëindigd
isVerbondenMetBagVerblijfsobject Object (relatie) Aan welk verblijfsobject heeft het WOZ-deelobject een relatie
isVerbondenMetBagVerblijfsobject.identificatie String (relatie) Aan welk verblijfsobject heeft het WOZ-deelobject een relatie
isVerbondenMetBagVerblijfsobject.volgnummer Integer (relatie) Aan welk verblijfsobject heeft het WOZ-deelobject een relatie
isVerbondenMetBagLigplaats Object (relatie) Aan welk ligplaats heeft het WOZ-deelobject een relatie
isVerbondenMetBagLigplaats.identificatie String (relatie) Aan welk ligplaats heeft het WOZ-deelobject een relatie
isVerbondenMetBagLigplaats.volgnummer Integer (relatie) Aan welk ligplaats heeft het WOZ-deelobject een relatie
isVerbondenMetBagStandplaats Object (relatie) Aan welk standplaats heeft het WOZ-deelobject een relatie
isVerbondenMetBagStandplaats.identificatie String (relatie) Aan welk standplaats heeft het WOZ-deelobject een relatie
isVerbondenMetBagStandplaats.volgnummer Integer (relatie) Aan welk standplaats heeft het WOZ-deelobject een relatie
heeftBagPand Object (relatie) Geeft aan of het WOZ-deelobject een (deel van een) pand is uit de BAG.
heeftBagPand.identificatie String (relatie) Geeft aan of het WOZ-deelobject een (deel van een) pand is uit de BAG.
heeftBagPand.volgnummer Integer (relatie) Geeft aan of het WOZ-deelobject een (deel van een) pand is uit de BAG.

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
beginGeldigheid yyyy-mm-dd Test op exacte waarde (==)
beginGeldigheid[gte] Test op groter dan of gelijk (>=).
beginGeldigheid[lt] Test op kleiner dan (<).
beginGeldigheid[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
beginGeldigheid[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
beginGeldigheid[lte] Test op kleiner dan of gelijk (<=).
beginGeldigheid[gt] Test op groter dan (>).
beginGeldigheid[not] Test of waarde niet overeenkomt (!=).
deelnummer Tekst Test op exacte waarde (==)
deelnummer[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
deelnummer[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
deelnummer[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
deelnummer[isempty] true | false Test of de waarde leeg is (== '' / != '')
deelnummer[not] Test of waarde niet overeenkomt (!=).
eindGeldigheid yyyy-mm-dd Test op exacte waarde (==)
eindGeldigheid[gte] Test op groter dan of gelijk (>=).
eindGeldigheid[lt] Test op kleiner dan (<).
eindGeldigheid[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
eindGeldigheid[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
eindGeldigheid[lte] Test op kleiner dan of gelijk (<=).
eindGeldigheid[gt] Test op groter dan (>).
eindGeldigheid[not] Test of waarde niet overeenkomt (!=).
geldigOp yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] Test op exacte waarde (==)
heeftBagPand.identificatie Tekst Test op exacte waarde (==)
heeftBagPand.identificatie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
heeftBagPand.identificatie[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
heeftBagPand.identificatie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
heeftBagPand.identificatie[isempty] true | false Test of de waarde leeg is (== '' / != '')
heeftBagPand.identificatie[not] Test of waarde niet overeenkomt (!=).
heeftBagPand.volgnummer Geheel getal Test op exacte waarde (==)
heeftBagPand.volgnummer[gte] Test op groter dan of gelijk (>=).
heeftBagPand.volgnummer[lt] Test op kleiner dan (<).
heeftBagPand.volgnummer[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
heeftBagPand.volgnummer[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
heeftBagPand.volgnummer[lte] Test op kleiner dan of gelijk (<=).
heeftBagPand.volgnummer[gt] Test op groter dan (>).
heeftBagPand.volgnummer[not] Test of waarde niet overeenkomt (!=).
id Tekst Test op exacte waarde (==)
id[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
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[isempty] true | false Test of de waarde leeg is (== '' / != '')
id[not] Test of waarde niet overeenkomt (!=).
isVerbondenMetBagLigplaats.identificatie Tekst Test op exacte waarde (==)
isVerbondenMetBagLigplaats.identificatie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
isVerbondenMetBagLigplaats.identificatie[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
isVerbondenMetBagLigplaats.identificatie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
isVerbondenMetBagLigplaats.identificatie[isempty] true | false Test of de waarde leeg is (== '' / != '')
isVerbondenMetBagLigplaats.identificatie[not] Test of waarde niet overeenkomt (!=).
isVerbondenMetBagLigplaats.volgnummer Geheel getal Test op exacte waarde (==)
isVerbondenMetBagLigplaats.volgnummer[gte] Test op groter dan of gelijk (>=).
isVerbondenMetBagLigplaats.volgnummer[lt] Test op kleiner dan (<).
isVerbondenMetBagLigplaats.volgnummer[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
isVerbondenMetBagLigplaats.volgnummer[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
isVerbondenMetBagLigplaats.volgnummer[lte] Test op kleiner dan of gelijk (<=).
isVerbondenMetBagLigplaats.volgnummer[gt] Test op groter dan (>).
isVerbondenMetBagLigplaats.volgnummer[not] Test of waarde niet overeenkomt (!=).
isVerbondenMetBagStandplaats.identificatie Tekst Test op exacte waarde (==)
isVerbondenMetBagStandplaats.identificatie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
isVerbondenMetBagStandplaats.identificatie[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
isVerbondenMetBagStandplaats.identificatie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
isVerbondenMetBagStandplaats.identificatie[isempty] true | false Test of de waarde leeg is (== '' / != '')
isVerbondenMetBagStandplaats.identificatie[not] Test of waarde niet overeenkomt (!=).
isVerbondenMetBagStandplaats.volgnummer Geheel getal Test op exacte waarde (==)
isVerbondenMetBagStandplaats.volgnummer[gte] Test op groter dan of gelijk (>=).
isVerbondenMetBagStandplaats.volgnummer[lt] Test op kleiner dan (<).
isVerbondenMetBagStandplaats.volgnummer[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
isVerbondenMetBagStandplaats.volgnummer[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
isVerbondenMetBagStandplaats.volgnummer[lte] Test op kleiner dan of gelijk (<=).
isVerbondenMetBagStandplaats.volgnummer[gt] Test op groter dan (>).
isVerbondenMetBagStandplaats.volgnummer[not] Test of waarde niet overeenkomt (!=).
isVerbondenMetBagVerblijfsobject.identificatie Tekst Test op exacte waarde (==)
isVerbondenMetBagVerblijfsobject.identificatie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
isVerbondenMetBagVerblijfsobject.identificatie[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
isVerbondenMetBagVerblijfsobject.identificatie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
isVerbondenMetBagVerblijfsobject.identificatie[isempty] true | false Test of de waarde leeg is (== '' / != '')
isVerbondenMetBagVerblijfsobject.identificatie[not] Test of waarde niet overeenkomt (!=).
isVerbondenMetBagVerblijfsobject.volgnummer Geheel getal Test op exacte waarde (==)
isVerbondenMetBagVerblijfsobject.volgnummer[gte] Test op groter dan of gelijk (>=).
isVerbondenMetBagVerblijfsobject.volgnummer[lt] Test op kleiner dan (<).
isVerbondenMetBagVerblijfsobject.volgnummer[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
isVerbondenMetBagVerblijfsobject.volgnummer[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
isVerbondenMetBagVerblijfsobject.volgnummer[lte] Test op kleiner dan of gelijk (<=).
isVerbondenMetBagVerblijfsobject.volgnummer[gt] Test op groter dan (>).
isVerbondenMetBagVerblijfsobject.volgnummer[not] Test of waarde niet overeenkomt (!=).
registratiedatum yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] Test op exacte waarde (==)
registratiedatum[gte] Test op groter dan of gelijk (>=).
registratiedatum[lt] Test op kleiner dan (<).
registratiedatum[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
registratiedatum[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
registratiedatum[lte] Test op kleiner dan of gelijk (<=).
registratiedatum[gt] Test op groter dan (>).
registratiedatum[not] Test of waarde niet overeenkomt (!=).
volgnummer Geheel getal Test op exacte waarde (==)
volgnummer[gte] Test op groter dan of gelijk (>=).
volgnummer[lt] Test op kleiner dan (<).
volgnummer[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
volgnummer[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
volgnummer[lte] Test op kleiner dan of gelijk (<=).
volgnummer[gt] Test op groter dan (>).
volgnummer[not] Test of waarde niet overeenkomt (!=).
wozdeelobjectnummer Tekst Test op exacte waarde (==)
wozdeelobjectnummer[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
wozdeelobjectnummer[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
wozdeelobjectnummer[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
wozdeelobjectnummer[isempty] true | false Test of de waarde leeg is (== '' / != '')
wozdeelobjectnummer[not] Test of waarde niet overeenkomt (!=).
wozobjectnummer Tekst Test op exacte waarde (==)
wozobjectnummer[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
wozobjectnummer[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
wozobjectnummer[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
wozobjectnummer[isempty] true | false Test of de waarde leeg is (== '' / != '')
wozobjectnummer[not] Test of waarde niet overeenkomt (!=).

Insluitbare relaties

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

Relatie Tabel Omschrijving
heeftBagPand bag:panden
isVerbondenMetBagLigplaats bag:ligplaatsen
isVerbondenMetBagStandplaats bag:standplaatsen
isVerbondenMetBagVerblijfsobject bag:verblijfsobjecten