Swagger dokumentation

Av datasmängdens sammandrag

Helsingin kaupungin palvelukiinteistöjen energiankulutustietoja tarjoava Nuuka open API on kanava, jonka kautta käyttäjä pystyy hakemaan tietoja Helsingin kaupungin omistamista kiinteistöistä ja niiden energiankulutuksesta. Rajapinta on täysin avoin, eikä vaadi tunnistautumista.

Rajapinnat jakautuvat kiinteistöjen tietojen hakuun ja energiadatan hakuun. Hakuja pystyy tekemään kohteen nimen, kohteen käyttötarkoituksen ja kohteen kiinteistönumeron perusteella.

Kiinteistöt pystyy listaamaan ja niistä pystyy hakemaan tarkempaa tietoa. Huomioitavaa on ero kiinteistöjen ja rakennusten välillä: yksi kiinteistö voi sisältää useita rakennuksia, esimerkiksi koulun ja päiväkodin. Kiinteistön tietoja hakiessa palautetaan myös kiinteistön sisältämien rakennusten tiedot. Koordinaateissa käytetty koordinaattijärjestelmä on WGS84 Web Mercator (EPSG:3857).

Energiadataa voi hakea kuukausi-, päivä- ja tuntitasolla. Datan saatavuus ja tarkkuus vaihtelee kohteittain. Kaikkein vanhin data on vuositasolla, alkaen n.1980. Tarkin, tuntikohtainen data on pääsääntöisesti saatavilla alkaen 2015. Mahdollisia raportointiryhmiä on neljä: sähkö, lämmitys, vesi ja jäähdytys. Kaikki energiadata näytetään kiinteistön päämittaritasolla. Kuukausikohtaisen datan pystyy hakemaan myös normalisoituna. Data päivittyy kerran vuorokaudessa.

Tarkemmat tiedot eri rajapinnoista löytyvät Swagger-dokumentaatiosta. Tiedot palautetaan JSON-formaatissa.

Kannan tiedoissa esiintyy puutteita. Aukkoja aikasarjoissa voi esiintyä kaikilla tasoilla ja koko katetulla aikavälillä. Datan validoinnin tarkkuus riippuu energiatyypistä ja datan lähteestä, joka puolestaan riippuu ajankohdasta ja kohteesta. Lähtökohtaisesti data on sitä eksaktimpaa mitä uudempaa se on. Kaikkein uusinta dataa myös monitoroidaan ja korjataan virheiden ilmetessä

Esimerkkihakuja

1. Listaa kaikki kiinteistöt: https://helsinki-openapi.nuuka.cloud/api/v1.0/Property/List?Customer=Helsinki
2. Hae päivittäinen energiankulutus (ReportingGroup=Electricity) kiinteistölle Hakaniemen kauppahalli (PropertyName=1000 Hakaniemen Kauppahalli) vuodelle 2019: https://helsinki-openapi.nuuka.cloud/api/v1.0/EnergyData/Daily/ListByProperty?Customer=Helsinki&Record=LocationName&SearchString=1000%20Hakaniemen%20kauppahalli&ReportingGroup=Electricity&StartTime=2019-01-01&EndTime=2019-12-31

Källa: Helsingin kaupungin palvelukiinteistöjen energiankulutustietoja