2GIS

Поиск фирм

Осуществляет поиск фирм по заданному запросу и выдает список найденных результатов разбитых на страницы.

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

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

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

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

Пример: 1234567890.

version Да Строка Указывает версию API, с которой идет работа. Возможные значения: 1.3
what Да. Не менее 2-х символов Строка

Поисковый запрос из поля «Что?». Указывается название фирмы или область деятельности фирмы.

Кодировка UTF8.

Примеры:

  • пиво
  • сто
  • кафе аленка
  • установка окон
where Да, если не задан point или bound. Не менее 2-х символов Строка

Поисковый запрос из поля «Где». Поле обязательно должно содержать название населенного пункта (Новосибирск, Омск), название населенного пункта + район (Новосибирск Центральный) или название населенного пункта + улица (Новосибирск Советская). Если не указать название населенного пункта, то поиск выполнен не будет.

Кодировка UTF8.

В случае, когда невозможно однозначно определить локацию по текстовому значению поля «Где?», поиск осуществлен не будет.

Примеры:

  • Новосибирск
  • Новосибирск, Ленина
  • Омск Ленина 5
bound Да, если не задан where или point. Массив

Рамка, ограничивающая область поиска.
bound[point1] — координаты верхней левой точки,
bound[point2] — координаты нижней правой точки, в формате lon,lat, в системе координат WGS84.

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

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

point Да, если не задан where или bound lon,lat

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

При указании point значение поля where игнорируется.

Пример: 82.901886, 54.991984

radius Нет Число

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

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

Пример: 1000

filters Нет Массив

Дополнительные параметры выборки:

worktime — фильтр по времени работы.

Формат:

<day>,<time>, где day — день недели (mon, tue, wed, thu, fri, sat, sun),

time — время в формате HH:mm или alltime, что означает круглосуточно.

Примеры:

  • filters[worktime]=mon,17:00
  • filters[worktime]=fri,alltime
sort Нет Строка

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

relevance (по умолчанию) — наилучшее соответствие запросу. В поиске участвует название фирмы и рубрики в которые фирма входит;

rating — по популярности;

name — по алфавиту;

distance — по расстоянию от центра геообъекта или от точки, если задан параметр point.

page Нет Число Номер запрашиваемой страницы. Значение по умолчанию: 1.
pagesize Нет Число Количество результатов поиска, выводимых на одной странице. Значение по умолчанию: 20. Ограничение: от 5 до 50.
output Нет Строка Формат ответа. Может принимать значения xml, json, jsonp. По умолчанию используется json.
callback Нет Строка

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

Пример: myCallback_1

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

Параметр Тип Описание
api_version Строка Версия API, с которой идет работа. Возможные значения: 1.3
response_code Строка Код ответа API. Подробнее см. Коды ответов.
В случае успешного ответа
what Строка Поисковый запрос (поле «Что?»).
where Строка Место, по которому производился поиск.
total Число Количество филиалов, найденных по запросу.
did_you_mean Объект См. Параметры did you mean.
advertising Массив Список рекламных объявлений. Присутствует в выдаче, только если по запросу имеется реклама. Содержит не более двух объявлений. См. Рекламное объявление.
result Массив См. Параметры филиала
В случае ошибки
error_code Строка Код ошибки, см. Коды ошибок.
error_message Строка

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

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

Параметры did you mean
Параметр Тип Описание
rubrics Массив Did you mean для рубрик. Массив объектов с ключами name и keyword.
geo Массив Did you mean для геообъектов. Массив объектов с ключами name и keyword.
Рекламное объявление
Параметр Тип Описание
firm_id Строка Уникальный идентификатор филиала. Пример: 141265769336625.
hash Строка Уникальный хэш, требуется для передачи в запрос на получение профиля филиала.
title Строка

Заголовок рекламного объявления.

Примеры:

  • Офтальмологическая клиника
  • Решение жилищных вопросов
text Строка

Текст рекламного объявления.

Примеры:

  • Диагностика, лазерная коррекция зрения, лечение глазных заболеваний.
  • Квартиры, дома, земля. Экономная ипотека. Аренда жилья.
fas_warning Строка

Предупреждение ФАС.

Примеры:

  • Имеются противопоказания, необходимо проконсультироваться со специалистом.
  • Генеральная лицензия Банка России № 2306.
lon Строка Долгота расположения рекламируемого филиала. Система координат WGS84. Отсутствует в выдаче, если у филиала нет адреса. Пример: 82.9117574728652
lat Строка Широта расположения рекламируемого филиала. Система координат WGS84. Отсутствует в выдаче, если у филиала нет адреса. Пример: 55.0346747796494
type Строка Тип рекламного объевления. Рекламные объявления в поисковой выдаче могут иметь тип recovery
Параметры филиала
Параметр Тип Описание
id Строка Уникальный идентификатор филиала. Пример: 141265769336625.
lon Строка Долгота координаты места расположения филиала. Система координат WGS84. Отсутствует в выдаче, если у филиала нет адреса. Пример: 82.9117574728652
lat Строка Широта координаты места расположения филиала. Система координат WGS84. Отсутствует в выдаче, если у филиала нет адреса. Пример: 55.0346747796494
name Строка Название филиала. Пример: Сибакадемстрой Недвижимость, агентство недвижимости.
firm_group Объект Информация о фирме, к которой относится филиал. Объект с ключами id — уникальный идентификатор фирмы и count — количество филиалов фирмы.
dist Число Расстояние в метрах от центра поиска до филиала. Присутствует в выдаче только если выбрана сортировка по расстоянию.
hash Строка Уникальный хэш, требуется для передачи в запрос на получение профиля филиала.
city_name Строка Город, к которому относится филиал.
address Строка

Адрес, по которому располагается филиал. Может отсутствовать в выдаче, например, для интернет-магазинов.

Пример: Димитрова проспект, 7 - 2 этаж.

rubrics Массив

Список рубрик, к которым относится филиал. Массив строк. Может отсутствовать в выдаче.

Пример: ["Пряжа","Товары для творчества и рукоделия","Швейная фурнитура"].

reviews_count Число Количество отзывов на flamp.ru. Параметр присутствует в выдаче, только если есть хотя бы один отзыв.
micro_comment Строка Микрокомментарий (70 символов), присутствует в выдаче только для рекламных фирм. Позволяет акцентировать внимание пользователя сервиса на определенной организации в общем списке, размещается под ее названием. Пример: Деревянные окна и оконные блоки под ключ.
fas_warning Строка Предупреждение ФАС, присутствует в выдаче только для рекламных фирм. Пример: Имеются противопоказания, необходимо проконсультироваться со специалистом.

Примеры

  • Найти музеи в Москве.

    Запрос: http://catalog.api.2gis.ru/search?what=музей&where=Москва&version=1.3&key=1234567890

    Ответ:

  • Найти кафе в радиусе 500 м от точки с долготой 37.620383 и широтой 55.754042, выдачу упорядочить по расстоянию от точки.

    Запрос: http://catalog.api.2gis.ru/search?what=кафе&point=37.620383,55.754042&radius=500&sort=distance&version=1.3&key=1234567890

    Ответ:

  • Найти кафе в прямоугольнике с левой верхней точкой с долготой 7.621, широтой 55.771 и правой нижней точкой с долготой 37.622, широтой 55.769.

    Запрос: http://catalog.api.2gis.ru/search?what=кафе&bound[point1]=37.621,55.771&bound[point2]=37.622,55.769&version=1.3&key=1234567890

    Ответ:

  • Найти аптеки на Тверской, открытые в 3 часа ночи с воскресенья на понедельник.

    Запрос: http://catalog.api.2gis.ru/search?what=аптека&where=Москва,Тверская&filters[worktime]=mon,03:00&version=1.3&key=1234567890

    Ответ:

  • Больше примеров хороших и разных можно найти в демо-версии.