Подсказчик адреса и мест интереса

Подсказчик — это сервис, предлагающий подсказки для автозаполнения адреса и/или названий мест интереса при посимвольном вводе в строку поиска.

/suggest — точка вызова подсказчика адреса и названий мест интереса при посимвольном вводе.

Запрос

Обязательные параметры запроса

Имя поля
Формат
Описание
Пример
 
api_key

hex-string

 Доступ к сервисам

api_key=fa749bace6d8a3b1....

q

string

 Тело поискового запроса
q=Россия Москва
q=Москва Ленинградс
q=Москва Ленинградский проспект
q=Москва Ленинский д. 1
q=метро Аэро

Дополнительные параметры запроса

Имя поля
Формат
Описание
Пример

fields

 fieldname1,fieldname2,.... fieldnameN

Выбор полей, отображаемых в ответе.

Возможные значения:

  • name (по умолчанию) — найденный объект;
  • address_details — детальная информация о найденном адресе с почтовым индексом без координат;
  • address (по умолчанию) — полный найденный адрес одной строкой;
  • ref — ID найденного объекта;
  • type (по умолчанию) — тип объекта.

fields=name
types string

Тип объектов по которым осуществляется поиск:

  • address (по умолчанию) — адрес;
  • place — название места интереса.
type=address,place
lang 2-х символьный код языка

Язык ответа на одном из доступных языков. 

По умолчанию на языке региона, в котором найден объект.
lang=en
location string

Координата, относительно которой будет осуществляться поиск и ранжирование результатов ответа. 

Координаты в формате lat, lon, где:

  • lat — широта искомой точки в градусах. Используется 6 знаков после запятой;
  • lon — долгота искомой точки в градусах. Используется 6 знаков после запятой.

Результаты поиска будут отсортированы по расстоянию от указанной координаты
location=55.796743,37.537354
radius integer

Радиус поиска в метрах относительно параметра location.

Параметр location при использовании параметра radius является обязательным.

В случае использования малого радиуса объект может быть не найден.
radius=500

admin_level

rank number

Ограничение ответа по административному уровню. Используется совместно с types=address.

Возможные значения:

  • 1 — страна;
  • 2 — регион;
  • 3 — населённый пункт;
  • 4 — улица;
  • 5 — дом.

По умолчанию ограничение не задано — поиск осуществляется по всем административным уровням. 
admin_level=3
limit

integer

Ограничение числа объектов в ответе. Поддерживаются значения в интервале от 1 до 100.

По умолчанию: 5

В случае использования больших значений длительность получения ответа может увеличиться
limit=10

Ответ

Ответ предоставляется только в JSON формате. Используемый JSON формат является разработанным для сервиса Подсказчик v.3 и содержит информацию, найденную по запросу.

JSON формат

Имя поля
Формат
Описание
Пример
request

string

Запрос
"request": "/v3/suggest?limit=3&q=Москва Ленинградский 39&fields=name,address_details,address,ref,type"
results list Найденный результат
"results": [
    {
      "address": "Россия, Москва, Северный административный округ, Москва, Хорошёвский, Ленинградский проспект, 39 с79",
      "address_details": {
        "building": "39 с79",
        "country": "Россия",
        "isocode": "RU",
        "locality": "Москва",
        "region": "Москва",
        "street": "Ленинградский проспект",
        "subregion": "Северный административный округ",
        "suburb": "Хорошёвский"
      },
      "ref": "1000000C4D63818",
      "type": "building"
      "name": "Ленинградский проспект, 39 с79",
    }
  ]
address string Полный найденный адрес
"address": "Россия, Москва, Северный административный округ, Москва, Хорошёвский, Ленинградский проспект, 39 с79",
address_details list Детальная информация о найденном адресе 
"address_details": {
        "building": "39 с79",
        "country": "Россия",
        "isocode": "RU",
        "locality": "Москва",
        "region": "Москва",
        "street": "Ленинградский проспект",
        "subregion": "Северный административный округ",
        "suburb": "Хорошёвский"
      }
ref hex

ID найденного объекта

ID объекта не является стабильным и может изменяться
"ref": "1000000C4D63818"
type string Тип найденного объекта
"type": "building"
name string Название найденного объекта
"name": "Ленинградский проспект, 39 с79"

Описание полей address_details

Имя поля
Формат
Описание
Пример
country string Страна
"country": "Россия"
isocode 2char Двухбуквенный код страны согласно ISO 3166-1 alpha-2
"isocode": "RU"
region string Область
"region": "Москва"
subregion string Район
"subregion": "Северный административный округй"
locality string Населённый пункт
"locality": "Москва"
sublocality string Микрорайон или название жилого комплекса
"sublocality": "Аэропорт"
street string Улица
"street": "Проспект Ленинградский"
building string Номер дома, части дома или строения
"building": "39 с80"
suburb string  Район/микрорайон населённого пункта
"suburb": "Хорошёвский"
postal_code string Почтовый код
"postal_code": "125167"

Пример

Запрос

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"
    }
  ]
}
Обновлено 22 декабря 2022 г.
Was this information helpful?