Lietuvos adresų ir butų paieškos WEB API v5

Pašto kodai
API
Versija 5

Pavyzdžiai

Dokumentacija

WEB API adresas: https://api.postit.lt/v5/

Užklausa pateikiama GET metodu.

Atsakymas grąžinamas JSON formatu.

v5 suteikiamas tik su mokamais planais.

Užklausos parametrai

Parametras Būtinas Aprašymas
keyTaipSuteiktas API raktas. API raktas susiejamas su IP adresu arba tinklapio domenu.
term Taip Užklausa, pagal kurią ieškomi adresai. Užklausą turi sudaryti 3 ar daugiau simbolių. Tarpai esantys priekyje ir pabaigoje yra pašalinami.
address Taip* term parametro alternatyva. Šis parametras yra privalomas ir tikrinamas, tik tada kai nėra pateikiamas term.
limit Ne Pateikiamų rezultatų kiekio apribojimas.
Galimos reikšmės intervale 1-20, jei nenurodyta: 10

Užklausos pavyzdys

https://api.postit.lt/v5/?term=Savanorių+60,+Vilnius&limit=3&key=[API_RAKTAS]

Atsakymo parametrai

Parametras Tipas Aprašymas
status Tekstas Užklausos įvykdymo būsena (statusas) tekstine išraiška
Galimos reikšmės: success, error
success Loginis Užklausos įvykdymo būsena (statusas) logine išraiška
Galimos reikšmės: true, false
message Tekstas Tekstinis klaidos pranešimas
Galimos reikšmės pateiktos žemiau esančioje klaidų kodai lentelėje
message_code Skaičius Klaidos pranešimo kodas
Galimos reikšmės pateiktos žemiau esančioje klaidų kodai lentelėje
total Skaičius Visas surastų rezultatų kiekis
data Masyvas Rezultatų masyvas
data rezultatų masyvo parametrai
address_number Tekstas|null Pastato/namo numeris, pvz.: 50E.
address_housing Tekstas|null Korpuso numeris, pvz.: 21C.
address_post_code Tekstas|null Pašto kodas, be "LT-" priešdėlio, pvz.: 82168.
flat_nr Tekstas|null Patalpos/buto numeris.
street_title Tekstas|null Gatvės pavadinimas, pvz.: "Laisvės pr."
street_type Tekstas|null Gatvės tipas (jo trumpinys), pvz.: "pr."
street_type_title Tekstas|null Gatvės tipas, pvz.: "prospektas"
location_title_nominative Tekstas Vietovės/miesto pavadinimas vardininko linksniu, pvz.: "Vilnius".
location_title Tekstas Vietovės/miesto pavadinimas, pvz.: "Vilniaus m.".
location_type Tekstas Vietovės tipas (jo trumpinys), pvz.: "m.".
location_type_title Tekstas Vietovės tipas, pvz.: "miestas".
eldership_title Tekstas|null Seniūnijos pavadinimas. Lietuvos administracinis-teritorinis vienetas, pvz.: "Gargždų".
eldership_type Tekstas|null Seniūnijos tipas (jo trumpinys). Lietuvos administracinis-teritorinis vienetas, pvz.: "sen.".
eldership_type_title Tekstas|null Seniūnijos tipas. Lietuvos administracinis-teritorinis vienetas, pvz.: "seniūnija".
municipality_title Tekstas Savivaldybė, pvz.: "Vilniaus m. sav."
municipality_type Tekstas Savivaldybės tipas (jo trumpinys), pvz.: "sav."
municipality_type_title Tekstas Savivaldybės tipas, pvz.: "savivaldybė"
county_title Tekstas Apskritis, pvz.: "Vilniaus apskr."
county_type Tekstas Apskrities tipas (jo trumpinys), pvz.: "apskr."
county_type_title Tekstas Apskrities tipas, pvz.: "apskritis"
address_location Objektas|null Adreso koordinatės su lat ir lon reikšmėmis.
address_text Tekstas Suformuotas pilnas adresas, pvz.: "Laisvės pr. 60-10, 05120 Vilnius, Vilniaus m. sav."

Atsakymo pavyzdys

{
    "status": "success",
    "success": true,
    "message": "",
    "message_code": 0,
    "total": 97,
    "data": [
        {
            "address_number": "60",
            "address_housing": null,
            "address_post_code": "05120",
            "flat_nr": null,
            "street_title": "Laisvės pr.",
            "street_type": "pr.",
            "street_type_title": "prospektas",
            "location_title_nominative": "Vilnius",
            "location_title": "Vilniaus m.",
            "location_type": "m.",
            "location_type_title": "miestas",
            "eldership_title": null,
            "eldership_type": null,
            "eldership_type_title": null,
            "municipality_title": "Vilniaus m. sav.",
            "municipality_type": "sav.",
            "municipality_type_title": "savivaldybė",
            "county_title": "Vilniaus apskr.",
            "county_type": "apskr.",
            "county_type_title": "apskritis",
            "address_location": {
                "lat": 54.702422149,
                "lon": 25.221615447
            },
            "address_text": "Laisvės pr. 60, 05120 Vilnius, Vilniaus m. sav."
        },
        {
            "address_number": "60",
            "address_housing": null,
            "address_post_code": "05120",
            "flat_nr": "10",
            "street_title": "Laisvės pr.",
            "street_type": "pr.",
            "street_type_title": "prospektas",
            "location_title_nominative": "Vilnius",
            "location_title": "Vilniaus m.",
            "location_type": "m.",
            "location_type_title": "miestas",
            "eldership_title": null,
            "eldership_type": null,
            "eldership_type_title": null,
            "municipality_title": "Vilniaus m. sav.",
            "municipality_type": "sav.",
            "municipality_type_title": "savivaldybė",
            "county_title": "Vilniaus apskr.",
            "county_type": "apskr.",
            "county_type_title": "apskritis",
            "address_location": {
                "lat": 54.702422149,
                "lon": 25.221615447
            },
            "address_text": "Laisvės pr. 60-10, 05120 Vilnius, Vilniaus m. sav."
        },
        {
            "address_number": "60",
            "address_housing": null,
            "address_post_code": "05120",
            "flat_nr": "212",
            "street_title": "Laisvės pr.",
            "street_type": "pr.",
            "street_type_title": "prospektas",
            "location_title_nominative": "Vilnius",
            "location_title": "Vilniaus m.",
            "location_type": "m.",
            "location_type_title": "miestas",
            "eldership_title": null,
            "eldership_type": null,
            "eldership_type_title": null,
            "municipality_title": "Vilniaus m. sav.",
            "municipality_type": "sav.",
            "municipality_type_title": "savivaldybė",
            "county_title": "Vilniaus apskr.",
            "county_type": "apskr.",
            "county_type_title": "apskritis",
            "address_location": {
                "lat": 54.702422149,
                "lon": 25.221615447
            },
            "address_text": "Laisvės pr. 60-212, 05120 Vilnius, Vilniaus m. sav."
        }
    ]
}

Klaidų kodai

Žinutės kodas Žinutės tekstas
Klaidos susijusios su serveriu arba tinklapiu
404 Pagal pateiktą užklausą nepavyko nieko rasti
Šis pranešimas pateikiamas, kai nurodytas blogas WEB API adresas
503 Dėl didelio apkrovimo paslauga laikinai neprieinama
Klaidos susijusios su API paslauga
0 Nėra klaidos ir pranešimo
5001 Paieškoje įrašykite daugiau nei 2 simbolius
5002 Viršytas pašto kodų dienos užklausų limitas. Dėl šio apribojimo kreiptis tinklapyje nurodytais kontaktais.
5003 Nurodytas raktas yra blogas arba negaliojantis
5004 Privaloma nurodyti pašto kodų API raktą. Dėl šio apribojimo kreiptis tinklapyje nurodytais kontaktais.

Nemokamas išbandymas

Nemokamas API raktas leidžia atlikti iki 100 užklausų iš vieno IP adreso arba domeno per dieną į v1 ir v2 API. Dėl nemokamo API rakto, ar laikino v5 išbandymo, kreiptis nurodytais kontaktais.

Pasiekus dienos ribą, išvedamas rezultatas:

{
    "status": "error",
    "success": false,
    "message": "Vir\u0161ytas dienos u\u017eklaus\u0173 limitas",
    "message_code": 5002,
    "total": 0,
    "data": []
}

Pašto kodų duomenų bazės naudojimas per WEB API yra nemokamas, todėl privaloma nurodyti (įdėti nuorodą), kad pašto kodai gaunami naudojant postit.lt:

<a href="https://postit.lt/" title="Lietuvos adresų paieška">Lietuvos adresų paieška</a>

Mokami planai

Jei reikia daugiau nei 100 užklausų, tai siūlome:

Trumpiausias užsakymo laikotarpis yra 3 mėn.

🎁 Apmokant už 12 mėn. suteikiama 10% nuolaida.

Jei pasirenkamas vienas iš šių mokamų variantų, tai nuorodos talpinimas nėra būtinas.

Esant poreikiui galima įsigyti visą Lietuvos pašto kodų ir adresų duomenų bazę.

Susisiekti nurodytais kontaktais.