Ģeokodēšana
Serviss ļauj iegūt adreses informāciju un ģeotelpiskos datus no ievadītā adreses teksta lauka.
Servisa URL
Servisa saitei jāatbilst šādai formai:
https://api.kartes.lv/v3//geocoding?
Noklusētais atgriezto datu formāts ir JSON (pieejami arī JSONP un XML).
HTTP metode ir GET.
Pieprasījuma parametri
Iespējams padot šādus GET parametrus:
Parametrs | Skaidrojums | Vērtības |
---|---|---|
address | Teksts, kurā ievadīta adrese vai tās hash. | Parametrs obligāts, ja nav izvēlēts address_code |
address_code | Teksts, kurā ievadīts adreses kods. | Parametrs obligāts, ja nav izvēlēts address |
limit | Parametrs nosaka rezultāta maksimālo objektu skaitu. | Parametra vērtība - no 1 līdz 25 (noklusētā vērtība). |
LVA | Ja parametrs netiek padots, tad dati tiek meklēti Baltijā. Ja nepieciešams meklēt tikai Latvijā, tad jāpadod šis parametrs. | |
result_data_type | Nosaka atgriežamo datu formātu. | Pieejami 3 formāti:
|
callback | Tiek izsaukta šī parametra funkcija. | Parametrs aktuāls, ja izvēlas result_data_type=jsonp |
historical | Atgriež vēsturiskās adreses | Ja parametrs nav norādīts, meklē tikai aktuālās adreses. Ja parametra vērtība nav norādīta, meklē vēsturiskajās adresēs, ja neatrod aktuālajās adresēs. Ja parametra vērtība ir only, meklē tikai vēsturiskajās adresēs |
strict | Precīza adreses meklēšana | 1 |
Atbildes parametri
Atbildē tiek atgriezts masīvs ar objektiem, objektu parametri ir šādi:
Parametrs | Skaidrojums |
---|---|
rank | Atrastās adreses pareizuma ticamības vērtējums. |
gid | Datubāzes ieraksta identifikators. |
valsts | Valsts nosaukums. |
admin_vien | Administratīvā vienība. |
terit_vien | Teritoriālā vienība. |
apdz_vieta | Apdzīvota vieta. |
iela | Iela. |
maja | Māja. |
index | Pasta indekss. |
korpuss | Korpuss. |
x | Punkta X koordināta TM Baltic93 (EPSG:25884) koordinātu sistēmā. |
y | Punkta Y koordināta TM Baltic93 (EPSG:25884) koordinātu sistēmā. |
address_hash | Adreses hash. |
iso_code | Valsts ISO kods. |
vzd_id | adreses kods. |
lat | Ģeogrāfiskais platums WGS (EPSG:4326) formātā. |
lon | Ģeogrāfiskais garums WGS (EPSG:4326) formātā. |
adrese | Pilnā adrese. |
Kļūdu kodi
Kods | Skaidrojums |
---|---|
400 | Wrong input data. Tiek atgriezts, ja vaicājumā nav ievadīti vai nav korekti ievadīti pieprasījuma parametri. |
404 | No location found. Tiek atgriezts, ja nekas nav ticis atrasts. |
5xx | Servera kļūda. |
Paraugi
Pieprasījums:
https://api.kartes.lv/v3//geocoding?address=Brīvības&limit=1
Atbilde:
[
{
"rank": "0.333333",
"gid": "487606023",
"valsts": "Latvija",
"admin_vien": "Ventspils",
"terit_vien": "Ventspils pilsēta",
"apdz_vieta": "Ventspils",
"iela": "Brīvības iela",
"maja": "1A",
"index": "LV-3601",
"korpuss": "",
"x": "354278.323000",
"y": "6364308.441998",
"address_hash": "cae33907edc0cdb37093b83db1bc14b8",
"iso_code": "LVA",
"vzd_id": "106279496",
"lat": 57.398171,
"lon": 21.574947,
"adrese": "Brīvības iela 1A, Ventspils, Latvija"
}
]