2GIS

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

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

URL: http://catalog.api.2gis.ru/geo/search

Параметры запроса

Параметр Обязательное Тип Описание
key Да Строка

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

Пример: 1234567890.

version Да Строка

Указывает версию API, с которой идет работа.

Возможные значения: 1.3.

q Да Строка

Запрос, по которому производится выборка геообъектов.

Для поиска по названию — строка, содержащая любые символы.

Для поиска по координатам — координаты точки поиска, заданные в системе координат WGS84, в формате lon,lat.

Примеры:

  • Новосибирск Ленина
  • 82.901886,54.991984
radius Нет Число

Радиус поиска (в метрах). Работает только при поиске по координатам.

Ограничение: от 0 до 250. Значение по умолчанию: 0.

Пример: 200

project Нет Число

Идентификатор проекта по которому необходимо производить поиск.

Пример: 32

bound Нет Массив

Рамка, ограничивающая область поиска.

Координаты задаются в формате lon,lat, в системе координат WGS84.

bound[point1] — координаты верхней левой точки,

bound[point2] — координаты нижней правой точки.

Координаты округляются до 6 знаков после запятой. Центр должен попадать в геометрию какого-либо проекта, иначе — ошибка incorrectGeography.

При одновременном указании radius, project и bound будет производиться поиск по bound.

Пример: bound[point1]=37.432,55.836&bound[point2]=37.633,55.637

types Нет Строка

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

Возможные типы геообъектов:

project — проект;

district — район;

house — дом;

city — город;

settlement — населенный пункт (меньше города);

station — остановка (включает в себя несколько остановочных платформ);

station_platform — остановочная платформа;

street — улица;

living_area — микрорайон или жилмассив;

place — место;

sight — достопримечательность (памятник, фонтан и т.д.);

crossroad — перекресток;

metro — станция метро.

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

Примеры:

  • street
  • city,settlement,living_area
format Нет Строка

Формат ответа. Допустимые значения:

  • full (используется по умолчанию) — полный;
  • short — сокращенный (без поля selection).
limit Нет Число

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

Возможные значения: от 1 до 2000.

Значение по умолчанию: 1.

output Нет Строка Формат ответа. Может принимать значения xml, json, jsonp. По умолчанию используется json.
callback Нет Строка

Название callback функции для jsonp-запроса. Ограничение: последовательность латинских букв, цифр и знака подчеркивания. Максимальная длина названия callback функции — 128 символов. В случае неправильного задания используется значение по умолчанию (dgCallback).

Пример: myCallback_1

Параметры ответа

Параметр Тип Описание
api_version Строка Версия API, с которой идет работа. Возможные значения: 1.3.
response_code Строка Код ответа API. Подробнее см. Коды ответов.
В случае успешного ответа
total Число Количество результатов.
result Массив Массив объектов с результатами поиска, см. Описание геообъекта.
В случае ошибки
error_code Строка Код ошибки, см. Коды ошибок.
error_message Строка

Описание ошибки.

Пример: API version must be set. Supported versions are: 1.3

Описание геообъекта
Параметр Тип Описание
id Строка

Идентификатор геообъекта.

Пример: 5348660212804786

project_id Строка

Идентификатор проекта, к которому относится геообъект.

Пример: 32

type Строка

Тип геообъекта. Возможные значения:

project — проект;

district — район;

house — дом;

city — город;

settlement — населенный пункт (меньше города);

station — остановка (включает в себя несколько остановочных платформ);

station_platform — остановочная платформа;

street — улица;

living_area — микрорайон или жилмассив;

place — место;

sight — достопримечательность (памятник, фонтан и т.д.);

crossroad — перекресток;

metro — станция метро.

name Строка

Название геообъекта.

Примеры:

  • Москва, Храм Василия Блаженного
  • Москва, Новослободская, 4
  • Москва, Московский Кремль
short_name Строка

Краткое название геообъекта.

Примеры:

  • Храм Василия Блаженного
  • 4
  • «Московский Кремль
selection Строка

Геометрия объекта в формате WKT.

Примеры:

  • POLYGON((82.916999581655 55.0421363815388, 82.9175228440822 55.0401876099625, 82.9180633669606 55.0402351774059, 82.9175402952564 55.0421841282563,82.916999581655 55.0421363815388))
  • POINT(82.9168505229578 55.0468898289548)
centroid Строка

Центр геометрии объекта в формате WKT.

Примеры:

  • POINT(82.9045989950253 54.9980431677324)
  • POINT(82.9168505229578 55.0468898289548)
attributes Объект См. Дополнительные параметры геообъекта.
dist Строка Расстояние в метрах от центра поиска до найденного геообъекта. Присутствует в выдаче, только если выбран поиск по точке.

Дополнительные параметры геообъекта

Дополнительные параметры присутствуют только у геообъектов типов house, city, settlement, street, station, living_area, sight.

Геообъект Параметр Тип Описание
house, street, living_area city Строка

Город или населенный пункт, к которому относится геообъект.

Примеры:

  • Москва
  • Домодедово
house district Строка

Район города, к которому относится здание (или пустая строка, если такого отношения нет).

Примеры:

  • Таганский
  • Октябрьский
house street Строка

Улица, на которой расположено здание. Для населенных пунктов, в адресах которых улицы не предусмотрены, — пустая строка.

Примеры:

  • Набережная Обводного канала
  • Ростовский 4-й пер
house number Строка

Номер дома, по которому расположено здание на улице street или в населенном пункте вообще.

Примеры:

  • 1 ст2
  • Дом Ученых
house street2 Строка Для домов, у которых есть второй адрес, параметр отвечает за название улицы по второму адресу, в остальных случаях — пустая строка.
house number2 Строка Если street2 задано, параметр отвечает за номер дома, по которому расположено здание на улице street2, иначе — пустая строка.
house buildingname Строка

Для зданий, у которых есть название, — название здания. Иначе — пустая строка.

Примеры:

  • ХРАМ ВАСИЛИЯ БЛАЖЕННОГО
  • МЭРИЯ г. Новосибирска
house purpose Строка

Назначение здания.

Примеры:

  • Административное здание
  • Частный дом
house elevation Число Этажность здания. Пример: 10
house firmcount Число Количество организаций, расположенных в здании. Пример: 160
house index Строка Почтовый индекс здания. Пример: 630064
city, settlement abbreviation Строка

Аббревиатура типа населенного пункта.

Примеры:

  • г.
  • н.п.
city, settlement type Строка

Тип населенного пункта.

Примеры:

  • Город
  • Населённый пункт
station type Строка

Тип остановки. Возможные значения:

land — наземная остановка,

metro — станция метро,

railway — железнодорожная станция.

sight mapclass Строка

Вид достопримечательности.

Примеры:

  • Фонтан
  • Памятник
sight synonym Строка

Синонимы, под которыми также известна достопримечательность. Перечень названий, разделенных символами «;».

Примеры:

  • Фонтанный комплекс на Украинском бульваре
  • Памятник Суворову;Суворов;Памятник на Суворовской площади
sight info Строка

Дополнительная информация о достопримечательности.

Примеры:

  • Отлит из чугуна в Санкт-Петербурге. Открыт 27 июня 2008 г. Скульптор: А.И. Бортник.

Примеры

  • Найти геообъект с названием Москва.

    Запрос: http://catalog.api.2gis.ru/geo/search?q=Москва&version=1.3&key=1234567890

    Ответ:

  • Найти все геообъекты-музеи в прямоугольнике с левой верхней точкой с долготой 37.6, широтой 55.7 и правой нижней точкой с долготой 37.7, широтой 55.67. Результат выдать в коротком формате.

    Запрос: http://catalog.api.2gis.ru/geo/search?q=музей&bound[point1]=37.6,55.7&bound[point2]=37.7,55.67&format=short&limit=2000&version=1.3&key=1234567890

    Ответ:

  • Найти все геообъекты типов place и sight в радиусе 200 м от точки с долготой 37.620383 и широтой 55.754042. Результат выдать в коротком формате.

    Запрос: http://catalog.api.2gis.ru/geo/search?q=37.620383,55.754042&radius=200&types=place,sight&format=short&limit=2000&version=1.3&key=1234567890

    Ответ:

  • Примеры ответов для разных типов геообъектов см. на странице метода geo/get.
  • Больше примеров хороших и разных можно найти в демо-версии.