Suggest API

Пользователь начинает вводить текст в строку поиска, Suggest API предлагает список подходящих вариантов, исходя из запроса пользователя и его локации.

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

В примере вводится часть текста из запроса «кафе» и задаётся точка, относительно которой осуществляется поиск.

https://catalog.api.2gis.ru/3.0/suggests?q=каф&sort_point=37.630866,55.752256&key=YOUR_KEY

Не забудьте заменить YOUR_KEY на ваш ключ API (см. Как начать работать с API).

Пример ответа в формате JSON:

{
    "meta": {
        "api_version": "3.0.428313",
        "code": 200,
        "issue_date": "20200513"
    },
    "result": {
        "items": [
            {
                "search_attributes": {
                    "handling_type": 2,
                    "suggest_parts": [
                        {
                            "is_suggested": false,
                            "text": "каф"
                        },
                        {
                            "is_suggested": true,
                            "text": "е с wifi"
                        }
                    ],
                    "suggested_text": "кафе с wifi"
                },
                "type": "user_query"
            }
        ],
        "total": 1
    }
}

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

В результате можно получить следующие типы подсказок:

предполагаемый текст пользовательского запроса;
объекты из справочника, такие как компании, населённые пункты, остановки, улицы, рубрики и другие.

Полный список типов можно узнать в описании API.

Типы подбора подсказок

В зависимости от потребности пользователя и бизнес-задачи можно по-разному формировать результат подбора подсказок, используя параметр suggest_type. Ниже описаны самые используемые алгоритмы подбора. С полным списком алгоритмов можно ознакомиться в описании API.

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

В результате поиска могут быть дом или улица. Удобно для выбора конкретного дома. В запрос нужно добавить suggest_type=address.

Для подбора подсказки только для улиц нужно указать suggest_type=street.

Подсказка конечной точки маршрута

В результате могут быть дома, компании, остановки и другие объекты справочника, привязанные к точке на карте. Подбираются по частичному или полному совпадению текста. В запрос нужно добавить suggest_type=route_endpoint.

Подсказка объектов справочника

В результате только объекты справочника - дома, компании, остановки и другие. В результаты не попадают дополнение текста пользовательского запроса. В результате могут быть объекты без привязки к точке на карте, например, интернет-магазины.

В запрос нужно добавить suggest_type=object.

Начало работы

Получите ключ. Для этого заполните анкету.
Изучите формат запроса и формат ответа.