Siirry pääsisältöön

PxWeb API käyttöohjeet

Taggar:

Luonnonvarakeskuksen Tilastotietokannan PxWeb APIn (Application Programming Interface) kautta on mahdollista hakea tietoa koneluettavassa muodossa esimerkiksi xlsx, csv, json, json-stat, sdmx ja px (PC-Axis) muodoissa. 

Vastaava PxWeb API on käytössä 

Suomen tilastokeskuksessa: https://pxdata.stat.fi/PxWeb/pxweb/fi/StatFin/

Ruotsin tilastovirasto SCBssä: https://www.statistikdatabasen.scb.se/pxweb/en/ssd/ 

PxWeb API käyttö

Mene Luken Tilastotietokanta-sivulle https://statdb.luke.fi/PXWeb/pxweb/fi/LUKE/ .

Valitse aihealue ja tietokantataulu, jota haluat käyttää. Tietokantataulun voi valita klikkaamalla taulun otsikkoa valikossa.

Yllä olevassa kuvassa on esimerkkinä ”Kananmunien tuotanto” -tilaston taulukkokokonaisuus.

Etsi Tilastotietokanta -haun avulla tilastotaulukoiden etsiminen on mahdollista taulukoiden nimien perusteella.

Taulukon luominen

Tilastotaulukon otsikkoa klikkaamalla avautuu näkymä, jossa suodatettujen tilastotaulukoiden ja taulukoihin pohjautuvien kuvaajien luominen on mahdollista. Tee tarvittavat suodatukset ja paina "Jatka".

Laajennettu näkymä -ominaisuus vaihtaa valintalaatikot tiiviimpään listanäkymään.

Esimerkki

Käytetään esimerkissä taulukkoa "Kananmunien tuotanto kuukausittain (kg)" ja haetaan suodatusomaisuuden avulla A- ja B-luokan kananmunien tuotantomäärät vuonna 2025.

Valinnat voi tehdä joko hiiren avulla tai käyttämällä valintalaatikon painikkeita. Kun valinnat on tehty, käyttäjä painaa Jatka-painiketta. Tilastotietokanta muodostaa tällöin valituista muuttujista taulukon.

Taulukon alaviitteet saa näkyviin sivun alalaidasta.

API-rajapinta

Kyselystä syntyvät tulokset näkyvät Tulostaulukkosivulla. Siellä voi tarkastella, muokata ja tallentaa tuloksia erilaisina taulukoina ja kuvina sekä tiedostoina ja linkkeinä. 

Sivun alalaidassa, taulukon jälkeen on kohta "Lisää taulukko sovellukseesi", josta API-rajapinta löytyy.

Klikkaamalla ”Lisää taulukko sovellukseesi” aukeaa API-rajapinnan tiedot, jossa on URL-osoite ja JSON query-koodi. Niillä saadaan koneluettava yhteys luotuun tietokantatauluun.

Esimerkin tietokantahaussa syntyvät API-tiedot ovat seuraavat:

URL: https://statdb.luke.fi:443/PxWeb/api/v1/fi/LUKE/maa/kanmun/0100_kanmun.px

JSON query: 

{
 "query": [
   {
     "code": "M",
     "selection": {
       "filter": "item",
       "values": [
         "2025M01",
         "2025M02",
         "2025M03",
         "2025M04",
         "2025M05",
         "2025M06",
         "2025M07",
         "2025M08",
         "2025M09",
         "2025M10",
         "2025M11",
         "2025M12"
       ]
     }
   },
   {
     "code": "LLUOKK_TUOTT",
     "selection": {
       "filter": "item",
       "values": [ "A_YHT", "B_YHT", "AB_YHT" ]
     }
   }
 ],
 "response": {
   "format": "px"
 }
}

Esimerkki 2

Kantohinnat viikoittain -tilasto on osoitteessa:  https://statdb.luke.fi/PxWeb/pxweb/fi/LUKE/LUKE__met__metryv/0100_metryv.px

Yllä olevan kuvan mukaisella haulla PxWebin API:sta saadaan hakua vastaavat URL ja QUERY. Saatuun URL-osoitteeseen (alla) lähetetään POST-metodilla sitä vastaava JSON- query.

https://statdb.luke.fi:443/PXWeb/api/v1/fi/LUKE/04 Metsa/04 Talous/26 Puukaupan viikkoseuranta/01_Kantohinnat_viikoittain.px

HUOM! Pelkän URL-osoitteen ajaminen selaimessa antaa tulokseksi kyseisen px-taulun metatiedot.

{
 "query": [
   {
     "code": "W",
     "selection": {
       "filter": "item",
       "values": [
         "2026W21",
         "2026W22",
         "2026W23",
         "2026W24"
       ]
     }
   },
   {
     "code": "MPKH",
     "selection": {
       "filter": "item",
       "values": [
         "1",
         "3"
       ]
     }
   },
   {
     "code": "HAKT",
     "selection": {
       "filter": "item",
       "values": [
         "0"
       ]
     }
   },
   {
     "code": "PTL",
     "selection": {
       "filter": "item",
       "values": [ "N1", "N2", "N3" ]
     }
   }
 ],
 "response": {
   "format": "px"
 }
}

Tuloksen muodoksi voi px:n lisäksi valita muun muassa json, json-stat, xlsx tai csv. Tulosmuoto valitaan kyselyssä kohdassa "response": {"format": "XXX"}. 

Jättämällä luokittelijan (Hinta-alue / Hakkuutapa / Puutavaralaji) pois querysta saa tulokseen mukaan sen kaikki arvot. 

Uusimman viikon tiedot saadaan valinnalla: "filter": "top", "values": ["1"] (tai haluttu määrä viikkoja) ja kaikki vuoden 2025 viikot puolestaan saa valinnalla: "filter": "all", "values": ["2025*"]. 

Rajapinnan testaaminen

Rajapinnan toimintaa voi testata esimerkiksi 

Postman-sovelluksen avulla, https://www.postman.com tai 

Firefox-selaimen RESTClient-lisäosalla (extension), http://restclient.net

PxWeb API käyttötapaus esimerkki

Luken tilastoportaalin kuvat on toteutettu PxWebin API-rajapinnan kautta. 

Esimerkkinä Metsäteollisuus ry:n puukaupan viikkoseuranta -sivu 

https://www.luke.fi/fi/tilastot/metsateollisuus-ryn-puukaupan-viikkoseuranta/metsateollisuus-ryn-puukaupan-viikkoseuranta (kuva alla). 

Kuva on html-linkki, joka aukeaa sivulla olevaan iframe-raamii, http://statdb.luke.fi/charts/pages/charts/metsa/puukaupan_viikkoseuranta_01.html 

Kuva latautuu joka kerta uudestaan, kun sivu avataan tai päivitetään. Kun tietokanta päivittyy, päivittyy kuvakin automaattisesti. Luken tilastoportaalissa kaikki kuvat on tehty JavaScriptillä, mutta rajapinnan kautta saatua dataa voi hyödyntää monella muullakin tekniikalla esimerkiksi R, Java tai Python.

Lisätietoja PxWebin API-rajapinnan käytöstä löytyy esimerkiksi Ruotsin tilastokeskuksen sivuilta: https://www.scb.se/en/services/oppna-data/api-for-the-statistical-database/