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

Elektriciteit en gasverbruik liander

Verbruiksdata gas en elektricteit van de metropoolregio Amsterdam geleverd door Liander.

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id Integer ☑ Unieke aanduiding record.
jaar Integer Het jaar waarop het verbruik betrekking heeft.
jaarKwartaal String Het jaar en kwartaal waarop het verbruik betrekking heeft.
jaarMaand String Het jaar en de maand waarop het verbruik betrekking heeft.
product String Het producttype: ELK = elektriciteit, GAS = gas.
klantsegment String Typering van de grootte van de aansluiting: KVB = kleinverbruik, GVB = grootverbruik.
provincie String De provincie waar binnen de aansluitingen zich bevinden.
gemeente String De gemeente waar binnen de aansluitingen zich bevinden.
plaats String De plaats waar binnen de aansluitingen zich bevinden.
wijkCode String Code van de wijk waar binnen de aansluitingen zich bevinden.
wijkNaam String Naam van de wijk waar binnen de aansluitingen zich bevinden.
buurtCode String Code van de buurt waar binnen de aansluitingen zich bevinden..
buurtNaam String Naam van de buurt waar binnen de aansluitingen zich bevinden.
levering Integer Schatting op basis van historische gegevens van het jaarverbruik in kWh (elektriciteit) of nm3 (gas).
teruglevering Integer Schatting op basis van historische gegevens van de jaarlijkse teruglevering in kWh (elektriciteit) of nm3 (gas).
aantalAansluitingen Integer Het aantal afleverpunten.

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
aantalAansluitingen Geheel getal Test op exacte waarde (==)
aantalAansluitingen[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
aantalAansluitingen[not] Test of waarde niet overeenkomt (!=).
aantalAansluitingen[lt] Test op kleiner dan (<).
aantalAansluitingen[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
aantalAansluitingen[gt] Test op groter dan (>).
aantalAansluitingen[lte] Test op kleiner dan of gelijk (<=).
aantalAansluitingen[gte] Test op groter dan of gelijk (>=).
buurtCode Tekst Test op exacte waarde (==)
buurtCode[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
buurtCode[not] Test of waarde niet overeenkomt (!=).
buurtCode[isempty] true | false Test of de waarde leeg is (== '' / != '')
buurtCode[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
buurtCode[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
buurtNaam Tekst Test op exacte waarde (==)
buurtNaam[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
buurtNaam[not] Test of waarde niet overeenkomt (!=).
buurtNaam[isempty] true | false Test of de waarde leeg is (== '' / != '')
buurtNaam[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
buurtNaam[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
gemeente Tekst Test op exacte waarde (==)
gemeente[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
gemeente[not] Test of waarde niet overeenkomt (!=).
gemeente[isempty] true | false Test of de waarde leeg is (== '' / != '')
gemeente[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
gemeente[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
id Geheel getal Test op exacte waarde (==)
id[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[not] Test of waarde niet overeenkomt (!=).
id[lt] Test op kleiner dan (<).
id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id[gt] Test op groter dan (>).
id[lte] Test op kleiner dan of gelijk (<=).
id[gte] Test op groter dan of gelijk (>=).
jaar Geheel getal Test op exacte waarde (==)
jaar[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
jaar[not] Test of waarde niet overeenkomt (!=).
jaar[lt] Test op kleiner dan (<).
jaar[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
jaar[gt] Test op groter dan (>).
jaar[lte] Test op kleiner dan of gelijk (<=).
jaar[gte] Test op groter dan of gelijk (>=).
jaarKwartaal Tekst Test op exacte waarde (==)
jaarKwartaal[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
jaarKwartaal[not] Test of waarde niet overeenkomt (!=).
jaarKwartaal[isempty] true | false Test of de waarde leeg is (== '' / != '')
jaarKwartaal[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
jaarKwartaal[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
jaarMaand Tekst Test op exacte waarde (==)
jaarMaand[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
jaarMaand[not] Test of waarde niet overeenkomt (!=).
jaarMaand[isempty] true | false Test of de waarde leeg is (== '' / != '')
jaarMaand[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
jaarMaand[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
klantsegment Tekst Test op exacte waarde (==)
klantsegment[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
klantsegment[not] Test of waarde niet overeenkomt (!=).
klantsegment[isempty] true | false Test of de waarde leeg is (== '' / != '')
klantsegment[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
klantsegment[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
levering Geheel getal Test op exacte waarde (==)
levering[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
levering[not] Test of waarde niet overeenkomt (!=).
levering[lt] Test op kleiner dan (<).
levering[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
levering[gt] Test op groter dan (>).
levering[lte] Test op kleiner dan of gelijk (<=).
levering[gte] Test op groter dan of gelijk (>=).
plaats Tekst Test op exacte waarde (==)
plaats[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
plaats[not] Test of waarde niet overeenkomt (!=).
plaats[isempty] true | false Test of de waarde leeg is (== '' / != '')
plaats[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
plaats[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
product Tekst Test op exacte waarde (==)
product[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
product[not] Test of waarde niet overeenkomt (!=).
product[isempty] true | false Test of de waarde leeg is (== '' / != '')
product[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
product[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
provincie Tekst Test op exacte waarde (==)
provincie[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
provincie[not] Test of waarde niet overeenkomt (!=).
provincie[isempty] true | false Test of de waarde leeg is (== '' / != '')
provincie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
provincie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
teruglevering Geheel getal Test op exacte waarde (==)
teruglevering[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
teruglevering[not] Test of waarde niet overeenkomt (!=).
teruglevering[lt] Test op kleiner dan (<).
teruglevering[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
teruglevering[gt] Test op groter dan (>).
teruglevering[lte] Test op kleiner dan of gelijk (<=).
teruglevering[gte] Test op groter dan of gelijk (>=).
wijkCode Tekst Test op exacte waarde (==)
wijkCode[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
wijkCode[not] Test of waarde niet overeenkomt (!=).
wijkCode[isempty] true | false Test of de waarde leeg is (== '' / != '')
wijkCode[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
wijkCode[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
wijkNaam Tekst Test op exacte waarde (==)
wijkNaam[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
wijkNaam[not] Test of waarde niet overeenkomt (!=).
wijkNaam[isempty] true | false Test of de waarde leeg is (== '' / != '')
wijkNaam[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
wijkNaam[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.