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

Список компаний

API docs by Redocly

Справочник организаций (2.0)

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

Получение списка филиалов по параметрам

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

query Parameters
key
required
string

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

building_id
required
string

Идентификатор здания.

org_id
required
string

Идентификатор организации.

rubric_id
required
string

Идентификатор категорий. Необходимо передать параметр region_id.
Также можно передавать список идентификаторов категорий через запятую, в этом случае все категории должны быть из одного региона.

region_id
string

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

servicing
string

Принимает единственное значение true. Необходимо передать building_id.

servicing_group
string

Тип обслуживающей организации.
Возможные значения:

  • default — городские обслуживающие организации;
  • internet — интернет провайдеры;
  • all — все перечисленные.

point
string
Example: point=82.921663,55.030195

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

radius
integer [ 0 .. 40000 ]
Default: 250

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

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.
Используется для фильтрации результатов в произвольной области.

page
integer
Default: 1

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

page_size
integer [ 1 .. 50 ]
Default: 20

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

sort
string

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

  • relevance — по убыванию релевантности. В поиске участвует название организации и категории, в которые входит организация. Учитывает максимум разных факторов: точность соответствия запроса объекту, популярность объектов, рейтинг, расположение, реклама и многое другое;
  • distance — по возрастанию расстояния.
    Расстояние рассчитывается до центра площадных геообъектов (городов, районов и т.д.) и по кратчайшему расстоянию до линейных (улиц).
    Если передан параметр sort_point, то расстояние рассчитывается до этой точки;
  • rating — по убыванию рейтинга;
  • flamp_rating — по убыванию рейтинга Флампа;
  • creation_time — по убыванию даты создания филиала организации;
  • opened_time — по убыванию даты открытия;
  • name — по наименованию (в алфавитном порядке по возрастанию).

fields
Array of strings

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

  • items.see_also — список рекламодателей для блока «смотри также»;
  • items.description — описание организации;
  • items.geometry.selection — геометрия для выделения объекта;
  • items.geometry.hover — геометрия области, используемой для определения попадания курсора в зону объекта;
  • items.geometry.style — идентификатор стиля для отображения;
  • items.geometry.centroid — визуальный центр геометрии объекта;
  • items.timezone — временная зона объекта в формате POSIX;
  • items.timezone_offset — смещение таймзоны в минутах относительно UTC0;
  • items.sources — источник данных об организации;
  • items.is_main_in_group — признак того, что это главный объект в группе объектов гибрида;
  • items.name_ex — составные части наименования организации;
  • items.alias — псевдоним названия организации;
  • items.region_id — уникальный идентификатор проекта;
  • items.segment_id — уникальный идентификатор сегмента;
  • items.org — описание свойств организации;
  • items.point — координаты точки поиска, заданные в системе координат WGS84 в формате lon, lat;
  • items.adm_div — принадлежность к административной территории;
  • items.dates — время внесения информации о филиале в БД;
  • items.flags — список признаков объекта. Например, что для объекта есть фотографии, или что филиал временно не работает и т.д. Список доступных признаков можно посмотреть в схеме ответа внутри items;
  • items.external_content — дополнительные данные филиала (требуется дополнительное разрешение у ключа API);
  • items.locale — текущая локаль для региона;
  • items.address — адрес, по которому располагается филиал организации;
  • items.full_address_name — то же, что и address_name, но с указанием города;
  • items.schedule — расписание работы филиала;
  • items.reviews — статистика по отзывам о филиале;
  • items.ads — рекламные материалы данного филиала;
  • items.ads.options — рекламные опции;
  • items.links — связанные объекты (ближайшие парковки, остановки общественного транспорта и другое);
  • items.dates.updated_at — дата последнего изменения информации об организации в формате ISO 8601;
  • items.dates.deleted_at — дата удаления организации из базы в формате ISO 8601;
  • items.dates.created_at — дата открытия организации в формате ISO 8601;
  • items.is_routing_available — флаг, возможен ли проезд до объекта;
  • items.stop_factors — набор блокирующих атрибутов, соответствующих запросу;
  • items.contact_groups — контакты филиала;
  • items.rubrics — категории филиала;
  • items.attribute_groups — дополнительные атрибуты филиала;
  • items.reg_bc_url — URL для регистрации бизнес-коннекшна просмотра профиля;
  • items.email_for_sending.allowed — разрешение на отправку письма в компанию;
  • items.employees_org_count — численность сотрудников организации. Поле доступно только в коммерческом API;
  • items.itin — индивидуальный номер налогоплательщика. Поле доступно только в коммерческом API;
  • items.trade_license — лицензия филиала. Поле доступно только в коммерческом API;
  • items.group — связанные в объединённую карточку объекты;
  • items.stat — данные для формирования сообщений статистики;
  • items.has_discount — есть скидки;
  • items.congestion — загруженность филиала;
  • items.poi_category — категория POI;
  • context_rubrics — массив контекстных категорий;
  • request_type — тип поискового запроса;
  • search_type — тип запроса для отправки в статистику;
  • ad — GTA баннеры;
  • hash — базовый хеш;
  • search_attributes — информация о произведённом поиске;
  • filters — фильтры для дополнительного поиска;
  • widgets — виджеты;
  • cb — контекстный баннер.

locale
string

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

opened_after_date
string
Example: opened_after_date=2001-01-24

Фильтрует компании, у которых дата открытия позже, чем переданный параметр.
Принимает значения в формате YYYY-MM-DD.

itin
string

Индивидуальный номер налогоплательщика.

work_time
string

Время работы организации. Формат: [day],[time] или now (текущий день и время).
Примеры:

  • Понедельник, 17:00 — mon,17:00
  • Четверг, 9:00 — thu,09:00
  • Сегодня, 9:00 — today,09:00
  • Пятница, весь день — fri,alltime
  • Сейчас — now

has_reviews
boolean

Фильтр по наличию отзывов на flamp.ru. Принимает значения: true или false.

has_photos
boolean

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

has_site
boolean

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

has_rating
boolean

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

has_itin
boolean

Фильтр по наличию индивидуального номера налогоплательщика. Принимает значения: true или false.

city_id
string

Идентификаторы города, разделённые запятыми. Используется для фильтрации филиалов по городу.
Максимальное количество — 50.

district_id
string

Идентификаторы районов, разделённые запятыми. Используется для фильтрации филиалов по району.
Максимальное количество — 50.

Responses

Response Schema:
required
object

Основной результат

required
object (ObjMeta)

Метаданные ответа

Response samples

Content type
{
  • "result": {
    • "context_rubrics": [
      ],
    • "items": [
      ],
    • "total": 1
    },
  • "meta": {
    • "code": 200,
    • "api_version": "dev",
    • "issue_date": "string"
    }
}