Геокодировать адрес
Geocoder.geocode
Преобразует структурированный адрес с обязательным полем city в координаты и данные соответствующего адреса.
Параметры body
| Тело запроса | Тип | Описание |
|---|---|---|
address | object ОБЯЗАТЕЛЬНО | Передайте объект адреса с обязательным полем city. Остальные поля необязательны; укажите достаточно данных для поиска совпадения. |
country | string | Необязательный код страны. Отсутствующее или null означает PL; пустое значение остается пустым. Для польских адресов используйте PL заглавными буквами. Международное геокодирование требует соответствующего доступа. |
province | string | Необязательное название воеводства; автоматически не заполняется. |
district | string | Необязательное. Отсутствующее или null дает пустую строку. |
community | string | Необязательное. Отсутствующее или null дает пустую строку. |
city | string ОБЯЗАТЕЛЬНО | Название города city обязательно в каждом адресе, в том числе для PL. |
quarter | string | Необязательное. Отсутствующее или null дает пустую строку. |
pcode | string | Необязательное. Отсутствующее или null дает пустую строку. |
street | string | Необязательное. Отсутствующее или null дает пустую строку. |
house | string | Необязательное. Отсутствующее или null дает пустую строку. |
maxResult | integer | Для польских адресов не более 1–3 совпадений на адрес (по умолчанию 1). Значения вне диапазона ограничиваются до 1–3. Задайте maxResult в каждом адресе; maxResults не задает этот предел. |
Пример запроса
{
"address": {
"country": "PL",
"city": "Warszawa",
"street": "Domaniewska",
"house": "37"
}
}Пример ответа
{
"result": [
{
"quality": 9,
"x": 21.0071318,
"y": 52.18284,
"country": "PL",
"province": "mazowieckie",
"district": "Warszawa",
"community": "Warszawa",
"city": "Warszawa",
"quarter": "Mokotów",
"pcode": "02-672",
"street": "Domaniewska",
"house": "37",
"resultRadius": 0,
"flat": ""
}
]
}Пример показывает выбранные поля ответа. Фактические координаты и почтовые данные зависят от входных и актуальных картографических данных; также могут присутствовать расширенные поля, доступные при наличии разрешений.
поля result
| поля result | Тип | Описание |
|---|---|---|
quality | integer | Geocoding quality score. |
x | double | Longitude (WGS84). |
y | double | Latitude (WGS84). |
country | string | Country code. |
province | string | Province. |
district | string | District (powiat). |
community | string | Community (gmina). |
city | string | City. |
quarter | string | Quarter. |
pcode | string | Postal code (PL only). |
street | string | Street. |
house | string | House number. |
addressType | integer РАСШИРЕННЫЕ | Building type. Extended. |
peoplesForAddress | integer РАСШИРЕННЫЕ | Residents at address. Extended. |
flatsForAddress | integer РАСШИРЕННЫЕ | Flats at address. Extended. |
buildingsForAddress | integer РАСШИРЕННЫЕ | Buildings at address. Extended. |
pcodeExtraInfo | object[] РАСШИРЕННЫЕ | Extra postal-code info. Extended. |
resultRadius | number | Result envelope radius (m). -1 if unknown. |
mapLink | string | Link to map result. |