Примеры
Поиск компаний
Ограничение количества результатов поиска
Чтобы ограничить количество объектов в результатах поиска, используйте параметры:
page_size— количество объектов на странице;page— номер страницы.
https://catalog.api.2gis.com/3.0/items?q=Москва кафе&type=branch&page_size=10&page=1&key=YOUR_KEY
Поиск по текстовому параметру
https://catalog.api.2gis.com/3.0/items?q=Москва кафе&type=branch&key=YOUR_KEY
Для более точного поиска без геоограничения в тексте запроса следует указывать город (посёлок, район, область), где выполняется поиск.
Поиск в радиусе
https://catalog.api.2gis.com/3.0/items?q=кафе&type=branch&point=37.416469%2C55.619325&radius=1000&key=YOUR_KEY
Поиск в радиусе с сортировкой по удалённости
https://catalog.api.2gis.com/3.0/items?q=кафе&point=37.545423%2C55.740693&radius=1000&sort_point=37.545423%2C55.740693&sort=distance&key=YOUR_KEY
Поиск с указанием точки поиска
https://catalog.api.2gis.com/3.0/items?q=кафе&sort_point=37.545423%2C55.740693&key=YOUR_KEY
Первыми будут выведены наиболее близкие к точке объекты. Город в тексте запроса можно не указывать.
Поиск в прямоугольной области
https://catalog.api.2gis.com/3.0/items?q=кафе&fields=items.point&point1=37.602631%2C55.764592&point2=37.648702%2C55.743089&key=YOUR_KEY
Поиск в произвольной области
https://catalog.api.2gis.com/3.0/items?q=кафе&fields=items.point&polygon=POLYGON((37.5930 55.7667,37.6494 55.7667,37.6494 55.7405,37.5930 55.7405,37.5930 55.7667))&key=YOUR_KEY
Область поиска задается в формате WKT.
Поиск в определённом городе
Шаг 1. Определить city_id, в котором выполняется поиск. Взять значение из поля id (часть до знака «_»).
- Вариант 1. Поиск города по точке:
https://catalog.api.2gis.com/3.0/items?lon=37.62143&lat=55.752966&type=adm_div.city&key=YOUR_KEY
- Вариант 2. Поиск города по названию:
https://catalog.api.2gis.com/3.0/items?q=Москва&key=YOUR_KEY
Шаг 2. Значение из поля id (часть до знака «_») передаём в поле city_id при запросе.
https://catalog.api.2gis.com/3.0/items?q=кафе&fields=items.point&city_id=4504222397630173&key=YOUR_KEY
Поиск в определённом городе с сортировкой по рейтингу
https://catalog.api.2gis.com/3.0/items?q=красота&city_id=4504222397630173&sort=rating&key=YOUR_KEY
Поиск рядом со станцией метро
Вариант 1. Поиск с названием станции в запросе.
https://catalog.api.2gis.com/3.0/items?q=метро косино красота&city_id=4504222397630173&key=YOUR_KEY
Вариант 2. Поиск с фильтром по станции метро.
Шаг 1. Определить id метро. Взять значение из поля id (часть до знака «_»).
https://catalog.api.2gis.com/3.0/items?type=station.metro&q=косино&fields=items.point&sort_point=37.617135%2C55.757705&key=YOUR_KEY
Шаг 2. Значение из поля id передаётся в поле subway при запросе, город в названии можно не указывать:
https://catalog.api.2gis.com/3.0/items?q=красота&fields=items.point&subway=70030076180130124&sort_point=37.617135%2C55.757705&key=YOUR_KEY
Поиск с фильтрацией по времени работы и по наличию сайта
https://catalog.api.2gis.com/3.0/items?q=красота&city_id=4504222397630173&work_time=thu,09:00&has_site=true&key=YOUR_KEY
Поиск с фильтрацией по дополнительным атрибутам
https://catalog.api.2gis.com/3.0/items?q=поесть&city_id=4504222397630173&attr[food_service_business_lunch]=true&attr[food_service_capacity]=10,30&key=YOUR_KEY
Список компаний
Список компаний в категории
Шаг 1. По точке или по названию найти регион, в котором будет выполняться поиск. Взять значение из поля id.
Поиск региона по названию:
https://catalog.api.2gis.com/2.0/region/search?q=Москва&key=YOUR_KEY
Поиск региона по точке:
https://catalog.api.2gis.com/2.0/region/search?q=37.624186%2C55.754285&key=YOUR_KEY
Подробности про территориальное деление карты на регионы см. в описании Regions API.
Шаг 2. Найти рубрику, по которой будет раскрываться список филиалов. В region_id передаётся значение из шага 1. Взять значения из поля id нужных рубрик.
https://catalog.api.2gis.com/2.0/catalog/rubric/search?region_id=32&q=супермаркеты&key=YOUR_KEY
Шаг 3. Выполнить запрос на /3.0/items с rubric_id=id из прошлого шага (или несколько id через запятую). Добавляем геоограничение (point + radius / sort_point / point1 + point2 / polygon / city_id).
https://catalog.api.2gis.com/3.0/items?rubric_id=350,12127&point=37.624186%2C55.754285&radius=1000&key=YOUR_KEY
Список филиалов одной организации
Шаг 1. Найти филиалы организации, взять значение из поля items->org->id
https://catalog.api.2gis.com/3.0/items?q=москва бургеры&fields=items.org&key=YOUR_KEY
Обратите внимание, что org_id компании уникален для каждого региона.
Шаг 2. Выполнить запрос на метод /3.0/items с org_id=id из прошлого шага. Добавить геоограничение (point + radius / point1 + point2 / polygon / city_id).
https://catalog.api.2gis.com/3.0/items?org_id=4504136499435533&city_id=4504222397630173&key=YOUR_KEY
Список компаний в здании
Шаг 1. Найти здание, взять значение из поля id (часть до знака «_»).
https://catalog.api.2gis.com/3.0/items?q=Москва Доватора, 6/6 к8&type=building&key=YOUR_KEY
Шаг 2. Выполнить запрос на метод /3.0/items с building_id=id из прошлого шага.
https://catalog.api.2gis.com/3.0/items?building_id=4504235282582289&key=YOUR_KEY
Список компаний, обслуживающих здания
Обслуживающие компании — это компании, выполняющие работы по эксплуатации здания и оказывающие различные услуги населению. Например, почта, поликлиника, ЖКХ, интернет-провайдеры, школа, пункт полиции.
Шаг 1. Найти здание, взять значение из поля id (часть до знака «_»).
https://catalog.api.2gis.com/3.0/items?q=Москва, Доватора, 9&key=YOUR_KEY
Шаг 2. Выполнить запрос на метод /2.0/catalog/branch/list с building_id=id из прошлого шага. Для получения обслуживающих организаций указать параметр servicing=true.
Получение служб дома (почта, поликлиника, ЖКХ):
https://catalog.api.2gis.com/2.0/catalog/branch/list?building_id=4504235282737147&servicing=true&servicing_group=default&key=YOUR_KEY
Получение провайдеров в здании:
https://catalog.api.2gis.com/2.0/catalog/branch/list?building_id=4504235282737147&servicing=true&servicing_group=internet&key=YOUR_KEY
Получение служб этого дома и провайдеров в одном запросе:
https://catalog.api.2gis.com/2.0/catalog/branch/list?building_id=4504235282737147&servicing=true&key=YOUR_KEY
Поиск компаний по данным
Поиск по номеру телефона
https://catalog.api.2gis.com/3.0/items/byphone?phone=88001000000&fields=items.org&key=YOUR_KEY
Поиск по сайту
https://catalog.api.2gis.com/3.0/items/bysite?site=www.ikea.ru&key=YOUR_KEY
Поиск по ИНН
https://catalog.api.2gis.com/2.0/catalog/branch/list?itin=7724490000&key=YOUR_KEY
Поиск по торговой лицензии
https://catalog.api.2gis.com/2.0/catalog/branch/list?trade_licence=*&key=YOUR_KEY
Получение компании по идентификатору
Получение компании и данных о входе в компанию
https://catalog.api.2gis.com/3.0/items/byid?id=141265769584430&fields=items.links.database_entrances&key=YOUR_KEY
Поиск мест
Поиск парковок в радиусе
https://catalog.api.2gis.com/3.0/items?q=парковки&type=parking&point=37.592004%2C55.737264&radius=1000&fields=items.capacity,items.point,items.level_count,items.purpose,items.is_paid&key=YOUR_KEY
Поиск здания с получением подробной информации
https://catalog.api.2gis.com/3.0/items?q=Москва Доватора, 9&fields=items.address,items.adm_div,items.floors,items.point,items.links,items.structure_info.apartments_count,items.structure_info.material,items.structure_info.porch_count&key=YOUR_KEY
Поиск остановки
Поиск станции метро в Москве:
https://catalog.api.2gis.com/3.0/items?q=Арбатская&type=station&city_id=4504222397630173&key=YOUR_KEY
Поиск автобусной остановки в Москве:
https://catalog.api.2gis.com/3.0/items?q=Красная площадь&type=station&city_id=4504222397630173&key=YOUR_KEY
Получение объекта по идентификатору
Получение жилого дома
https://catalog.api.2gis.com/3.0/items/byid?id=4504235282757081&key=YOUR_KEY
Получение жилого дома и данных о входах в дом
В ответе могут быть как входы в подъезды, так и входы в организации.
https://catalog.api.2gis.com/3.0/items/byid?id=4504235282757081&fields=items.links.database_entrances&key=YOUR_KEY
Получение компании
https://catalog.api.2gis.com/3.0/items/byid?id=4504127908435201&key=YOUR_KEY
Получение станции метро и данных о входах на станцию
https://catalog.api.2gis.com/3.0/items/byid?id=4504385606385704&fields=items.links.database_entrances&key=YOUR_KEY