API skirta Latvijos adresų, pašto kodų, gatvių, vietovių, pastatų ir patalpų grupių (įskaitant butus) paieškai.
API raktą galite gauti pasirinkę v1. Naujam v1 raktui Latvijos API teisė suteikiama automatiškai.
Pavyzdžiai
Dokumentacija
WEB API adresas: https://api.postit.lt/lv/v1/
Užklausa pateikiama GET metodu, o atsakymas grąžinamas JSON formatu.
Užklausos parametrai
| Parametras | Būtinas | Aprašymas |
|---|---|---|
key | Taip | API raktas. Pasirinkus v1, naujam raktui automatiškai suteikiama Latvijos API teisė. |
term | Taip* | Pagrindinė paieškos frazė nuo 3 iki 1000 simbolių. Jei kartu pateikiamas address, naudojamas term. |
address | Taip* | Alternatyvi paieškos frazė, naudojama tik tada, kai term nepateiktas. |
limit | Ne | Rezultatų skaičius nuo 1 iki 20. Numatytoji reikšmė – 10. |
page | Ne | Rezultatų puslapis nuo 1 iki 50. Numatytoji reikšmė – 1. |
wide_number | Ne | Nustačius 1, leidžiama platesnė namo numerio pradžios paieška. Numatytoji reikšmė – 0. |
group | Ne | Grupavimas pagal city, address arba street. |
order | Ne | Taškais atskirtos lauko ir krypties sąlygos. Laukai: post_code, eldership, city, address, street, number, municipality, city_size ir municipality_size. Suderinamumui su LT v1.1 paliktas eldership Latvijos duomenyse reiškia valsčių (pagasts). |
Taip* – būtina pateikti term arba address.
Paieška
Pašto kodo galima ieškoti formatais LV-1010, LV 1010 arba 1010. Atsakyme pašto kodas visada pateikiamas formatu LV-NNNN.
Ieškoma pagal visą adresą, gatvę, numerį, patalpų grupę, vietovę, valsčių, savivaldybę ir oficialius identifikatorius. Galima rašyti latviškomis raidėmis arba be diakritinių ženklų, pavyzdžiui, Rīga arba Riga.
Įprasta paieška grąžina pastatus ir užstatyti skirtus žemės vienetus. Įvedus visą adresą su patalpų grupės numeriu arba tikslų patalpų grupės identifikatorių, paieška taip pat grąžina patalpų grupes.
Adreso struktūra
savivaldybė (novads) arba valstybės miestas (valstspilsēta) → valsčius (pagasts, gali nebūti) → vietovė (gali nebūti): miestas (pilsēta), kaimas (ciems) arba mažasis kaimas (mazciems) → gatvė (gali nebūti) → pastatas arba užstatyti skirtas žemės vienetas → patalpų grupė (telpu grupa, gali nebūti)
Ne visi lygiai eina vienas po kito: savivaldybės miestas gali neturėti valsčiaus, o valstybės miestas pats yra aukščiausias rezultato administracinis lygis. Trūkstami neprivalomi lygiai atsakyme pateikiami kaip null.
Užklausos pavyzdys
https://api.postit.lt/lv/v1/?term=Brīvības+iela+10,+Rīga&limit=10&key=YOUR_API_KEY
Atsakymo parametrai
| Laukas | Tipas | Aprašymas |
|---|---|---|
status | Tekstas | Užklausos būsena: success arba error. |
success | Loginis | Nurodo, ar užklausa įvykdyta sėkmingai. |
message | Tekstas | Klaidos pranešimas; sėkmingame atsakyme tuščias. |
message_code | Skaičius | Loginis rezultato arba klaidos kodas. |
total | Skaičius | Visas rastų rezultatų arba grupių skaičius prieš pritaikant limit. |
data | Masyvas | Rezultatų masyvas. |
data rezultatų masyvo laukai
Kiekvienas rezultatas turi tuos pačius laukus; nesami neprivalomi duomenys pateikiami kaip null. Kai coordinates yra null, vidiniai koordinačių laukai nepateikiami.
| Laukas | Tipas | Aprašymas |
|---|---|---|
adr_id | Tekstas | Oficialus adreso objekto kodas (latv. KODS). |
building_id | Tekstas | Pastato arba užstatyti skirto žemės vieneto kodas; patalpų grupei nurodo jos tėvinį objektą. |
object_type | Tekstas | Objekto tipas: building – pastatas, land_unit – užstatyti skirtas žemės vienetas, premise – patalpų grupė. |
country_code | Tekstas | Visada LV. |
post_code | Tekstas | Oficialus pašto kodas su LV- priešdėliu. |
address | Tekstas | Gatvė ir objekto numeris arba objekto pavadinimas, kai gatvės nėra; patalpų grupės numeris neįtraukiamas. |
address_full | Tekstas | Visas oficialus adreso įrašas (latv. pilnais adreses pieraksts), skirtas rodyti naudotojui. |
street | Tekstas arba null | Gatvės pavadinimas. |
street_full | Tekstas arba null | Visas oficialus gatvės įrašas su aukštesniais hierarchijos lygiais. |
street_id | Tekstas arba null | Oficialus gatvės identifikatorius. |
number | Tekstas | Pastato arba užstatyti skirto žemės vieneto numeris ar pavadinimas. |
flat | Tekstas arba null | Patalpų grupės numeris, įskaitant buto numerį. |
city | Tekstas | Integracijoms skirtas bendras laukas: vietovė, valsčius (pagasts), savivaldybė (novads) arba valstybės miestas (valstspilsēta). |
city_full | Tekstas | Visas oficialus city lauke pasirinkto objekto įrašas su aukštesniais hierarchijos lygiais. |
locality | Tekstas arba null | Miestas (pilsēta), kaimas (ciems) arba mažasis kaimas (mazciems). |
locality_full | Tekstas arba null | Visas oficialus vietovės įrašas su aukštesniais hierarchijos lygiais. |
locality_type | Tekstas arba null | Vietovės tipas: city – miestas, village – kaimas, small_village – mažasis kaimas. |
locality_id | Tekstas arba null | Oficialus vietovės identifikatorius. |
parish | Tekstas arba null | Valsčius (latv. pagasts). |
parish_full | Tekstas arba null | Visas oficialus valsčiaus įrašas su savivaldybe. |
parish_id | Tekstas arba null | Oficialus valsčiaus identifikatorius. |
municipality | Tekstas | Savivaldybė (novads) arba valstybės miestas (valstspilsēta). |
municipality_full | Tekstas | Visas oficialus savivaldybės arba valstybės miesto įrašas. |
municipality_type | Tekstas | Administracinio lygio tipas: novads – savivaldybė, state_city – valstybės miestas (valstspilsēta). |
municipality_id | Tekstas | Oficialus savivaldybės arba valstybės miesto identifikatorius. |
post_office_code | Tekstas arba null | Pašto skyriaus aptarnavimo teritorijos kodas (latv. pasta nodaļas apkalpes teritorijas kods). |
is_planned | Loginis | Nurodo, ar tai planuojamas adresas (plānota adrese), dar nesusietas su Kadastro informacinės sistemos objektu. |
coordinates | Objektas arba null | Adreso objekto centroido koordinatės: WGS84 latitude/longitude, LKS-92 X/Y ir koordinačių šaltinio objekto identifikatorius. |
coordinates.latitude | Skaičius | WGS84 platuma. |
coordinates.longitude | Skaičius | WGS84 ilguma. |
coordinates.lks92_x | Skaičius | LKS-92 X koordinatė. |
coordinates.lks92_y | Skaičius | LKS-92 Y koordinatė. |
coordinates.source_building_id | Tekstas | Pastato arba žemės vieneto, iš kurio gautos koordinatės, identifikatorius. |
Atsakymo pavyzdys
{
"status": "success",
"success": true,
"message": "",
"message_code": 0,
"total": 1,
"data": [
{
"adr_id": "110000001",
"building_id": "101000001",
"object_type": "premise",
"country_code": "LV",
"post_code": "LV-1010",
"address": "Brīvības iela 10",
"address_full": "Brīvības iela 10-12, Rīga, LV-1010",
"street": "Brīvības iela",
"street_full": "Brīvības iela, Rīga",
"street_id": "100000107",
"number": "10",
"flat": "12",
"city": "Rīga",
"city_full": "Rīga",
"locality": null,
"locality_full": null,
"locality_type": null,
"locality_id": null,
"parish": null,
"parish_full": null,
"parish_id": null,
"municipality": "Rīga",
"municipality_full": "Rīga",
"municipality_type": "state_city",
"municipality_id": "100000104",
"post_office_code": "100000901",
"is_planned": false,
"coordinates": {
"latitude": 56.95,
"longitude": 24.11,
"lks92_x": 311000.5,
"lks92_y": 507000.25,
"source_building_id": "101000001"
}
}
]
}Klaidų kodai
| Kodas | Reikšmė |
|---|---|
0 | Užklausa įvykdyta sėkmingai, taip pat kai rezultatų nėra. |
1001 | Paieškos frazė nepateikta, per trumpa arba per ilga. |
1002 | Viršytas dienos užklausų limitas. |
1003 | API raktas netinkamas, negaliojantis arba neturi Latvijos API teisės. |
1004 | API raktas nepateiktas. |
405 | Naudojamas nepalaikomas HTTP metodas. |
503 | Paieškos paslauga laikinai neprieinama. |
Duomenų šaltinis
Naudojami Latvijos valstybinės žemės tarnybos (latv. Valsts zemes dienests, VZD) Valstybinio adresų registro (Valsts adrešu reģistrs) atvirieji duomenys, skelbiami pagal CC BY 4.0 licenciją. Oficialus duomenų rinkinys ir VZD duomenų aprašymas.
Nemokamas išbandymas
Gauti nemokamą API raktą pasirinkus v1. Jis taip pat suteikia bandomąją prieigą prie Latvijos API ir leidžia atlikti iki 100 užklausų iš vieno IP adreso arba domeno per dieną.
Pasiekus dienos ribą, grąžinamas toks atsakymas:
{
"status": "error",
"success": false,
"message": "Viršytas dienos užklausų limitas",
"message_code": 1002,
"total": 0,
"data": []
}Mokami planai
Jei reikia daugiau nei 100 užklausų, tai siūlome API planus:
- 4 €/mėn.* - 1000 užklausų per diena
- 8 €/mėn.* - neribojamas** užklausų kiekis per diena.
* - apmokant už 12 mėn.
** - Atsižvelgiant į serverio technines galimybes užklausų kiekis neturi viršyti 6 užklausų per sekunde.
Jei pasirenkamas vienas iš šių mokamų variantų, tai nuorodos talpinimas nėra būtinas.
Susisiekti nurodytais kontaktais.