Skip to content

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

Request

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

Правила:

  • query обязателен как параметр
  • пустой query возвращает пустой список
  • query после удаления пробелов по краям должен быть не длиннее 300 символов
  • limit необязателен, значение по умолчанию 5, диапазон от 1 до 20
  • сначала ищутся совпадения по названиям населённых пунктов: город, ПГТ, деревня, село, прочие
  • только при нехватке совпадений по имени остаток лимита заполняется населёнными пунктами совпавшего региона с тем же порядком типов
  • все совпадения по имени предшествуют региональному добору; дубликаты исключаются по fias_id
  • для всех типов, кроме настоящих городов, оба признака всегда равны false
  • ошибка поиска по имени возвращает 422 address_suggestions_failed; при сбое регионального добора сохраняется успешный результат по имени, в том числе пустой
  • публичный type=city|settlement задаёт адресный уровень для /api/search/addresses, а не один из пяти типов населённых пунктов
Security
bearerAuth or jwtCookie
Query
querystringrequired

Название или начало названия населённого пункта; при нехватке совпадений выполняется добор по региону. После удаления пробелов по краям длина не должна превышать 300 символов.

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

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

Default:5
Example:limit=5
curl -i -X GET \
  'https://felmee.com/api/search/places?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"
dataArray of objects or null(PlaceSearchItem)required

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

Response
{ "success": true, "message": "Place search completed successfully", "codeError": null, "error_code": null, "data": [ { … }, { … } ] }