Usein kysyttyä PxWeb API -rajapinnasta

Tältä sivulta löydät PxWeb API -rajapinnan käyttöön liittyviä usein kysyttyjä kysymyksiä ja vastauksia niihin.

Mitä rajapintoja asiakkailla on käytössä PxWeb-tietokannoissa?

  1. Tallennettu haku (saved query), joka on tarkoitettu kaikille loppukäyttäjille.

    Lisäparametrit lisäävät käytettävyyttä ammattilaisillekin. https://statfin.stat.fi/savedquery.html (alustava)

    Tässä pelkistetty esimerkki, jossa käytetään ainoastaan tallennettuja hakuja. 

    1. Mene tietokantaan ja lataa sieltä taulukko ruudulle
    2. Valitse “tallenna poiminta” -välilehti ja määrittele miten ja missä muodossa haluat tiedot
    3. Saat linkin, jonka takana ovat aina esim. uusimmat tiedot tarvitsemassasi tiedostomuodossa (kuviot ja taulukot xlsx, png, jpg, csv, px, json, json-stat2 jne.)

  2. Tiedostorajapinta, jolla ladataan kätevästi päivittyvä taulukkolistaus ja kokonaisia metatietorikkaita taulukoita rajoituksitta.

Miten saan tehtyä ensimmäisen PxWeb API -kyselyn?

  1. Mene tietokantapalveluun
  2. Hae pieni taulukko tietokannasta ruudulle.
  3. Taulukkonäkymän lopussa on kohta “Lisää taulukko sovellukseesi”, missä on kyselyesimerkki kyseistä taulukkoa varten.
  4. Monesti kannattaa muokata kyselyä niin, että saa vaikkapa kaksi viimeistä vuotta, jolloin kysely antaa aina viimeisimmät luvut. Samalla kannattaa myös valita, mitä tiedostomuotoa haluaa käyttää.

Esimerkiksi:

  ... 
"code": "Vuosi", 
"selection": { 
"filter":"top",  <-- valitse kaksi (2) viimeistä vuotta "Vuosi" (aikasarja)  
"values":["2"]   <-- valitse kaksi (2) viimeistä vuotta "Vuosi" (aikasarja)    
  ... 
"format": "px"   <-- voi olla xlsx, csv, json, json-stat, json-stat2 ja px      
  ...

Miksi saan tilakoodin 403 (status code), kun yritän hakea dataa PxWeb API -rajapinnan kautta?

Kyselysi ylittää mitä todennäköisimmin PxWeb API-rajapinnan 100 000 luvun rajoituksen. Joudut siis hakemaan taulukkosi osissa.

Rajapinnan rajoitukset

Miten teen PxWeb API -kyselyjä Tilastokeskuksen maksullisiin tietokantoihin?

Vain salasanan ja käyttäjätunnuksen lisäys erottaa tavallisesta tallennetusta hausta (saved query) ja PxWeb API -käytöstä.

PxWeb API URL metadata (GET) toimii esimerkiksi näin:

  
https://server/PXWeb/api/v1/lang/%7CUSERNAME%7CPASSWORD

PxWeb API POST -tapauksessa on lisättävä käyttäjätunnus ja salasana ylätunnisteeseen (header):

Header name = un   
  Header value = user name  
  Header name = pw   
  Header value = password

Tallennettu haku (saved query) URL toimii esimerkiksi näin:

https://server/PXWeb/sq/saved_query_name%7CUSERNAME%7CPASSWORD

Erotinmerkkinä käytetään merkintää %7C. Käyttäjätunnus ja salasana tulee antaa jokaiseen URLiin.

Ennen toiminut PxWeb API -hakuni ei enää toimi, mikä voi olla vikana?

Vastaus: Jos ennen toiminut StatFin API -haku ei toimi, kannattaa ensin tarkistaa StatFin-tietokannan uutiset ja selvittää onko lähdeaineistoon tullut haun rikkovia muutoksia. Ilmoitamme samassa paikassa myös teknisistä muutoksista.

PxWeb API -hakuni lähteenä oleva aineisto on jotenkin muuttunut. Miksi aineistoa jatkuvasti muutellaan ja mistä saan tietoa muutoksista?

Elämme muuttuvassa maailmassa! Tilastotietoihin tulee muutoksia, kun kuvattu ilmiö tai sen luokitus muuttuu. Tilastotietoihin tulleet muutokset kerrotaan StatFin-tietokannan uutisissa.

Millaisia muutoksia taulukoihin tulee? Miksi pienetkin muutokset joskus johtavat koko tiedoston nimen muutokseen ja jotkut muutokset vain muuttavat jotakin tiedoston sisällä?

Vastaus: Koko tiedostonimi ja taulukon tunniste muuttuu, jos taulukon sisältämään tietoon tulee suurehkoja muutoksia. Ilmoitamme StatFin-tietokannan uutisissa muuttuneet ja uudet taulukot. Kerromme myös muuttuneiden taulukoiden mahdollisen edeltäjän.

Taulukon tunniste ja tiedostonimi muuttuvat, jos jokin seuraavista taulukon sisällä muuttuu:

  • Muuttujia poistetaan (esim. sukupuoli, ikä tai alue)
  • Ryhmittelevien muuttujien nimeä/koodia muutetaan (esim. Helsinki, jonka koodi on KU091)
  • Muuttujan yksikkö muuttuu (esim. m², lukumäärä tai €)

 

Taulukon tunniste säilyy samana, jos taulukkoon tehdään vain seuraavia muutoksia:

  • Analyysimuuttujan lisäys
  • Luokittelevan muuttujan lisäys (esimerkiksi ikä, alue tai sukupuoli)
  • Otsikoiden tai muiden metatietojen pienet tarkennuksen kaltaiset muutokset
  • Aluemuuttujan aluejaon muutos

Pystynkö tekemään hakuja vanhoihin taulukoihin, jotka eivät enää päivity?

StatFin-tietokannassa pyritään pitämään vain aktiivisesti päivittyviä taulukoita. Vanhat taulukot ovat käytettävissä, mutta siirtyvät StatFin-arkistokantaan, jossa niitä voidaan käyttää samalla tavalla kuin StatFin-tietokannassa.

Mistä ja miten saan tietoa, milloin jokin taulukko päivittyy tai on päivittynyt?

Tietojen päivityspäivän tarkistukseen on useita eri vaihtoehtoja.

Tutustu myös tarjolla oleviin PxWeb-tietokantoihin