Skip to content

sebenik/sistat-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

45 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SISTAT-API

JSON API podatkovnega portala SI-STAT Staističnega urada Republike Slovenije.

About

Spletna aplikacija Statističnega urada Republike Slovenije SI-STAT, ki je razdeljena po tematskih področjih, omogoča iskanje in prenos objavljenih statističnih podatkov. Te je mogoče prikazati v tabeli ali prenesti v obliki različnih datotek (txt, csv, px, xls, htm). SISTAT-API po zgledu Eurostat-a, omogoča prenos podatkov preko spletne aplikacije SI-STAT v JSON-STAT formatu. Več o formatu najdete na tej povezavi: https://json-stat.org.

Uporaba

  1. Na spletni strani aplikacije SI-STAT poiščete področje in sklop podatkov, ki jih želite uporabiti.
  2. Sestavite API klic:
    • URL - http://sistat.sebenik.com/
    • GET parametri:
      • ma - parameter, katerega vrednost najdete v spletnem naslovu izbranega sklopa podatkov (obvezen parameter)
      • path - parameter, katerega vrednost najdete v spletnem naslovu izbranega sklopa podatkov (obvezen parameter)
      • dimenzija* - parametri s katerimi označimo izbrane dimenzije in vrednosti v tabelah. Ime parametra pišemo z malimi črkami, presledke pa nadomestimo s podčrtajem '_'. Vrednosti posameznega parametra pišemo kakor so prikazane v tabelah na spletni strani. V primru izbire večjega števila vrednosti posamezne dimenzije, le te ločimo z vejico ','. Če želimo izbrati vse vrednosti posamezne dimenzije lahko namesto naševanja vseh, za vrednost dimenzije napišemo 'all', če želimo izbrati zgolj prvo vrednost dimenzije lahko napišemo 'first' ali 'last', če želimo izbrati zgolj zadnjo vrednost dimenzije. (Glej primer.) Dimenzije, ki so v spletni aplikaciji označene z zvezdico, so obvezne.
  3. Struktura odgovora je v JSON-STAT formatu. Vsebuje naslednja polja:
    • version - označuje vezijo JSON-STAT formata (ref)
    • class - označuje razred odgovora. Odgovor SISTAT-API-ja je vedno razreda 'dataset'. (ref)
    • title - naslov tabele oz. sklopa prenešenih podatkov.
    • description - opis tabele oz. sklopa prenešenih podatkov.
    • contents - področje (nadskupina) sklopa prenešenih podatkov.
    • created - označuje čas generiranja podatkov 'leto/mesec/dan ura'.
    • updated - označuje čas posodobitve podatkov 'leto/mesec/dan ura'.
    • source - vir podatkov.
    • href - spletni naslov do spletne aplikacije za konkretni sklop prenešenih podatkov.
    • id - polje vsebuje oznake izbranih dimenzij. (ref)
    • size - polje vsebuje število izbranih vrednosti za posamezno dimenzijo. Zaporedje je enako kot v polju 'id'. (ref)
    • dimension - objekt vsebuje informacije o posamezni izbrani dimenziji. (ref)
      • label - ime dimenzije. (ref)
      • category - objekt opisuje možne vrednosti dimenzije. (ref)
        • index - objekt vsebuje vrstni red možnih vrednosti dimenzije. (ref)
        • label - objekt vsebuje imena možnih vrednosti dimenzije. (ref)
        • note - objekt vsebuje morebitna dodatna pojasnila za posamezno vrednost dimenzije. (ref)
    • value - objekt vsebuje podatke glede na izbrane dimenzije. (ref)
    • note - polje vsebuje morebitna dodatna pojasnila o prenešenih podatkih ter kontakt. (ref)

Primer

Primer za podatke: Sklenitve zakonskih zvez po starostnih skupinah ženina in neveste, statistične regije, Slovenija, letno

  1. Iz spletnega naslova za izbran sklop podatkov https://pxweb.stat.si/pxweb/Dialog/varval.asp?ma=05M2008S&ti=&path=../Database/Dem_soc/05_prebivalstvo/34_Poroke/10_05M20_poroke-RE-OBC/&lang=2 prekopiramo GET parametra ma in path.
    • ma=05M2008S
    • path=../Database/Dem_soc/05_prebivalstvo/34_Poroke/10_05M20_poroke-RE-OBC/
  2. Ostale GET parametre za poizvedbo kot je prikazana na spodnji sliki zapišemo sledeče: primer izbire parametrov
    • meritve=all
    • statistična_regija=all
    • leto=last
    • starost=20-24 let,25-29 let,30-34 let
  3. Celoten GET request izgleda tako: http://sistat.sebenik.com/?ma=05M2008S&path=../Database/Dem_soc/05_prebivalstvo/34_Poroke/10_05M20_poroke-RE-OBC&meritve=all&statisti%C4%8Dna_regija=all&leto=last&starost=20-24%20let,25-29%20let,30-34%20let

Licenca

  • Podatki: potrebno je navesti vir podatkov, ki jih uporabljate (Statistični urad Republike Slovenije)
  • SISTAT-API: MIT License

Avtor

Žiga Šebenik ziga@sebenik.com

About

API za podatkovni portal SI-STAT (Statistični urad RS)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages