Подсказчик адреса и мест интереса
Подсказчик — это сервис, предлагающий подсказки для автозаполнения адреса и/или названий мест интереса при посимвольном вводе в строку поиска.
/suggest — точка вызова подсказчика адреса и названий мест интереса при посимвольном вводе.
Запрос
Обязательные параметры запроса
Имя поля
|
Формат
|
Описание
|
Пример
| |
---|---|---|---|---|
api_key |
hex-string |
Доступ к сервисам |
|
|
q |
string |
Тело поискового запроса |
|
Дополнительные параметры запроса
Имя поля
|
Формат
|
Описание
|
Пример
| |
---|---|---|---|---|
fields |
fieldname1,fieldname2,.... fieldnameN |
Выбор полей, отображаемых в ответе. Возможные значения:
|
|
|
types | string |
Тип объектов по которым осуществляется поиск:
|
|
|
lang | 2-х символьный код языка |
Язык ответа на одном из доступных языков. По умолчанию на языке региона, в котором найден объект. |
|
|
location | string |
Координата, относительно которой будет осуществляться поиск и ранжирование результатов ответа. Координаты в формате lat, lon, где:
|
|
|
radius | integer |
Радиус поиска в метрах относительно параметра location. Параметр location при использовании параметра radius является обязательным.
В случае использования малого радиуса объект может быть не найден. |
|
|
admin_level |
rank number |
Ограничение ответа по административному уровню. Используется совместно с types=address. Возможные значения:
По умолчанию ограничение не задано — поиск осуществляется по всем административным уровням. |
|
|
limit |
integer |
Ограничение числа объектов в ответе. Поддерживаются значения в интервале от 1 до 100. По умолчанию: 5 В случае использования больших значений длительность получения ответа может увеличиться
|
|
Ответ
Ответ предоставляется только в JSON формате. Используемый JSON формат является разработанным для сервиса Подсказчик v.3 и содержит информацию, найденную по запросу.
JSON формат
Имя поля
|
Формат
|
Описание
|
Пример
| |
---|---|---|---|---|
request |
string |
Запрос |
|
|
results | list | Найденный результат |
|
|
address | string | Полный найденный адрес |
|
|
address_details | list | Детальная информация о найденном адресе |
|
|
ref | hex |
ID найденного объекта ID объекта не является стабильным и может изменяться |
|
|
type | string | Тип найденного объекта |
|
|
name | string | Название найденного объекта |
|
Описание полей address_details
Имя поля
|
Формат
|
Описание
|
Пример
| |
---|---|---|---|---|
country | string | Страна |
|
|
isocode | 2char | Двухбуквенный код страны согласно ISO 3166-1 alpha-2 |
|
|
region | string | Область |
|
|
subregion | string | Район |
|
|
locality | string | Населённый пункт |
|
|
sublocality | string | Микрорайон или название жилого комплекса |
|
|
street | string | Улица |
|
|
building | string | Номер дома, части дома или строения |
|
|
suburb | string | Район/микрорайон населённого пункта |
|
|
postal_code | string | Почтовый код |
|
Пример
Запрос
https://geo.rustore.ru/api/suggest?api_key=<YOUR_API_KEY>&limit=3&q=Москва%20Ленинградский%2039 |
Ответ
{ "request": "/suggest?limit=2&q=Москва Ленинградский 39&api_key=demo_demo_main", "results": [ { "address": "Россия, Москва, Северный административный округ, Москва, Хорошёвский, Ленинградский проспект, 39 с79", "name": "Ленинградский проспект, 39 с79", "type": "building" }, { "address": "Россия, Москва, Северный административный округ, Москва, Хорошёвский, Ленинградский проспект, 39 с80", "name": "Ленинградский проспект, 39 с80", "type": "building" }, { "address": "Россия, Москва, Северный административный округ, Москва, Хорошёвский, Ленинградский проспект, 39 с3", "name": "УСК ЦСКА им. А.Я. Гомельского", "type": "building" } ] } |