Apžvalga

Duomenų API – tai vieša HTTP sąsaja atvirų duomenų, skelbiamų Lietuvos duomenų portale, skaitymui. Ji atveria portalo duomenų ežerą – Apache Iceberg lenteles ir saugomus failus: vardų erdves ir schemas skaitykite su GET, o lentelės eilutes užklauskite ar eksportuokite su POST, grąžinančiu JSON, NDJSON, CSV, Excel arba Parquet.

Visuose vadovuose naudojame vieną tikrą duomenų rinkinį – Toksikologinių tyrimų rezultatai mirties atvejais (Higienos institutas) – kad kiekvieną pavyzdį būtų galima nukopijuoti ir paleisti:

Išbandykite gyvai

Pasirinkite stulpelius, nustatykite filtrą, rūšiavimą ir puslapį, tada spauskite Vykdyti, kad iškviestumėte tikrą API tiesiai iš naršyklės. Užklausą peradresuoja dokumentacijos svetainė, todėl ji veikia net ir tada, kai API nesiunčia CORS antraščių.

curl -X POST 'https://api.dataportal.gov.lt/namespaces/111958286/tables/mirusiuju_toksikologinis_rezultatas/query' \
  -H 'Content-Type: application/json' \
  -d '{"limit":5,"select":"pavadinimas,lytis,mirties_metai,amziaus_grupe,mirties_priezastis","sort":"mirties_metai"}'

Kaip sudėlioti duomenys

API turi tris išteklių rūšis:

• Vardų erdvė – talpykla, identifikuojama tašku atskirtu keliu. Čia vardų erdvė yra duomenų teikėjo įmonės kodas, 111958286. Vardų erdvė talpina antrines vardų erdves, lenteles ir failus, todėl katalogas sudaro medį, kurį galima naršyti nuo šaknies žemyn.

• Lentelė – Iceberg lentelė, kurios schemą galima peržiūrėti, eilutes – užklausti po vieną JSON formatu arba eksportuoti dideliais kiekiais NDJSON, JSON, CSV, Excel ar Parquet formatu.

• Failas – saugomas objektas (PDF, paveikslėlis, archyvas ir kt.), pateikiamas tiesiai iš objektų saugyklos.

Ką galima daryti

Greitas startas

curl 'https://api.dataportal.gov.lt/namespaces'

{ "success": true, "data": { "namespaces": ["111958286", "188774975", "…"] } }

curl 'https://api.dataportal.gov.lt/namespaces/111958286'

{
  "success": true,
  "data": {
    "current_namespace": "111958286",
    "child_namespaces": [],
    "tables": ["mirusiuju_toksikologinis_rezultatas", "gimimas", "…"],
    "files": []
  }
}

curl 'https://api.dataportal.gov.lt/namespaces/111958286/tables/mirusiuju_toksikologinis_rezultatas/schema'

curl -X POST 'https://api.dataportal.gov.lt/namespaces/111958286/tables/mirusiuju_toksikologinis_rezultatas/query' \
  -H 'Content-Type: application/json' \
  -d '{"limit":5,"sort":"-mirties_metai","select":"lytis,mirties_metai,pavadinimas"}'

{ "data": [ /* … 5 eilutės … */ ], "total": 22143, "total_pages": 4429, "current_page": 1 }

curl -L -o toksikologija.ndjson \
  -X POST 'https://api.dataportal.gov.lt/namespaces/111958286/tables/mirusiuju_toksikologinis_rezultatas/export?format=ndjson' \
  -H 'Content-Type: application/json' \
  -d '{}'

Atsakymo formatas

Katalogo ir schemos galiniai taškai savo turinį įvynioja į { success, data } struktūrą. Užklausos galinis taškas skiriasi – jis grąžina eilutes ir poslinkiu grįstus puslapiavimo metaduomenis, be success apvalkalo:

{ "success": true, "data": { "…": "…" } }

{ "data": [ /* eilutės */ ], "total": 22143, "total_pages": 4429, "current_page": 1 }

Klaidose pateikiamas error_code ir žinutė. Tikslias struktūras ir būsenos kodus (400, 404, 502, 503, 504) rasite skiltyje Klaidos.

Kur toliau

Taip pat žiūrėkite

• Sąvokos

• Užklausos į lenteles

• Duomenų ir failų atsisiuntimas

• Klaidos

• Pavyzdžiai