API подсказок

Endpoints для автодополнения при вводе ФИО и адресов.

Подсказки ФИО

GET /api/v1/suggest/name?query=...

Параметры запроса

ПараметрТипОписание
querystringНачало ФИО (мин. 2 символа)
countnumberКоличество результатов (по умолчанию 5)

Пример запроса

curl "https://api.humandata.ru/api/v1/suggest/name?query=ива" \
-H "Authorization: Token YOUR_API_KEY"

Пример ответа

{
"suggestions": [
{"value": "Иванов", "data": {"gender": "m"}},
{"value": "Иванова", "data": {"gender": "f"}},
{"value": "Иван", "data": {"gender": "m"}},
{"value": "Ивановский", "data": {"gender": "m"}}
]
}

Подсказки адресов

GET /api/v1/suggest/address?query=...

Параметры запроса

ПараметрТипОписание
querystringНачало адреса
countnumberКоличество результатов (по умолчанию 5)
locationsstringОграничение по региону (код КЛАДР)

Пример запроса

curl "https://api.humandata.ru/api/v1/suggest/address?query=москва%20ленин" \
-H "Authorization: Token YOUR_API_KEY"

Пример ответа

{
"suggestions": [
{
"value": "г Москва, Ленинский просп",
"data": {
"postal_code": "119334",
"fias_id": "...",
"region": "Москва"
}
},
{
"value": "г Москва, ул Ленинская Слобода",
"data": {
"postal_code": "115280",
"fias_id": "...",
"region": "Москва"
}
}
]
}

Рекомендации по использованию

  • Используйте debounce (300-500ms) для сокращения количества запросов
  • Начинайте запрашивать подсказки от 2 символов
  • Кэшируйте результаты на клиенте для повторных запросов
  • Используйте параметр locations для ограничения по региону