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

Автодополнение (неактуальное API)

API docs by Redocly

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

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

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

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

Поддержка метода прекращена. Для получения списка подсказок воспользуйтесь методом /3.0/suggests.

query Parameters
q
required
string [ 1 .. 500 ] characters

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

key
required
string

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

region_id
required
integer

id региона.

types
Array of strings

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

  • adm_div.district — район;
  • adm_div.settlement — населённый пункт (деревня, посёлок и т.п.);
  • adm_div.city — город;
  • adm_div.place — разные площадные объекты: парки, пляжи, территории баз отдыха, озёра и прочие места;
  • adm_div.living_area — жилмассив, микрорайон;
  • adm_div.division — округ;
  • adm_div.district_area — район области;
  • adm_div.amana — амана;
  • adm_div.region — регион (область/край/республика и т.п.);
  • building — здание;
  • station — остановка или станция общественного транспорта;
  • street — улица;
  • attraction — достопримечательность;
  • crossroad — перекрёсток;
  • station.metro — станция метро;
  • branch — филиал организации;
  • general_rubric — объединяющая категория;
  • rubric — категория;
  • attribute — дополнительный атрибут;
  • rubric_attribute — атрибут категории;
  • route.bus — маршрут автобуса;
  • route.trolleybus — маршрут троллейбуса;
  • route.tram — маршрут трамвая;
  • route.shuttle_bus — маршрут маршрутноого такси;
  • route.metro — маршрут метро;
  • route.suburban_train — маршрут электропоезда;
  • route.funicular_railway — маршрут фуникулёра;
  • route.monorail — маршрут монорельса;
  • route.river_transport — маршрут водного транспорта;
  • route.cable_car — маршрут канатной дороги;
  • route.light_rail — маршрут скоростного трамвая;
  • route.premetro — маршрут метротрама;
  • route.light_metro — маршрут лёгкого метро;
  • kilometer_road_sign — знак километра.

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

type
string
Default: "default"

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

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

viewpoint1
string
Example: viewpoint1=82.921663,55.030195

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

viewpoint2
string
Example: viewpoint2=82.921663,55.030195

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

page_size
integer [ 1 .. 100 ]
Default: 10

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

Responses

Response Schema:
required
object (ObjMeta)

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

required
object

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

Response samples

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