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

Request

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

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

query обязателен как параметр
если query пустой или состоит из пробелов, возвращается пустой список
query должен быть не длиннее 300 символов
limit необязателен, значение по умолчанию 5
limit должен быть в диапазоне от 1 до 20
лимит последовательно заполняется в порядке: город, ПГТ, село, деревня

Требования:

требуется JWT

Security

bearerAuth or jwtCookie

Query

querystring, <= 300 charactersrequired

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

Example:query=моск

limitinteger, (int32), [ 1 .. 20 ]

Максимальное количество подсказок. Сервер ограничивает значение диапазоном от 1 до 20.

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""unauthorized""not_found""conflict""object_modified_by_another_thread""action_too_late""too_many_request""code_is_gone""forbidden""user_blocked"

dataobject or null(CitySuggestionsData)required

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

Response

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