Skip to content

Подсказки

Подсказки для быстрого заполнения пользовательских форм.

Operations

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

Request

Возвращает подсказки адресов DaData с координатами.

Правила:

  • параметр query обязателен, максимальная длина — 300 символов;
  • fias_id и type должны быть получены из /api/search/places;
  • при type=city используется city_fias_id, при type=settlement — settlement_fias_id;
  • limit по умолчанию равен 10, допустимый диапазон — от 1 до 20;
  • требуется JWT пользователя.
Security
bearerAuth or jwtCookie
Query
querystring, [ 1 .. 300 ] characters.*\S.*required

Строка поиска адреса.

Example:query=Москва, Тверская
fias_idstring, [ 1 .. 100 ] characters.*\S.*required

FIAS ID selected in /api/search/places.

Example:fias_id=0c2b5982-132d-4941-8fad-c94c6334fc91
typestringrequired

DaData locality level associated with the FIAS ID.

Enum:"city""settlement"
Example:type=city
limitinteger, (int32), [ 1 .. 20 ]

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

Default:10
Example:limit=5
curl -i -X GET \
  'https://felmee.com/api/search/addresses?query=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0%2C%20%D0%A2%D0%B2%D0%B5%D1%80%D1%81%D0%BA%D0%B0%D1%8F&fias_id=0c2b5982-132d-4941-8fad-c94c6334fc91&type=city&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(AddressSearchSuggestionsData)required

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

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