Перейти к основному содержимому

Автодополнение

Автодополнение (3.0)

2GIS API Support: api@2gis.ru URL: https://docs.2gis.com/

Автодополнение

Получение коллекции предложенных объектов

Возвращает коллекцию объектов, подходящих к пользовательскому вводу.

query Parameters
key
required
string

Уникальный ключ пользователя API.

locale
string
Examples:
  • locale=ar_AE - Арабский язык для ОАЭ
  • locale=ru_RU - Русский язык для России

Локаль, с которой производится поиск и отдаются результаты.
Список доступных локалей:

  • az_AZ — азербайджанский (Азербайджан);
  • ru_AZ — русский (Азербайджан);
  • hy_AM — армянский (Армения);
  • ru_AM — русский (Армения);
  • ar_BH — арабский (Бахрейн);
  • en_BH — английский (Бахрейн);
  • ru_BY — русский (Беларусь);
  • ka_GE — грузинский (Грузия);
  • ru_GE — русский (Грузия);
  • en_EG — английский (Египет);
  • ar_EG — арабский (Египет);
  • it_IT — итальянский (Италия);
  • en_IQ — английский (Ирак);
  • ar_IQ — арабский (Ирак);
  • kk_KZ — казахский (Казахстан);
  • ru_KZ — русский (Казахстан);
  • en_QA — английский (Катар);
  • ar_QA — арабский (Катар);
  • en_CY — английский (Кипр);
  • es_CL — испанский (Кипр);
  • ky_KG — кыргызский (Кыргызстан);
  • ru_KG — русский (Кыргызстан);
  • en_CN — английский (Китай);
  • zh_CN — китайский (Китай);
  • ru_CN — русский (Китай);
  • en_KW — английский (Кувейт);
  • ar_KW — арабский (Кувейт);
  • en_MA — английский (Марокко);
  • ar_MA — арабский (Марокко);
  • en_AE — английский (ОАЭ);
  • ar_AE — арабский (ОАЭ);
  • en_OM — английский (Оман);
  • ar_OM — арабский (Оман);
  • en_RU — английский (Россия);
  • ar_RU — арабский (Россия);
  • es_RU — испанский (Россия);
  • it_RU — итальянский (Россия);
  • ru_RU — русский (Россия);
  • uk_RU — украинский (Россия);
  • cs_RU — чешский (Россия);
  • en_SA — английский (Саудовская Аравия);
  • ar_SA — арабский (Саудовская Аравия);
  • ru_TJ — русский (Таджикистан);
  • tg_TJ — таджикский (Таджикистан);
  • ru_UZ — русский (Узбекистан);
  • uz_UZ — узбекский (Узбекистан);
  • ru_UA — русский (Украина);
  • uk_UA — украинский (Украина);
  • cs_CZ — чешский (Чехия).

q
required
string [ 1 .. 500 ] characters

Произвольная поисковая строка.

fields
Array of strings
Examples:
  • fields=items.region_id,items.name_ex - Пример нескольких типов
  • fields=items.region_id - Пример единичного типа

Дополнительные поля, которые необходимо отобразить в ответе, перечисляются через запятую. Поля с пометкой требуется дополнительное разрешение у ключа API будут присутствовать в выдаче только при выставленных разрешениях на это поле у ключа. По умолчанию ключ не имеет никакие из указанных дополнительных разрешений.
Список полей с информацией о геометрии и адресе места:

  • items.point — координаты объекта, заданные в системе координат WGS84 в формате lon, lat;
  • items.address — адрес, по которому располагается объект;
  • items.adm_div — принадлежность к административной территории;
  • items.full_address_name — адрес объекта с указанием города;
  • items.geometry.centroid — визуальный центр геометрии объекта;
  • items.geometry.hover — геометрия области, используемой для определения попадания курсора в зону объекта;
  • items.geometry.selection — геометрия для выделения объекта;

Список полей с дополнительной информацией о месте:
  • items.rubrics — категории компании;
  • items.org — организация, к которой относится филиал;
  • items.schedule — расписание работы компании;
  • items.schedule_special — особое расписание работы компании;
  • items.access_comment — локализованное название для типа доступа;
  • items.access — тип доступа для парковки;
  • items.capacity — вместимость парковки;
  • items.description — описание геообъекта;
  • items.flags — список признаков объекта. Например, что для объекта есть фотографии, или что филиал временно не работает и т.д. Список доступных признаков можно посмотреть в схеме ответа внутри items;
  • items.floors — количество этажей (требуется дополнительное разрешение у ключа API);
  • items.floor_plans — планы этажей (требуется дополнительное разрешение у ключа API);
  • items.is_paid — является ли парковка платной;
  • items.for_trucks — парковка для грузовиков;
  • items.paving_type — тип покрытия парковки;
  • items.is_incentive — является ли парковка перехватывающей;
  • items.purpose — назначение парковки;
  • items.level_count — количество уровней парковки;
  • items.name_ex — составные части наименования объекта;
  • items.reviews — статистика по отзывам об объекте;
  • items.employees_org_count — численность сотрудников организации (требуется дополнительное разрешение у ключа API);
  • items.itin — индивидуальный номер налогоплательщика (требуется дополнительное разрешение у ключа API);
  • items.trade_license — лицензия филиала (требуется дополнительное разрешение у ключа API);
  • items.fias_code — код ФИАС улиц и административных территорий (требуется дополнительное разрешение у ключа API);
  • items.address.components.fias_code — код ФИАС зданий (требуется дополнительное разрешение у ключа API);
  • items.fns_code — код ФНС административных территорий (требуется дополнительное разрешение у ключа API);
  • items.okato — код ОКАТО улиц и административных территорий (требуется дополнительное разрешение у ключа API);
  • items.address.components.okato — код ОКАТО зданий (требуется дополнительное разрешение у ключа API);
  • items.oktmo — код ОКТМО улиц и административных территорий (требуется дополнительное разрешение у ключа API);
  • items.address.components.oktmo — код ОКТМО зданий (требуется дополнительное разрешение у ключа API);

Список служебных полей:
  • items.context — динамическая информация;
  • items.dates.deleted_at — дата удаления организации из базы в формате ISO 8601;
  • items.dates.updated_at — дата последнего изменения информации об организации в формате ISO 8601;
  • items.dates — время внесения информации о компании в БД;
  • items.geometry.style — идентификатор стиля для отображения;
  • items.group — связанные в объединённую карточку объекты;
  • items.metarubrics — метарубрики для выдачи организаций в гибридном объекте;
  • items.is_main_in_group — признак того, что это главный объект в группе объектов гибрида;
  • items.city_alias — алиас города, в котором находится объект;
  • items.detailed_subtype — детализированный тип административно-территориальной единицы;
  • items.alias — транслитерированное название объекта;
  • items.caption — название объекта;
  • items.routes — маршруты транспорта, проходящие через станцию или остановку;
  • items.directions — направления маршрута;
  • items.barrier — тип заграждения;
  • items.is_routing_available — флаг, возможен ли проезд до объекта;
  • items.entrance_display_name — показать номер входа на станцию метро, если объект является входом (station_entrance);
  • items.locale — текущая локаль для региона;
  • items.region_id — уникальный идентификатор проекта;
  • items.segment_id — уникальный идентификатор сегмента;
  • items.stop_factors — набор блокирующих атрибутов, соответствующих запросу;
  • items.timezone — часовой пояс в формате POSIX;
  • items.timezone_offset — смещение таймзоны в минутах относительно UTC0;
  • items.comment — комментарий ко входу;
  • items.station_id — уникальный идентификатор остановки, к которой относится остановочная платформа;
  • items.platforms — остановочные платформы остановки;
  • items.sources — идентификатор источника данных об объекте;
  • items.structure_info.material — данные о материале здания (требуется дополнительное разрешение у ключа API);
  • items.structure_info.apartments_count — данные о количестве квартир (требуется дополнительное разрешение у ключа API);
  • items.structure_info.porch_count — данные о количестве подъездов (требуется дополнительное разрешение у ключа API);
  • items.structure_info.floor_type — тип перекрытий в здании (требуется дополнительное разрешение у ключа API);
  • items.structure_info.gas_type — тип газоснабжения здания (требуется дополнительное разрешение у ключа API);
  • items.structure_info.year_of_construction — год постройки здания (требуется дополнительное разрешение у ключа API);
  • items.structure_info.elevators_count — количество лифтов в здании (требуется дополнительное разрешение у ключа API);
  • items.structure_info.is_in_emergency_state — факт признания дома аварийным (требуется дополнительное разрешение у ключа API);
  • items.structure_info.project_type — серия/проект постройки здания (требуется дополнительное разрешение у ключа API);
  • items.structure_info.chs_name — название ОКН (объекта культурного наследия) (требуется дополнительное разрешение у ключа API);
  • items.structure_info.chs_category — категория ОКН (требуется дополнительное разрешение у ключа API);
  • items.route_logo — иконка метро;
  • items.is_deleted — признак удаленного объекта;
  • items.search_attributes — параметры результата поиска для найденного объекта. Каждое поле внутри items.search_attributes нужно запрашивать отдельно через точку, например, items.search_attributes.segment_id. Список доступных полей внутри объекта items.search_attributes можно посмотреть в схеме ответа для любого объекта внутри items;
  • items.congestion — загруженность филиала;
  • items.poi_category — категория POI;
  • items.links — связанные объекты (ближайшие парковки, остановки общественного транспорта и другое);
  • items.links.database_entrances — информация о точках входа (требуется дополнительное разрешение у ключа API);
  • items.links.database_entrances.apartments_info — информация о квартирах в доме (требуется дополнительное разрешение у ключа API);
  • items.purpose_code — код назначения здания;
  • items.ads.options — рекламные опции;
  • search_attributes — информация о произведённом поиске;
  • items.name_back — для дорожного знака локализованное название в обратном направлении при наличии;
  • items.value_back — для дорожного знака номер километра в обратном направлении;
  • items.marker_alt — относительная высота размещения маркера;
  • items.search_query — поисковая строка, которая подставляется в строку поиска для формирования выдачи (это поле есть только у объектов с типом metarubric);
  • items.has_ads_model — признак наличия рекламной 3D модели в здании;

type
Array of strings
Examples:
  • type=org,discount - Пример нескольких типов
  • type=org - Пример единичного типа

Типы объектов, среди которых производится поиск. При передаче нескольких типов менее релевантные результаты одних типов могут вытесниться более релевантными других типов. Типы перечисляются через запятую.
Список доступных типов:

  • branch — компания;
  • building — здание;
  • street — улица;
  • station — остановка или станция общественного транспорта;
  • station.metro — станция метро;
  • station_entrance — вход на станцию;
  • user_queries — пользовательский саггест;
  • adm_div.district — район;
  • adm_div.district_area — район области;
  • adm_div.settlement — населённый пункт (деревня, посёлок и т.п.);
  • adm_div.city — город;
  • adm_div.country — страна;
  • adm_div.region — регион (область/край/республика и т.п.);
  • adm_div.place — разные площадные объекты: парки, пляжи, территории баз отдыха, озёра и прочие места;
  • adm_div.living_area — жилмассив, микрорайон;
  • adm_div.division — округ;
  • adm_div.amana — амана;
  • attraction — достопримечательность;
  • crossroad — перекрёсток;
  • rubric — категория;
  • meta_rubric — метакатегория;
  • attribute — дополнительный атрибут;
  • route — маршрут;
  • route_type — тип маршрута;
  • road — дорога;
  • parking — парковка;
  • org — организация;
  • coordinates — глобальная координата в системе координат WGS84 в формате lon, lat;
  • coordinates_additional — дополнительная глобальная координата в системе координат WGS84 в формате lon, lat;
  • special — специальный;
  • market.category — категории товаров. Требует наличия market.suggestor_category;
  • market.suggestor_category — необходим для раскрытия категорий товаров;
  • market.attribute — наименования товаров;
  • market.brand — бренд товаров;
  • kilometer_road_sign — знак километра;
  • road.touristic — туристические маршруты.

Список доступных подтипов (subtype) для разных типов объектов можно посмотреть в схеме ответа внутри items.

suggest_type
string
Default: "object"
Example: suggest_type=route_endpoint

Используемый тип подбора подсказки. Доступные типы:

  • route_endpoint — идеально подходит для быстрого поиска конечных объектов маршрута. Все результаты имеют id и координаты;
  • address — подсказка адресов;
  • object — подсказка по объектам справочника (категории, фирмы, улицы, города и т.д.);
  • rubric — подсказка категорий;
  • places — подсказка мест;
  • global_address — алиас address. Устаревший тип, вместо него нужно использовать address;
  • city_selector — подсказка населённых пунктов. Может использоваться без указания проекта.

region_id
integer

Идентификатор региона. Обязателен, если не задано географическое ограничение поиска. Подробности про территориальное деление карты на регионы можно посмотреть в описании Regions API.

location
string
Examples:
  • location=82.921663,55.030195 - Долгота и широта

Местоположение пользователя (координаты в формате lon, lat).

viewpoint1
string
Examples:
  • viewpoint1=82.921663,55.030195 - Долгота и широта

Координаты левой верхней вершины прямоугольной области видимости в формате lon, lat. Параметры viewpoint1 и viewpoint2 передают область карты, куда смотрел пользователь перед вводом запроса. Используется как один из критериев для выбора, где нужны результаты, и для ранжирования. Не ограничивает жёстко результаты поиска только переданной областью.

viewpoint2
string
Examples:
  • viewpoint2=82.921663,55.030195 - Долгота и широта

Координаты правой нижней вершины прямоугольной области видимости в формате lon, lat. Параметры viewpoint1 и viewpoint2 передают область карты, куда смотрел пользователь перед вводом запроса. Используется как один из критериев для выбора, где нужны результаты, и для ранжирования. Не ограничивает жёстко результаты поиска только переданной областью.

page_size
integer [ 1 .. 100 ]
Default: 10

Количество результатов поиска, выводимых на одной странице.

search_is_query_text_complete
boolean

Указание поисковому движку, что запрос является законченным (пользователь нажал на кнопку завершения ввода). Отключает префиксность, т.е. по "банк" не будет находиться "банкомат".

search_nearby
boolean

Указание поисковому движку использовать режима поиска рядом с пользователем. Сильно повышает значимость расстояния от пользователя. В ранжирование всё ещё участвует популярность, реклама и другие параметры, но в меньшей степени.

search_input_method
string

Указание поисковому движку способа ввода текста запроса:

  • hardware_qwerty_keyboard — физическая QWERTY-клавиатура
  • on_screen_keyboard — экранная touch screen клавиатура
  • voice — голосовой ввод
  • hand_writing — рукописный ввод
  • scanning — ввод который используется людьми с ограниченными возможностями. C помощью пальца или глазными движениями
  • software_generated — текст сгенерирован программным обеспечением
  • other — прочие типы ввода

Responses

Response Schema: application/json
required
object

Основной результат

required
object (ObjMeta)

Метаданные ответа

Response samples

Content type
application/json
{
  • "result": {
    • "search_attributes": {
      },
    • "total": 1,
    • "items": [
      ]
    },
  • "meta": {
    • "code": 200,
    • "api_version": "dev",
    • "issue_date": "string"
    }
}

Получение коллекции предложенных объектов

Возвращает коллекцию объектов, подходящих к пользовательскому вводу.

query Parameters
key
required
string

Уникальный ключ пользователя API.

locale
string
Examples:
  • locale=ar_AE - Арабский язык для ОАЭ
  • locale=ru_RU - Русский язык для России

Локаль, с которой производится поиск и отдаются результаты.
Список доступных локалей:

  • az_AZ — азербайджанский (Азербайджан);
  • ru_AZ — русский (Азербайджан);
  • hy_AM — армянский (Армения);
  • ru_AM — русский (Армения);
  • ar_BH — арабский (Бахрейн);
  • en_BH — английский (Бахрейн);
  • ru_BY — русский (Беларусь);
  • ka_GE — грузинский (Грузия);
  • ru_GE — русский (Грузия);
  • en_EG — английский (Египет);
  • ar_EG — арабский (Египет);
  • it_IT — итальянский (Италия);
  • en_IQ — английский (Ирак);
  • ar_IQ — арабский (Ирак);
  • kk_KZ — казахский (Казахстан);
  • ru_KZ — русский (Казахстан);
  • en_QA — английский (Катар);
  • ar_QA — арабский (Катар);
  • en_CY — английский (Кипр);
  • es_CL — испанский (Кипр);
  • ky_KG — кыргызский (Кыргызстан);
  • ru_KG — русский (Кыргызстан);
  • en_CN — английский (Китай);
  • zh_CN — китайский (Китай);
  • ru_CN — русский (Китай);
  • en_KW — английский (Кувейт);
  • ar_KW — арабский (Кувейт);
  • en_MA — английский (Марокко);
  • ar_MA — арабский (Марокко);
  • en_AE — английский (ОАЭ);
  • ar_AE — арабский (ОАЭ);
  • en_OM — английский (Оман);
  • ar_OM — арабский (Оман);
  • en_RU — английский (Россия);
  • ar_RU — арабский (Россия);
  • es_RU — испанский (Россия);
  • it_RU — итальянский (Россия);
  • ru_RU — русский (Россия);
  • uk_RU — украинский (Россия);
  • cs_RU — чешский (Россия);
  • en_SA — английский (Саудовская Аравия);
  • ar_SA — арабский (Саудовская Аравия);
  • ru_TJ — русский (Таджикистан);
  • tg_TJ — таджикский (Таджикистан);
  • ru_UZ — русский (Узбекистан);
  • uz_UZ — узбекский (Узбекистан);
  • ru_UA — русский (Украина);
  • uk_UA — украинский (Украина);
  • cs_CZ — чешский (Чехия).

q
required
string [ 1 .. 500 ] characters

Произвольная поисковая строка.

fields
Array of strings
Examples:
  • fields=items.region_id,items.name_ex - Пример нескольких типов
  • fields=items.region_id - Пример единичного типа

Дополнительные поля, которые необходимо отобразить в ответе, перечисляются через запятую. Поля с пометкой требуется дополнительное разрешение у ключа API будут присутствовать в выдаче только при выставленных разрешениях на это поле у ключа. По умолчанию ключ не имеет никакие из указанных дополнительных разрешений.
Список полей с информацией о геометрии и адресе места:

  • items.point — координаты объекта, заданные в системе координат WGS84 в формате lon, lat;
  • items.address — адрес, по которому располагается объект;
  • items.adm_div — принадлежность к административной территории;
  • items.full_address_name — адрес объекта с указанием города;
  • items.geometry.centroid — визуальный центр геометрии объекта;
  • items.geometry.hover — геометрия области, используемой для определения попадания курсора в зону объекта;
  • items.geometry.selection — геометрия для выделения объекта;

Список полей с дополнительной информацией о месте:
  • items.rubrics — категории компании;
  • items.org — организация, к которой относится филиал;
  • items.schedule — расписание работы компании;
  • items.schedule_special — особое расписание работы компании;
  • items.access_comment — локализованное название для типа доступа;
  • items.access — тип доступа для парковки;
  • items.capacity — вместимость парковки;
  • items.description — описание геообъекта;
  • items.flags — список признаков объекта. Например, что для объекта есть фотографии, или что филиал временно не работает и т.д. Список доступных признаков можно посмотреть в схеме ответа внутри items;
  • items.floors — количество этажей (требуется дополнительное разрешение у ключа API);
  • items.floor_plans — планы этажей (требуется дополнительное разрешение у ключа API);
  • items.is_paid — является ли парковка платной;
  • items.for_trucks — парковка для грузовиков;
  • items.paving_type — тип покрытия парковки;
  • items.is_incentive — является ли парковка перехватывающей;
  • items.purpose — назначение парковки;
  • items.level_count — количество уровней парковки;
  • items.name_ex — составные части наименования объекта;
  • items.reviews — статистика по отзывам об объекте;
  • items.employees_org_count — численность сотрудников организации (требуется дополнительное разрешение у ключа API);
  • items.itin — индивидуальный номер налогоплательщика (требуется дополнительное разрешение у ключа API);
  • items.trade_license — лицензия филиала (требуется дополнительное разрешение у ключа API);
  • items.fias_code — код ФИАС улиц и административных территорий (требуется дополнительное разрешение у ключа API);
  • items.address.components.fias_code — код ФИАС зданий (требуется дополнительное разрешение у ключа API);
  • items.fns_code — код ФНС административных территорий (требуется дополнительное разрешение у ключа API);
  • items.okato — код ОКАТО улиц и административных территорий (требуется дополнительное разрешение у ключа API);
  • items.address.components.okato — код ОКАТО зданий (требуется дополнительное разрешение у ключа API);
  • items.oktmo — код ОКТМО улиц и административных территорий (требуется дополнительное разрешение у ключа API);
  • items.address.components.oktmo — код ОКТМО зданий (требуется дополнительное разрешение у ключа API);

Список служебных полей:
  • items.context — динамическая информация;
  • items.dates.deleted_at — дата удаления организации из базы в формате ISO 8601;
  • items.dates.updated_at — дата последнего изменения информации об организации в формате ISO 8601;
  • items.dates — время внесения информации о компании в БД;
  • items.geometry.style — идентификатор стиля для отображения;
  • items.group — связанные в объединённую карточку объекты;
  • items.metarubrics — метарубрики для выдачи организаций в гибридном объекте;
  • items.is_main_in_group — признак того, что это главный объект в группе объектов гибрида;
  • items.city_alias — алиас города, в котором находится объект;
  • items.detailed_subtype — детализированный тип административно-территориальной единицы;
  • items.alias — транслитерированное название объекта;
  • items.caption — название объекта;
  • items.routes — маршруты транспорта, проходящие через станцию или остановку;
  • items.directions — направления маршрута;
  • items.barrier — тип заграждения;
  • items.is_routing_available — флаг, возможен ли проезд до объекта;
  • items.entrance_display_name — показать номер входа на станцию метро, если объект является входом (station_entrance);
  • items.locale — текущая локаль для региона;
  • items.region_id — уникальный идентификатор проекта;
  • items.segment_id — уникальный идентификатор сегмента;
  • items.stop_factors — набор блокирующих атрибутов, соответствующих запросу;
  • items.timezone — часовой пояс в формате POSIX;
  • items.timezone_offset — смещение таймзоны в минутах относительно UTC0;
  • items.comment — комментарий ко входу;
  • items.station_id — уникальный идентификатор остановки, к которой относится остановочная платформа;
  • items.platforms — остановочные платформы остановки;
  • items.sources — идентификатор источника данных об объекте;
  • items.structure_info.material — данные о материале здания (требуется дополнительное разрешение у ключа API);
  • items.structure_info.apartments_count — данные о количестве квартир (требуется дополнительное разрешение у ключа API);
  • items.structure_info.porch_count — данные о количестве подъездов (требуется дополнительное разрешение у ключа API);
  • items.structure_info.floor_type — тип перекрытий в здании (требуется дополнительное разрешение у ключа API);
  • items.structure_info.gas_type — тип газоснабжения здания (требуется дополнительное разрешение у ключа API);
  • items.structure_info.year_of_construction — год постройки здания (требуется дополнительное разрешение у ключа API);
  • items.structure_info.elevators_count — количество лифтов в здании (требуется дополнительное разрешение у ключа API);
  • items.structure_info.is_in_emergency_state — факт признания дома аварийным (требуется дополнительное разрешение у ключа API);
  • items.structure_info.project_type — серия/проект постройки здания (требуется дополнительное разрешение у ключа API);
  • items.structure_info.chs_name — название ОКН (объекта культурного наследия) (требуется дополнительное разрешение у ключа API);
  • items.structure_info.chs_category — категория ОКН (требуется дополнительное разрешение у ключа API);
  • items.route_logo — иконка метро;
  • items.is_deleted — признак удаленного объекта;
  • items.search_attributes — параметры результата поиска для найденного объекта. Каждое поле внутри items.search_attributes нужно запрашивать отдельно через точку, например, items.search_attributes.segment_id. Список доступных полей внутри объекта items.search_attributes можно посмотреть в схеме ответа для любого объекта внутри items;
  • items.congestion — загруженность филиала;
  • items.poi_category — категория POI;
  • items.links — связанные объекты (ближайшие парковки, остановки общественного транспорта и другое);
  • items.links.database_entrances — информация о точках входа (требуется дополнительное разрешение у ключа API);
  • items.links.database_entrances.apartments_info — информация о квартирах в доме (требуется дополнительное разрешение у ключа API);
  • items.purpose_code — код назначения здания;
  • items.ads.options — рекламные опции;
  • search_attributes — информация о произведённом поиске;
  • items.name_back — для дорожного знака локализованное название в обратном направлении при наличии;
  • items.value_back — для дорожного знака номер километра в обратном направлении;
  • items.marker_alt — относительная высота размещения маркера;
  • items.search_query — поисковая строка, которая подставляется в строку поиска для формирования выдачи (это поле есть только у объектов с типом metarubric);
  • items.has_ads_model — признак наличия рекламной 3D модели в здании;

type
Array of strings
Examples:
  • type=org,discount - Пример нескольких типов
  • type=org - Пример единичного типа

Типы объектов, среди которых производится поиск. При передаче нескольких типов менее релевантные результаты одних типов могут вытесниться более релевантными других типов. Типы перечисляются через запятую.
Список доступных типов:

  • branch — компания;
  • building — здание;
  • street — улица;
  • station — остановка или станция общественного транспорта;
  • station.metro — станция метро;
  • station_entrance — вход на станцию;
  • user_queries — пользовательский саггест;
  • adm_div.district — район;
  • adm_div.district_area — район области;
  • adm_div.settlement — населённый пункт (деревня, посёлок и т.п.);
  • adm_div.city — город;
  • adm_div.country — страна;
  • adm_div.region — регион (область/край/республика и т.п.);
  • adm_div.place — разные площадные объекты: парки, пляжи, территории баз отдыха, озёра и прочие места;
  • adm_div.living_area — жилмассив, микрорайон;
  • adm_div.division — округ;
  • adm_div.amana — амана;
  • attraction — достопримечательность;
  • crossroad — перекрёсток;
  • rubric — категория;
  • meta_rubric — метакатегория;
  • attribute — дополнительный атрибут;
  • route — маршрут;
  • route_type — тип маршрута;
  • road — дорога;
  • parking — парковка;
  • org — организация;
  • coordinates — глобальная координата в системе координат WGS84 в формате lon, lat;
  • coordinates_additional — дополнительная глобальная координата в системе координат WGS84 в формате lon, lat;
  • special — специальный;
  • market.category — категории товаров. Требует наличия market.suggestor_category;
  • market.suggestor_category — необходим для раскрытия категорий товаров;
  • market.attribute — наименования товаров;
  • market.brand — бренд товаров;
  • kilometer_road_sign — знак километра;
  • road.touristic — туристические маршруты.

Список доступных подтипов (subtype) для разных типов объектов можно посмотреть в схеме ответа внутри items.

suggest_type
string
Default: "object"
Example: suggest_type=route_endpoint

Используемый тип подбора подсказки. Доступные типы:

  • route_endpoint — идеально подходит для быстрого поиска конечных объектов маршрута. Все результаты имеют id и координаты;
  • address — подсказка адресов;
  • object — подсказка по объектам справочника (категории, фирмы, улицы, города и т.д.);
  • rubric — подсказка категорий;
  • places — подсказка мест;
  • global_address — алиас address. Устаревший тип, вместо него нужно использовать address;
  • city_selector — подсказка населённых пунктов. Может использоваться без указания проекта.

region_id
integer

Идентификатор региона. Обязателен, если не задано географическое ограничение поиска. Подробности про территориальное деление карты на регионы можно посмотреть в описании Regions API.

location
string
Examples:
  • location=82.921663,55.030195 - Долгота и широта

Местоположение пользователя (координаты в формате lon, lat).

viewpoint1
string
Examples:
  • viewpoint1=82.921663,55.030195 - Долгота и широта

Координаты левой верхней вершины прямоугольной области видимости в формате lon, lat. Параметры viewpoint1 и viewpoint2 передают область карты, куда смотрел пользователь перед вводом запроса. Используется как один из критериев для выбора, где нужны результаты, и для ранжирования. Не ограничивает жёстко результаты поиска только переданной областью.

viewpoint2
string
Examples:
  • viewpoint2=82.921663,55.030195 - Долгота и широта

Координаты правой нижней вершины прямоугольной области видимости в формате lon, lat. Параметры viewpoint1 и viewpoint2 передают область карты, куда смотрел пользователь перед вводом запроса. Используется как один из критериев для выбора, где нужны результаты, и для ранжирования. Не ограничивает жёстко результаты поиска только переданной областью.

page_size
integer [ 1 .. 100 ]
Default: 10

Количество результатов поиска, выводимых на одной странице.

Request Body schema: application/json

Запрос в формате json.

Array of objects

Персональные для пользователя записи с информацией о весе и т.п.

Array
type
string
Enum: "home" "work" "favorites" "history" "personal_poi" "supposed_home" "supposed_work" "supposed_other"

Тип персонального объекта.

count
integer

Количество обращений к объекту за период.

last_used
number <int64>

Время последнего использования Unix timestamp в секундах.

probability
number [ 0 .. 1 ]

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

object

Полная идентификация записи = тип + идентификатор.

object

Точка координат результата. Если собственной точки у объекта нет - отдаётся центр сегмента в котором находится объект.

Responses

Response Schema: application/json
required
object

Основной результат

required
object (ObjMeta)

Метаданные ответа

Request samples

Content type
application/json
{
  • "personal_records": [
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    • "search_attributes": {
      },
    • "total": 1,
    • "items": [
      ]
    },
  • "meta": {
    • "code": 200,
    • "api_version": "dev",
    • "issue_date": "string"
    }
}