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

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 deelobject, gelijk aan volgnummer van WOZ-object
registratiedatum Datetime De datum waarop de toestand van het deelobject is geregistreerd
wozdeelobjectnummer String ☑ De unieke identificatie van een WOZ-deelobject
deelnummer String Nummer van het deelobject binnen het WOZ-object
wozobjectnummer String De unieke identificatie van een WOZ-object, waar dit deelobject onderdeel van is
soortObject Object Aanduiding van het soort deelobject 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 deelobject, een wijziging hebben ondergaan
eindGeldigheid Date De einddatum van een periode waarin één of meer gegevens die worden bijgehouden over een deelobject, een wijziging hebben ondergaan
isVerbondenMetBagVerblijfsobject Object (relatie) De unieke aanduiding van het verblijfsobject dat deel uitmaakt van het WOZ-deelobject
isVerbondenMetBagVerblijfsobject.identificatie String (relatie) De unieke aanduiding van het verblijfsobject dat deel uitmaakt van het WOZ-deelobject
isVerbondenMetBagVerblijfsobject.volgnummer Integer (relatie) De unieke aanduiding van het verblijfsobject dat deel uitmaakt van het WOZ-deelobject
isVerbondenMetBagLigplaats Object (relatie) De unieke aanduiding van de ligplaats die deel uitmaakt van het WOZ-deelobject
isVerbondenMetBagLigplaats.identificatie String (relatie) De unieke aanduiding van de ligplaats die deel uitmaakt van het WOZ-deelobject
isVerbondenMetBagLigplaats.volgnummer Integer (relatie) De unieke aanduiding van de ligplaats die deel uitmaakt van het WOZ-deelobject
isVerbondenMetBagStandplaats Object (relatie) De unieke aanduiding van de standplaats die deel uitmaakt van het WOZ-deelobject
isVerbondenMetBagStandplaats.identificatie String (relatie) De unieke aanduiding van de standplaats die deel uitmaakt van het WOZ-deelobject
isVerbondenMetBagStandplaats.volgnummer Integer (relatie) De unieke aanduiding van de standplaats die deel uitmaakt van het WOZ-deelobject
heeftBagPand Object (relatie) De unieke aanduiding van het pand dat deel uitmaakt van het WOZ-deelobject
heeftBagPand.identificatie String (relatie) De unieke aanduiding van het pand dat deel uitmaakt van het WOZ-deelobject
heeftBagPand.volgnummer Integer (relatie) De unieke aanduiding van het pand dat deel uitmaakt van het WOZ-deelobject

De volgende query-parameters zijn te gebruiken:

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

Insluitbare relaties

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

Relatie Tabel Omschrijving
heeftBagPand bag:panden Een PAND is de kleinste bij de totstandkoming functioneel en bouwkundig-constructief zelfstandige eenheid die direct en duurzaam met de aarde is verbonden en betreedbaar en afsluitbaar is.
isVerbondenMetBagLigplaats bag:ligplaatsen Een LIGPLAATS is een door het bevoegde gemeentelijke orgaan als zodanig aangewezen plaats in het water die bestemd is voor het permanent afmeren van een voor woon-, bedrijfsmatige of recreatieve doeleinden geschikt drijvend object
isVerbondenMetBagStandplaats bag:standplaatsen
isVerbondenMetBagVerblijfsobject bag:verblijfsobjecten Een VERBLIJFSOBJECT is de kleinste binnen één of meer panden gelegen en voor woon -, bedrijfsmatige, of recreatieve doeleinden geschikte eenheid van gebruik die ontsloten wordt via een eigen afsluitbare toegang vanaf de openbare weg, een erf of een gedeelde verkeersruimte, onderwerp kan zijn van goederenrechtelijke rechtshandelingen en in functioneel opzicht zelfstandig is