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

Геокодирование (неактуальное API)

API docs by Redocly

Справочник геообъектов (2.0)

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

Геокодинг

Поиск геообъектов

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

query Parameters
key
required
string

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

q
string [ 1 .. 400 ] characters

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

region_id
string

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

point
string
Example: point=82.921663,55.030195

Центр области поиска (координаты точки в формате lon, lat).
Используется для фильтрации результатов в окружности.

radius
integer [ 0 .. 40000 ]
Default: 0.1

Радиус поиска в метрах. Используется для фильтрации результатов в окружности.

point1
string
Example: point1=82.921663,55.030195

Координаты левой верхней вершины прямоугольной области в формате lon, lat, ограничивающей результаты выборки.
Используется для фильтрации результатов в прямоугольной области.
Допустимая разность координат point2 и point1 не более: для lon 0.06, для lat 0.04 (приблизительно 6.6 х 4.4 км).
Если передан параметр q — ограничения не накладываются.

point2
string
Example: point2=82.921663,55.030195

Координаты нижней правой вершины прямоугольной области в формате lon, lat, ограничивающей результаты выборки.
Используется для фильтрации результатов в прямоугольной области.
Допустимая разность координат point2 и point1 не более: для lon 0.06, для lat 0.04 (приблизительно 6.6 х 4.4 км).
Если передан параметр q — ограничения не накладываются.

viewpoint1
string
Example: viewpoint1=82.921663,55.030195

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

viewpoint2
string
Example: viewpoint2=82.921663,55.030195

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

polygon
string
Example: polygon=POLYGON((82.91259527206421 55.0614369017519,82.90572881698608 55.05902823221974,82.91521310806274 55.05580825372468))

Полигон в формате WKT.
Используется для фильтрации результатов в произвольной области.

type
Array of strings

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

  • adm_div — административная единица;
  • adm_div.city — город;
  • adm_div.district — район;
  • adm_div.division — округ;
  • adm_div.living_area — жилмассив, микрорайон;
  • adm_div.place — разные площадные объекты: парки, пляжи, территории баз отдыха, озёра и прочие места;
  • adm_div.settlement — населённый пункт (деревня, посёлок и т.п.);
  • adm_div.district_area — район области;
  • adm_div.amana — амана;
  • adm_div.region — регион (область/край/республика и т.п.);
  • attraction — достопримечательность;
  • building — здание;
  • crossroad — перекресток;
  • gate — проход/проезд;
  • parking — парковка;
  • poi — POI;
  • road — дорога;
  • street — улица;
  • kilometer_road_sign — знак километра.

page
integer
Default: 1

Номер запрашиваемой страницы.

page_size
integer [ 1 .. 50 ]
Default: 20

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

locale
string

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

sort
string

Сортировка результатов. Возможные значения:

  • relevance — по убыванию релевантности;
  • rating — по убыванию рейтинга.

zoom_level
integer

Текущий уровень масштабирования для геокодинга.

has_photos
boolean

Фильтр по наличию фотографий. Принимает значения: true или false.

fields
Array of strings

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

  • items.adm_div — административная единица;
  • items.address — адрес, по которому располагается филиал организации;
  • items.full_address_name — то же, что и address_name, но с указанием города;
  • items.floors — количество этажей;
  • items.attraction — описание достопримечательности;
  • items.statistics — cводная информация о геообъекте;
  • items.level_count — количество уровней парковки;
  • items.capacity — вместимость парковки;
  • items.description — описание геообъекта;
  • items.context — динамическая информация;
  • items.access_name — локализованное название типа доступа;
  • items.is_paid — является ли парковка платной;
  • items.for_trucks — парковка для грузовиков;
  • items.paving_type — тип покрытия парковки;
  • items.access — тип доступа для парковки;
  • items.access_comment — локализованное название для типа доступа;
  • items.schedule — расписание работы для гееобъекта (например, для парковки);
  • hash — базовый хеш;
  • items.stat — данные для формирования сообщений статистики;
  • search_attributes — информация о произведённом поиске;
  • items.geometry.selection — геометрия для выделения объекта;
  • items.geometry.hover — геометрия области, используемой для определения попадания курсора в зону объекта;
  • items.geometry.style — идентификатор стиля для отображения;
  • items.geometry.centroid — визуальный центр геометрии объекта;
  • items.region_id — уникальный идентификатор проекта;
  • items.links — связанные объекты (ближайшие парковки, остановки общественного транспорта и другое);
  • items.external_content — дополнительные данные филиала (требуется дополнительное разрешение у ключа API);
  • items.is_routing_available — флаг, возможен ли проезд до объекта;
  • items.group — связанные в объединённую карточку объекты;
  • items.reviews — статистика по отзывам о филиале;
  • items.is_main_in_group — признак того, что это главный объект в группе объектов гибрида;
  • items.city_alias — алиас города, в котором находится объект;
  • items.detailed_subtype — детализированный тип административно-территориальной единицы;
  • items.name_back — локализованное название в обратном направлении при наличии;
  • items.value_back — номер километра в обратном направлении;

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": [
      ]
    }
}