Suggest Address

POST

/suggest/address

If you're interested in the English version of this spec, let us know on the GitHub.

Ищет адреса по любой части адреса от региона до квартиры:
самара авроры 7 12 → 443017, Самарская обл, г Самара, ул Авроры, д 7, кв 12.
Также ищет по почтовому индексу:
105568 → г Москва, ул Магнитогорская.

Official documentation:

https://dadata.ru/api/suggest/address/https://confluence.hflabs.ru/pages/viewpage.action?pageId=204669107https://dadata.ru/suggestions/usage/address/

Authorizations

ApiKey

API-ключ. Полный вид заголовка: Authorization: Token <YOUR_KEY>. Получить ключ

Type

API Key (header: Authorization)

Request Body

application/json

object

Параметры запроса к API "Подсказки по адресу".

See https://dadata.ru/api/suggest/address/
See https://confluence.hflabs.ru/pages/viewpage.action?pageId=204669107

Текст запроса.
@maxLength 300

Max Length300

Максимальное количество результатов.
@minimum 1
@maximum 20
@default 10

Minimum1

Maximum20

Default10

object[]

Приоритет города или региона при ранжировании.
Передавайте код КЛАДР (kladr_id). Можно указать несколько кодов.

See https://confluence.hflabs.ru/pages/viewpage.action?pageId=285343795

object

Гранулярные подсказки – "левая" граница.

Если задано, ответ будет включать только объекты
этого уровня и ниже; поиск также производится в первую очередь по объектам этого уровня и ниже.

Примеры: если указать from_bound = 'settlement':

• Запрос "москва" → в результатах не будет подсказки непосредственно "г Москва",
  но будут поселения и улицы, в названии которых есть "москва".
• Запрос "москва, 3" → попытается найти нас.пункты и улицы с этим сочетанием
  в названии, но результаты также могут включать, например, "г Москва, ул 3-я Бебеля"

Доступные границы для from_bound:

• country - Страна
• region - Регион
• area - Район
• city - Город
• settlement - Населенный пункт
• planning_structure - Планировочная структура (в официальной документации - только для ФИАС,
  но работает также для подсказок по адресу)
• street - Улица
• house - Дом

See https://confluence.hflabs.ru/pages/viewpage.action?pageId=222888017

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

• country - Страна
• region - Регион
• area - Район
• city - Город
• settlement - Населенный пункт
• planning_structure - Планировочная структура (в официальной документации - только для ФИАС,
  но работает также для подсказок по адресу)
• street - Улица
• house - Дом
• flat - Квартира (только для to_bound)

Valid values"country""region""area""city""settlement""planning_structure""street""house""flat"

object

Гранулярные подсказки – "правая" граница.

Если задано, подсказки будут только до этой границы (включительно).
Например, чтобы исключить поиск по улицам, можно указать to_bound = 'settlement',
и при запросе "москва новая" результаты не будут включать "г Москва, ул Новая",
но могут включать "Брянская обл, пос. Новая Москва".

Доступные границы для from_bound:

• country - Страна
• region - Регион
• area - Район
• city - Город
• settlement - Населенный пункт
• planning_structure - Планировочная структура (в официальной документации - только для ФИАС,
  но работает также для подсказок по адресу)
• street - Улица
• house - Дом
• flat - Квартира

See https://confluence.hflabs.ru/pages/viewpage.action?pageId=222888017

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

• country - Страна
• region - Регион
• area - Район
• city - Город
• settlement - Населенный пункт
• planning_structure - Планировочная структура (в официальной документации - только для ФИАС,
  но работает также для подсказок по адресу)
• street - Улица
• house - Дом
• flat - Квартира (только для to_bound)

Valid values"country""region""area""city""settlement""planning_structure""street""house""flat"

object[]

Ограничение сектора поиска адреса.

Чтобы искать адреса только в определенном регионе, городе, районе и т.д.,
укажите их в параметре locations.
Можно указать несколько ограничений, но не более 10.

Адрес без региона и города:
Чтобы адрес одной строкой в ответе (поле value) не содержал регион / город, заданный в ограничении,
добавьте в запрос параметр restrict_value = true.

See https://confluence.hflabs.ru/pages/viewpage.action?pageId=204669108

Ограничение по ISO-коду страны в формате ISO_3166.
Например: BY.
По умолчанию - RU.
Чтобы разрешить любые страны - укажите *.

ISO-код региона. Например: BY-BR

Ограничение по КЛАДР-коду. Например:

• 63 — Самарская обл.
• 63000001 — г. Самара
• 6300000100000 — г. Самара (полный код)

Не рекомендуем использовать для объектов ниже города:

• не слишком надежно для населенных пунктов (КЛАДР-коды н/п довольно часто меняются);
• не работает для план. структур (они появились после того, как была придумана иерархия КЛАДР, и не вписываются в нее);
• очень ненадежно для улиц (КЛАДР-коды улиц часто меняются);
• не работает для домов.

Рекомендуем использовать fias_id - ограничение по ФИАС-коду.

Ограничение по ФИАС-коду.

Например: "fias_id": "110d6ad9-0b64-47cf-a2ee-7e935228799c" - Санкт-Петербург, г Пушкин

Ограничение по fias_id дома не поддерживается

Ограничение по ФИАС-коду региона. Лучшая альтернатива - fias_id.

Ограничение по ФИАС-коду административного района. Лучшая альтернатива - fias_id.

Ограничение по ФИАС-коду города. Лучшая альтернатива - fias_id.

Ограничение по ФИАС-коду населённого пункта. Лучшая альтернатива - fias_id.

Ограничение по ФИАС-коду планировочной структуры. Лучшая альтернатива - fias_id.

• не задокументировано для API адресов, только для API ФИАС, но работает

Ограничение по ФИАС-коду улицы. Лучшая альтернатива - fias_id.

Ограничение по названию страны

Ограничение по названию региона

Ограничение по названию административного района

Ограничение по названию города

Ограничение по названию района города

• не задокументировано для API адресов, только для API ФИАС, но работает

Ограничение по названию населённого пункта

Ограничение по названию планировочной структуры

• не задокументировано для API адресов, только для API ФИАС, но работает

Ограничение по названию улицы

Ограничение по полному типу региона, например: республика

Ограничение по полному типу адм. района в регионе. Например: улус

Ограничение по полному типу города. Например: поселок городского типа

Ограничение по полному типу района города.

• не задокументировано для API адресов, только для API ФИАС, но работает

Ограничение по полному типу населенного пункта. Например: деревня

Ограничение по полному типу планировочной структуры. Например: территория снт

• не задокументировано для API адресов, только для API ФИАС, но работает

Ограничение по полному типу улицы. Например: проспект