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

Примеры

Поиск компаний​

Ограничение количества результатов поиска​

Чтобы ограничить количество объектов в результатах поиска, используйте параметры:

  • page_size — количество объектов на странице. Если вы используете демо-ключ для доступа к API, максимальное значение — 10.
  • page — номер страницы. Для демо-ключа максимальное значение — 5.
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&location=37.545423%2C55.740693&sort=distance&key=YOUR_KEY

Поиск с указанием точки поиска​

https://catalog.api.2gis.com/3.0/items?q=кафе&location=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, в котором выполняется поиск, одним из способов ниже:

    • Поиск города по точке:

      https://catalog.api.2gis.com/3.0/items?lon=37.62143&lat=55.752966&type=adm_div.city&key=YOUR_KEY

    • Поиск города по названию:

      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 метро.

      https://catalog.api.2gis.com/3.0/items?type=station.metro&q=косино&fields=items.point&location=37.617135%2C55.757705&key=YOUR_KEY

    2. Скопируйте значение из поля id и передайте в поле subway при запросе (город в названии можно не указывать):

      https://catalog.api.2gis.com/3.0/items?q=красота&fields=items.point&subway=70030076180130124&location=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. Найдите регион, в котором будет выполняться поиск, одним из способов ниже:

    • Поиск региона по названию:

      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. Найдите рубрику, по которой будет раскрываться список филиалов. Передайте значения из шага 1 (поля id нужных рубрик) в поле region_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 / location / 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. Найдите филиалы организации.

    https://catalog.api.2gis.com/3.0/items?q=москва бургеры&fields=items.org&key=YOUR_KEY

    Скопируйте значение из поля items->org->id. Обратите внимание, что 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. Найдите нужное здание.

    https://catalog.api.2gis.com/3.0/items?q=Москва Доватора, 6/6 к8&type=building&key=YOUR_KEY

    Скопируйте значение из поля id (часть до знака «_»).

  2. Отправьте запрос к методу /3.0/items с building_id=id из прошлого шага.

    https://catalog.api.2gis.com/3.0/items?building_id=4504235282582289&key=YOUR_KEY

Список компаний, обслуживающих здания​

Обслуживающие компании — это компании, выполняющие работы по эксплуатации здания и оказывающие различные услуги населению. Например, почта, поликлиника, ЖКХ, интернет-провайдеры, школа, пункт полиции.

  1. Найдите нужное здание.

    https://catalog.api.2gis.com/3.0/items?q=Москва, Доватора, 9&key=YOUR_KEY

    Скопируйте значение из поля id (часть до знака «_»).

  2. Отправьте запрос к методу /3.0/items/byservicing, указав id из прошлого шага в параметре building_id.

    • Получение городских обслуживающих организаций, относящихся к зданию (почта, поликлиника, ЖКХ):

      https://catalog.api.2gis.com/3.0/items/byservicing?building_id=4504235282737147&servicing_group=default&key=YOUR_KEY

    • Получение интернет-провайдеров в здании:

      https://catalog.api.2gis.com/3.0/items/byservicing?building_id=4504235282737147&servicing_group=internet&key=YOUR_KEY

    • Получение городских обслуживающих организаций и интернет-провайдеров в одном запросе:

      https://catalog.api.2gis.com/3.0/items/byservicing?building_id=4504235282737147&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/3.0/items/byitin?itin=7724490000&key=YOUR_KEY

Поиск по торговой лицензии​

https://catalog.api.2gis.com/3.0/items/bytradelicense?trade_licence=*&key=YOUR_KEY

Поиск по коду ФИАС​

https://catalog.api.2gis.com/3.0/items/byfias?fias_code=*&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=Арбатская&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?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/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

Получение ближайших парковок и остановок​

https://catalog.api.2gis.com/3.0/items/byid?id=4504235282757081&fields=items.links&key=YOUR_KEY

В теле ответа вы сможете найти:

  • links.nearest_stations — информацию о ближайших остановках общественного транспорта. Обратите внимание на приоритет типов транспорта:

    • Если объект по указанному ID расположен недалеко от метро (в радиусе 1,5-2 км), то в списке ближайших остановок будут только станции метро (включая лёгкое метро и МЦК).
    • Если объект расположен далеко от метро или если в городе поиска нет метро, указывается одна ближайшая (в радиусе 1 км) остановка транспорта. Самый низкий по приоритету тип транспорта — электричка.
    • Если в радиусе поиска нет метро и остановок общественного транспорта, то указывается ближайшая (в радиусе 3 км) железнодорожная станция.

  • links.nearest_parking — ID ближайших парковок.