Skip to content

Получить подсказки городов и населённых пунктов

Request

Возвращает населённые пункты из собственного справочника ГАР/ФИАС в Meilisearch для автозаполнения форм. Использует ту же выборку и порядок, что и /api/search/places, но возвращает названия, регион, район и координаты без признаков метро и районов.

Правила поиска:

  • query обязателен как параметр
  • если query пустой или состоит из пробелов, возвращается пустой список
  • длина query после удаления начальных и конечных пробелов должна быть не больше 300 символов
  • limit необязателен, значение по умолчанию 5
  • limit должен быть в диапазоне от 1 до 20
  • сначала ищутся совпадения по названиям населённых пунктов: город, ПГТ, деревня, село, прочие
  • только при нехватке совпадений по имени остаток лимита заполняется населёнными пунктами совпавшего региона с тем же порядком типов
  • все совпадения по имени предшествуют региональному добору; дубликаты исключаются по ФИАС GUID
  • ошибка поиска по имени возвращает 422 address_suggestions_failed; сбой регионального добора сохраняет успешную часть по имени, в том числе пустую

Требования:

  • требуется JWT
Security
bearerAuth or jwtCookie
Query
querystringrequired

Строка поиска города или населённого пункта. Параметр обязателен, но для пустой строки или строки из пробелов возвращается успешный ответ с data.items: [].

Example:query=моск
limitinteger, (int32), [ 1 .. 20 ]

Максимальное количество подсказок. Значение вне диапазона от 1 до 20 отклоняется с HTTP 400.

Default:5
Example:limit=5
curl -i -X GET \
  'https://felmee.com/api/suggestions/cities?query=%D0%BC%D0%BE%D1%81%D0%BA&limit=5' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Подсказки городов и населённых пунктов успешно получены

Bodyapplication/json
codeErrorstring or nullrequired

Устаревший camelCase-alias поля error_code; при ошибке оба поля содержат одинаковое значение.

successbooleanrequired

Флаг успешного выполнения запроса

messagestringrequired

Человекочитаемое описание результата

error_codestring or null(ERROR_CODE)required

Код ошибки. Для успешных ответов всегда null.

Enum:"INVALID_BODY""INVALID_DATE""invalid_body""unauthorized""not_found""slot_unavailable""conflict""BUSINESS_INACTIVE""INSUFFICIENT_FUNDS""REQUISITES_REQUIRED"
dataobject or null(CitySuggestionsData)required

Полезная нагрузка. Может быть объектом, массивом или null.

Response
{ "success": true, "message": "City suggestions retrieved successfully", "codeError": null, "error_code": null, "data": { "items": [ … ] } }