Skip to main content

Search for branches by phone number

API docs by Redocly

Catalog of objects (3.0)

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

Catalog

A collection of objects on the phone

Returns objects to the specified telephone number. Method available at additional cost.

query Parameters
key
required
string

Unique key of API user.

phone
required
string

Phone number, which is used for the search.

fields
Array of strings
Examples:
  • fields=items.region_id,items.name_ex - An example of multiple types
  • fields=items.region_id - An example of a single type

Additional fields to be displayed in the response should be separated by commas. Fields labeled additional permission for the API key is required will be present in the output only if the key has permissions for that field. By default, the key does not have any of these additional permissions.
The list of fields containing information on geometry and address of the place:

  • items.point — object coordinates, specified in the WGS84 in the lon, lat format;
  • items.address — address where the object is located;
  • items.adm_div — belonging to an administrative territory;
  • items.full_address_name — objects address with indication of a city;
  • items.geometry.centroid — visual center of object geometry;
  • items.geometry.hover — geometry of the area used to determine whether the cursor is in the object zone;
  • items.geometry.selection — geometry for object selection;

The list of fields with additional information on the place:
  • items.rubrics — categories of the company;
  • items.org — a company to which the branch belongs;
  • items.brand — brand to which the branch belongs;
  • items.contact_groups — the company's contact details (additional permission from the API key is required to obtain the information);
  • items.schedule — opening hours of the company;
  • items.schedule_special — special schedule company;
  • items.access_comment — localized name for the type of access;
  • items.access_name — localized name of the type of access;
  • items.access — access type for a parking lot;
  • items.capacity — parking lot capacity;
  • items.description — map object description;
  • items.external_content — additional company data (requires additional permission on API key);
  • items.flags — a list of object attributes;
  • items.floors — the number of floors (additional permission from the API key is required to obtain the information);
  • items.floor_plan — the plan of floors (additional permission from the API key is required to obtain the information);
  • items.is_paid — whether the parking facility is chargeable or not;
  • items.for_trucks — truck parking;
  • items.paving_type — type of parking paving;
  • items.is_incentive — whether this parking is intercepting.;
  • items.purpose — purpose of parking lot;
  • items.level_count — the number of parking facility levels;
  • items.links — linked objects (nearest parking, public transport stops, and more);
  • items.links.database_entrances — information about entry points (requires additional permission on the API key);
  • items.links.database_entrances.apartments_info — information about the apartments in the building (additional permission from the API key is required to obtain the information);
  • items.name_ex — components of the object name;
  • items.reviews — statistics on reviews about the object;
  • items.employees_org_count — the number of employees of the organization (additional permission from the API key is required to obtain the information);
  • items.itin — the individual number of the taxpayer (additional permission from the API key is required to obtain the information);
  • items.trade_license — the license of the branch (additional permission from the API key is required to obtain the information);
  • items.fias_code — FIAS code of streets and administrative territories;
  • items.address.components.fias_code — FIAS code of buildings;
  • items.fns_code — FNS code of administrative territories (additional permission for API key is required);
  • items.okato — OKATO code of streets and administrative territories (additional permission for API key is required);
  • items.address.components.okato — OKATO code of buildings (additional permission for API key is required);
  • items.oktmo — OKTMO code of streets and administrative territories (additional permission for API key is required);
  • items.address.components.oktmo — OKTMO code of buildings (additional permission for API key is required);

The list of command boxes:
  • items.dates.deleted_at — the date when the company data was last deleted in the ISO 8601 format;
  • items.dates.updated_at — the date when the company data was last updated in the ISO 8601 format;
  • items.dates — the time when the information on the company was added to the database;
  • items.geometry.style — style ID for display;
  • items.detailed_subtype — detailed type of administrative-territorial unit;
  • items.group — objects gathered in one linked card;
  • items.delivery — delivery is available
  • items.is_main_in_group — an attribute meaning that it is the main object in the group of the hybrid objects.
  • items.routes — transport routes passing through the station or public transport stop;
  • items.directions — route directions;
  • items.barrier — type of enclosure;
  • items.floor_id — floor ID;
  • items.is_routing_available — a flag showing whether it is possible to create a route to the object or not;
  • items.locale — current locale for the region;
  • items.region_id — unique identifier of the project;
  • items.segment_id — unique identifier of the segment;
  • items.stop_factors — a set of blocking attributes that match the query;
  • items.has_apartments_info — an attribute of availability of information on apartments in the building;
  • items.timezone — timezone in the POSIX format;
  • items.timezone_offset — the offset the offset at the minute regarding UTC0;
  • items.comment — comment for the entrance;
  • items.station_id — the unique identifier of the stop to which this stopping platform is linked;
  • items.platforms — the bus stop platform stop;
  • items.sources — the ID of the object data source;
  • items.structure_info — the data on the number of apartments and the material the building is made of (additional permission from the API key is required to obtain the information;
  • items.structure_info.material — information about the material the building is made of (additional permission from the API key is required to obtain the information;
  • items.structure_info.apartments_count — the data on the number of apartments (additional permission from the API key is required to obtain the information;
  • items.structure_info.porch_count — the data on the number of entrances (additional permission from the API key is required to obtain the information;
  • items.route_logo — icon of the underground;
  • items.is_deleted — a sign of a deleted object;
  • items.search_attributes — parameters of the search result for the found object. Each field inside items.search_attributes must be queried separately through a dot, for example, items.search_attributes.segment_id. The list of available fields inside the items.search_attributes object can be viewed in the response schema for any object inside items;
  • items.congestion — branch congestion;
  • items.marker_alt — relative height of marker placement;
  • items.purpose_code — code of the purpose of the building;
  • items.poi_category — POI category;
  • search_attributes — information about the performed search;
  • items.name_back — for the road sign, the localized name in the reverse direction, if available;
  • items.value_back — for the road sign, the number of the kilometer in the reverse direction;
  • items.ev_charging_station — attributes for charging stations;
  • items.has_ads_model — an indication of the presence of an advertising 3D model in the building;
  • items.has_otello_stories — A sign that has story from Otello in the branch;
  • items.has_otello_hotels — sign of availability of hotels in Otello;
  • items.summary — block of summarized information;

page
integer [ 1 .. 1000000 ]
Default: 1

The number of the requested page.

page_size
integer [ 1 .. 50 ]
Default: 20

Number of search results displayed on one page.

Responses

Response Schema: application/json
required
object

Main result

required
object (ObjMeta)

Response metadata

Response samples

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