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

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

API docs by Redocly

Каталог объектов (3.0)

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

Каталог

Получение коллекции объектов по телефону

Возвращает объекты по переданному номеру телефона. Метод доступен за дополнительную плату.

query Parameters
key
required
string

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

phone
required
string

Номер телефона, по которому осуществляется поиск.

fields
Array of strings
Examples:
  • fields=items.region_id,items.name_ex - Пример нескольких типов
  • fields=items.region_id - Пример единичного типа

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

  • items.point — координаты объекта, заданные в системе координат WGS84 в формате lon, lat;
  • items.address — адрес, по которому располагается объект;
  • items.adm_div — принадлежность к административной территории;
  • items.full_address_name — адрес объекта с указанием города;
  • items.geometry.centroid — визуальный центр геометрии объекта;
  • items.geometry.hover — геометрия области, используемой для определения попадания курсора в зону объекта;
  • items.geometry.selection — геометрия для выделения объекта;

Список полей с дополнительной информацией о месте:
  • items.rubrics — категории компании;
  • items.org — организация, к которой относится филиал;
  • items.brand — бренд, к которому относится филиал;
  • items.contact_groups — контакты компании (требуется дополнительное разрешение у ключа API);
  • items.schedule — расписание работы компании;
  • items.schedule_special — особое расписание работы компании;
  • items.access_comment — локализованное название для типа доступа;
  • items.access — тип доступа для парковки;
  • items.capacity — вместимость парковки;
  • items.description — описание геообъекта;
  • items.external_content — дополнительные данные компании (требуется дополнительное разрешение у ключа API);
  • items.flags — список признаков объекта. Например, что для объекта есть фотографии, или что филиал временно не работает и т.д. Список доступных признаков можно посмотреть в схеме ответа внутри items;
  • items.floors — количество этажей (требуется дополнительное разрешение у ключа API);
  • items.floor_plans — планы этажей (требуется дополнительное разрешение у ключа API);
  • items.is_paid — является ли парковка платной;
  • items.for_trucks — парковка для грузовиков;
  • items.paving_type — тип покрытия парковки;
  • items.is_incentive — является ли парковка перехватывающей;
  • items.purpose — назначение парковки;
  • items.level_count — количество уровней парковки;
  • items.links — связанные объекты (ближайшие парковки, остановки общественного транспорта и другое);
  • items.links.database_entrances — информация о точках входа (требуется дополнительное разрешение у ключа API);
  • items.links.database_entrances.apartments_info — информация о квартирах в доме (требуется дополнительное разрешение у ключа API);
  • items.name_ex — составные части наименования объекта;
  • items.reviews — статистика по отзывам об объекте;
  • items.statistics — cводная информация о геообъекте;
  • items.employees_org_count — численность сотрудников организации (требуется дополнительное разрешение у ключа API);
  • items.itin — индивидуальный номер налогоплательщика (требуется дополнительное разрешение у ключа API);
  • items.trade_license — лицензия филиала (требуется дополнительное разрешение у ключа API);
  • items.fias_code — код ФИАС улиц и административных территорий (требуется дополнительное разрешение у ключа API);
  • items.address.components.fias_code — код ФИАС зданий (требуется дополнительное разрешение у ключа API);
  • items.fns_code — код ФНС административных территорий (требуется дополнительное разрешение у ключа API);
  • items.okato — код ОКАТО улиц и административных территорий (требуется дополнительное разрешение у ключа API);
  • items.address.components.okato — код ОКАТО зданий (требуется дополнительное разрешение у ключа API);
  • items.oktmo — код ОКТМО улиц и административных территорий (требуется дополнительное разрешение у ключа API);
  • items.address.components.oktmo — код ОКТМО зданий (требуется дополнительное разрешение у ключа API);

Список служебных полей:
  • context_rubrics — массив контекстных категорий;
  • dym — блок «Возможно, вы имели ввиду»;
  • filters — фильтры для дополнительного поиска;
  • hash — базовый хеш;
  • items.ads.options — рекламные опции;
  • items.attribute_groups — дополнительные атрибуты компании;
  • items.context — динамическая информация;
  • items.dates.deleted_at — дата удаления организации из базы в формате ISO 8601;
  • items.dates.updated_at — дата последнего изменения информации об организации в формате ISO 8601;
  • items.dates — время внесения информации о компании в БД;
  • items.geometry.style — идентификатор стиля для отображения;
  • items.group — связанные в объединённую карточку объекты;
  • items.metarubrics — метарубрики для выдачи организаций в гибридном объекте;
  • items.delivery — есть доставка;
  • items.has_goods — загружен список товаров фирмы;
  • items.has_pinned_goods — у фирмы включен блок «Закрепленные товары»;
  • items.has_realty — есть недвижимость на продаже;
  • items.has_audiogid — есть аудиогид у объекта;
  • items.has_discount — есть скидки;
  • items.has_exchange — признак наличия курсов валют у филиала;
  • items.is_main_in_group — признак того, что это главный объект в группе объектов гибрида;
  • items.city_alias — алиас города, в котором находится объект;
  • items.detailed_subtype — детализированный тип административно-территориальной единицы;
  • items.alias — транслитерированное название объекта;
  • items.caption — название объекта;
  • items.is_promoted — фирма участвует в промо-акции Чека;
  • items.routes — маршруты транспорта, проходящие через станцию или остановку;
  • items.directions — направления маршрута;
  • items.barrier — тип заграждения;
  • items.is_routing_available — флаг, возможен ли проезд до объекта;
  • items.entrance_display_name — показать номер входа на станцию метро, если объект является входом (station_entrance);
  • items.locale — текущая локаль для региона;
  • items.reg_bc_url — URL для регистрации бизнес-коннекшна просмотра профиля;
  • items.region_id — уникальный идентификатор проекта;
  • items.segment_id — уникальный идентификатор сегмента;
  • items.stat — данные для формирования сообщений статистики;
  • items.stop_factors — набор блокирующих атрибутов, соответствующих запросу;
  • items.has_apartments_info — признак наличия информации о квартирах в здании;
  • items.timezone — часовой пояс в формате POSIX;
  • items.timezone_offset — смещение таймзоны в минутах относительно UTC0;
  • items.comment — комментарий ко входу;
  • items.station_id — уникальный идентификатор остановки, к которой относится остановочная платформа;
  • items.platforms — остановочные платформы остановки;
  • items.sources — идентификатор источника данных об объекте;
  • items.structure_info.material — данные о материале здания (требуется дополнительное разрешение у ключа API);
  • items.structure_info.apartments_count — данные о количестве квартир в здании (требуется дополнительное разрешение у ключа API);
  • items.structure_info.porch_count — данные о количестве подъездов в здании (требуется дополнительное разрешение у ключа API);
  • items.structure_info.floor_type — тип перекрытий в здании (требуется дополнительное разрешение у ключа API);
  • items.structure_info.gas_type — тип газоснабжения здания (требуется дополнительное разрешение у ключа API);
  • items.structure_info.year_of_construction — год постройки здания (требуется дополнительное разрешение у ключа API);
  • items.structure_info.elevators_count — количество лифтов в здании (требуется дополнительное разрешение у ключа API);
  • items.structure_info.is_in_emergency_state — факт признания дома аварийным (требуется дополнительное разрешение у ключа API);
  • items.structure_info.project_type — серия/проект постройки здания (требуется дополнительное разрешение у ключа API);
  • items.structure_info.chs_name — название ОКН (объекта культурного наследия), требуется дополнительное разрешение у ключа API;
  • items.structure_info.chs_category — категория ОКН (требуется дополнительное разрешение у ключа API);
  • items.route_logo — иконка метро;
  • items.order_with_cart — свойства заказа у организации без доставки, но с корзиной;
  • items.is_deleted — признак удаленного объекта;
  • items.search_attributes — параметры результата поиска для найденного объекта. Каждое поле внутри items.search_attributes нужно запрашивать отдельно через точку, например, items.search_attributes.segment_id. Список доступных полей внутри объекта items.search_attributes можно посмотреть в схеме ответа для любого объекта внутри items;
  • items.congestion — загруженность филиала;
  • items.poi_category — категория POI;
  • items.has_dynamic_congestion — признак наличия онлайн значения текущей загруженности филиала;
  • items.temporary_unavailable_atm_services — признак наличия неработающих услуг у банкомата или терминала;
  • items.marker_alt — относительная высота размещения маркера;
  • items.floor_id — идентификатор этажа;
  • items.purpose_code — код назначения здания;
  • request_type — тип поискового запроса;
  • search_attributes — информация о произведённом поиске;
  • widgets — виджеты;
  • items.name_back — для дорожного знака локализованное название в обратном направлении при наличии;
  • items.value_back — для дорожного знака номер километра в обратном направлении;
  • items.ev_charging_station — аттрибуты электрозаправок;
  • items.ski_lift — информация о горнолыжном подъемнике;
  • items.has_ads_model — признак наличия рекламной 3D модели в здании;
  • items.has_otello_stories — признак наличия сторис от Отелло у филиала;
  • items.has_otello_hotels — признак наличия отелей в Отелло;
  • items.summary — блок обобщенной информации;

page
integer [ 1 .. 1000000 ]
Default: 1

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

page_size
integer [ 1 .. 50 ]
Default: 20

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

Responses

Response Schema: application/json
required
object

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

required
object (ObjMeta)

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

Response samples

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