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

Bagpanden

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id String ☑ Interne unieke identificatie van een pand.
pandIdentificatie String ☑ Landelijke identificerende sleutel.
pandVolgnummer Integer ☑ Uniek volgnummer van de toestand van het object.
pandGeometrie Geometry Vorm en ligging van het pand in het Nationale Rijksdriehoekstelsel.
pandOorspronkelijkBouwjaar Integer De aanduiding van het jaar waarin een pand oorspronkelijk als bouwkundig gereed is of wordt opgeleverd.
pandNaam String Naamgeving van een pand (bv. naam van metrostation of bijzonder gebouw).
pandGeconstateerd Boolean Dit geeft aan dat een PAND in de registratie is opgenomen als gevolg van een feitelijke constatering en niet op basis van een regulier brondocument (J/N).
pandStatusOmschrijving String De fase van de levenscyclus van een pand, waarin het betreffende pand zich bevindt.
pandLiggingOmschrijving String Situering pand met verblijfsobject (vrijstaand, tussenwoning, etc.). omschrijving
pandTypeWoonobject String Eén woning, Meerdere woningen.
pandAantalBouwlagen Integer Aantal bouwlagen van een pand.
pandHoogsteBouwlaag Integer Hoogste bouwlaag van een pand.
pandLaagsteBouwlaag Integer Laagste bouwlaag van een pand.
pandDocumentdatum Date De datum waarop het brondocument is vastgesteld.
pandDocumentnummer String Het unieke nummer van het brondocument.
pandBeginGeldigheid Datetime Begindatum van de geldigheid van de gegevens van het pand.
pandEindGeldigheid Datetime Einddatum van de geldigheid van de gegevens van het pand.
verblijfsobjectenIdentificaties Array Relatie naar verblijfsobject(en)

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
geldigOp <code>yyyy-mm-dd</code> of <code>yyyy-mm-ddThh:mm[:ss[.ms]]</code> Test op exacte waarde (==)
id Tekst Test op exacte waarde (==)
id[isempty] true of false Test of de waarde leeg is (== '' / != '')
id[not] None Test of waarde niet overeenkomt (!=).
id[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
id[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
pandAantalBouwlagen Geheel getal Test op exacte waarde (==)
pandAantalBouwlagen[gte] None Test op groter dan of gelijk (>=).
pandAantalBouwlagen[not] None Test of waarde niet overeenkomt (!=).
pandAantalBouwlagen[lt] None Test op kleiner dan (<).
pandAantalBouwlagen[lte] None Test op kleiner dan of gelijk (<=).
pandAantalBouwlagen[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
pandAantalBouwlagen[gt] None Test op groter dan (>).
pandAantalBouwlagen[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
pandBeginGeldigheid yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] Test op exacte waarde (==)
pandBeginGeldigheid[gte] None Test op groter dan of gelijk (>=).
pandBeginGeldigheid[not] None Test of waarde niet overeenkomt (!=).
pandBeginGeldigheid[lt] None Test op kleiner dan (<).
pandBeginGeldigheid[lte] None Test op kleiner dan of gelijk (<=).
pandBeginGeldigheid[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
pandBeginGeldigheid[gt] None Test op groter dan (>).
pandBeginGeldigheid[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
pandDocumentdatum yyyy-mm-dd Test op exacte waarde (==)
pandDocumentdatum[gte] None Test op groter dan of gelijk (>=).
pandDocumentdatum[not] None Test of waarde niet overeenkomt (!=).
pandDocumentdatum[lt] None Test op kleiner dan (<).
pandDocumentdatum[lte] None Test op kleiner dan of gelijk (<=).
pandDocumentdatum[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
pandDocumentdatum[gt] None Test op groter dan (>).
pandDocumentdatum[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
pandDocumentnummer Tekst Test op exacte waarde (==)
pandDocumentnummer[isempty] true of false Test of de waarde leeg is (== '' / != '')
pandDocumentnummer[not] None Test of waarde niet overeenkomt (!=).
pandDocumentnummer[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
pandDocumentnummer[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
pandDocumentnummer[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
pandEindGeldigheid yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] Test op exacte waarde (==)
pandEindGeldigheid[gte] None Test op groter dan of gelijk (>=).
pandEindGeldigheid[not] None Test of waarde niet overeenkomt (!=).
pandEindGeldigheid[lt] None Test op kleiner dan (<).
pandEindGeldigheid[lte] None Test op kleiner dan of gelijk (<=).
pandEindGeldigheid[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
pandEindGeldigheid[gt] None Test op groter dan (>).
pandEindGeldigheid[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
pandGeconstateerd true | false Test op exacte waarde (==)
pandGeconstateerd[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
pandGeometrie GeoJSON of GEOMETRY(x y ...) Test op exacte waarde (==)
pandHoogsteBouwlaag Geheel getal Test op exacte waarde (==)
pandHoogsteBouwlaag[gte] None Test op groter dan of gelijk (>=).
pandHoogsteBouwlaag[not] None Test of waarde niet overeenkomt (!=).
pandHoogsteBouwlaag[lt] None Test op kleiner dan (<).
pandHoogsteBouwlaag[lte] None Test op kleiner dan of gelijk (<=).
pandHoogsteBouwlaag[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
pandHoogsteBouwlaag[gt] None Test op groter dan (>).
pandHoogsteBouwlaag[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
pandIdentificatie Tekst Test op exacte waarde (==)
pandIdentificatie[isempty] true of false Test of de waarde leeg is (== '' / != '')
pandIdentificatie[not] None Test of waarde niet overeenkomt (!=).
pandIdentificatie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
pandIdentificatie[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
pandIdentificatie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
pandLaagsteBouwlaag Geheel getal Test op exacte waarde (==)
pandLaagsteBouwlaag[gte] None Test op groter dan of gelijk (>=).
pandLaagsteBouwlaag[not] None Test of waarde niet overeenkomt (!=).
pandLaagsteBouwlaag[lt] None Test op kleiner dan (<).
pandLaagsteBouwlaag[lte] None Test op kleiner dan of gelijk (<=).
pandLaagsteBouwlaag[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
pandLaagsteBouwlaag[gt] None Test op groter dan (>).
pandLaagsteBouwlaag[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
pandLiggingOmschrijving Tekst Test op exacte waarde (==)
pandLiggingOmschrijving[isempty] true of false Test of de waarde leeg is (== '' / != '')
pandLiggingOmschrijving[not] None Test of waarde niet overeenkomt (!=).
pandLiggingOmschrijving[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
pandLiggingOmschrijving[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
pandLiggingOmschrijving[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
pandNaam Tekst Test op exacte waarde (==)
pandNaam[isempty] true of false Test of de waarde leeg is (== '' / != '')
pandNaam[not] None Test of waarde niet overeenkomt (!=).
pandNaam[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
pandNaam[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
pandNaam[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
pandOorspronkelijkBouwjaar Geheel getal Test op exacte waarde (==)
pandOorspronkelijkBouwjaar[gte] None Test op groter dan of gelijk (>=).
pandOorspronkelijkBouwjaar[not] None Test of waarde niet overeenkomt (!=).
pandOorspronkelijkBouwjaar[lt] None Test op kleiner dan (<).
pandOorspronkelijkBouwjaar[lte] None Test op kleiner dan of gelijk (<=).
pandOorspronkelijkBouwjaar[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
pandOorspronkelijkBouwjaar[gt] None Test op groter dan (>).
pandOorspronkelijkBouwjaar[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
pandStatusOmschrijving Tekst Test op exacte waarde (==)
pandStatusOmschrijving[isempty] true of false Test of de waarde leeg is (== '' / != '')
pandStatusOmschrijving[not] None Test of waarde niet overeenkomt (!=).
pandStatusOmschrijving[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
pandStatusOmschrijving[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
pandStatusOmschrijving[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
pandTypeWoonobject Tekst Test op exacte waarde (==)
pandTypeWoonobject[isempty] true of false Test of de waarde leeg is (== '' / != '')
pandTypeWoonobject[not] None Test of waarde niet overeenkomt (!=).
pandTypeWoonobject[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
pandTypeWoonobject[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
pandTypeWoonobject[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
pandVolgnummer Geheel getal Test op exacte waarde (==)
pandVolgnummer[gte] None Test op groter dan of gelijk (>=).
pandVolgnummer[not] None Test of waarde niet overeenkomt (!=).
pandVolgnummer[lt] None Test op kleiner dan (<).
pandVolgnummer[lte] None Test op kleiner dan of gelijk (<=).
pandVolgnummer[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
pandVolgnummer[gt] None Test op groter dan (>).
pandVolgnummer[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
verblijfsobjectenIdentificaties value1,value2 Test op exacte waarde (==)
verblijfsobjectenIdentificaties[contains] Kommagescheiden lijst Test of er een intersectie is met de waarde.