Skip to main content

List of branches (deprecated)

API docs by Redocly

Business listing (2.0)

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

Getting a list of branches according to parameters Deprecated

Method support discontinued. To see a list of companies in an organization, a building or a city, use 3.0/items method.

query Parameters
key
required
string

A unique key of API user.

building_id
required
string

Building ID.

org_id
required
string

Company ID.

rubric_id
required
string

Category identifiers. The region_id parameter must be passed.

You can also send a list of category IDs separated by commas, in this case, all the categories should be from the same region.

region_id
string

Region ID. Required if no geographic search restriction is specified. Details on how the map is divided into regions can be found in the Regions API description.

servicing
string

Takes a single value of true. You should pass building_id.

servicing_group
string

Type of the service provider. Possible values:

  • default — city service providers;
  • internet — Internet service providers;
  • all — all of the above mentioned.
point
string
Example: point=82.921663,55.030195

The center of the search area (point coordinates in lon, lat format).

Used for filtering results within a circle.

radius
integer [ 0 .. 40000 ]
Default: 250

The search radius in meters. Used for filtering results within a circle.

point1
string
Example: point1=82.921663,55.030195

The coordinates of the top-left vertex of the rectangular area, in lon, lat format, that limits the results of the selection.

Used for filtering results within a rectangular area.

Allowed difference of the point1 and point2 coordinates is not more than 0.06 for lon, and 0.04 (approximately 6.6 x 4.4 km) for lat.

If the q parameter is passed, no restrictions are applied.

point2
string
Example: point2=82.921663,55.030195

The coordinates of the bottom-right vertex of the rectangular area, in lon, lat format, that limits the results of the selection.

Used for filtering results within a rectangular area.

Allowed difference of the point1 and point2 coordinates is not more than 0.06 for lon, and 0.04 (approximately 6.6 x 4.4 km) for lat.

If the q parameter is passed, no restrictions are applied.

viewpoint1
string
Examples:
  • viewpoint1=82.921663,55.030195 - Longitude and latitude

The coordinates of the top-left vertex of the viewport's rectangular area, in lon, lat format.

The viewpoint1 and viewpoint2 parameters pass the map area the user was viewing before entering the query.

Used as one of the criteria for determining where results are needed, and for ranking. Does not strictly limit the search results to only the specified area.

viewpoint2
string
Examples:
  • viewpoint2=82.921663,55.030195 - Longitude and latitude

The coordinates of the bottom-right vertex of the viewport's rectangular area, in lon, lat format.

The viewpoint1 and viewpoint2 parameters pass the map area the user was viewing before entering the query.

Used as one of the criteria for determining where results are needed, and for ranking. Does not strictly limit the search results to only the specified area.

polygon
string
Example: polygon=POLYGON((82.91259527206421 55.0614369017519,82.90572881698608 55.05902823221974,82.91521310806274 55.05580825372468))

A polygon in WKT format.

Used for filtering results within an arbitrary area.

page
integer
Default: 1

The number of the requested page.

page_size
integer [ 1 .. 50 ]
Default: 20

Number of search results displayed on one page.

sort
string

Sorting of the results.

Allowed values:

  • relevance — by descending order of the relevance. The search involves the company name and categories, to which the company belongs. It takes into account a maximum of different factors: the accuracy of matching the request to the object, the popularity of objects, rating, location, advertising and much more;
  • distance — by ascending order of the distance. Distance is calculated up to the center of the areal map objects (cities, districts, etc.) and by the shortest distance to the line (street). If the sort_point parameter has been passed, the distance is calculated up to this point;
  • rating — by descending order of the rating;
  • flamp_rating — by descending rating on Flamp;
  • creation_time — in descending order of the date the company branch was created;
  • opened_time — by descending order of the opening date;
  • name — by name (in alphabetical ascending order).
fields
Array of strings

Additional fields to be displayed in the response should be separated by commas.

List of available fields:

  • items.see_also — list of «see also»;
  • items.description — description of the organization;
  • items.geometry.selection — geometry for object selection;
  • items.geometry.hover — geometry of the area used to determine whether the cursor is in the object zone;
  • items.geometry.style — style ID for display;
  • items.geometry.centroid — visual center of object geometry;
  • items.timezone — time zone object in the POSIX format;
  • items.timezone_offset — the offset the offset at the minute regarding UTC0;
  • items.sources — a data source about the organization;
  • items.is_main_in_group — a sign that it is the main object in the object group of hybrid;
  • items.name_ex — part of the name of the organization;
  • items.alias is the alias name of the organization;
  • items.region_id — unique identifier of the project;
  • items.segment_id — unique identifier of the segment;
  • items.org — describes the properties of the organization;
  • items.point — the coordinates of the search points defined in the WGS84 coordinate system in the format lon, lat;
  • items.adm_div` — belonging to an administrative territory;
  • items.dates — the time of making of information on the location in the database;
  • items.flags — a list of object attributes;
  • items.locale — the current locale for the region;
  • items.address — address which is a branch of the organization;
  • items.full_address_name — the same as address_name, but with the city;
  • items.schedule — schedule of work of the branch;
  • items.reviews — statistics on branch reviews;
  • items.ads — advertising materials of this branch;
  • items.ads.options — advertising options;
  • items.links — linked objects (nearest parking, public transport stops, and more);
  • items.dates.updated_at — the date when the company data was last updated in the ISO 8601 format;
  • items.dates.deleted_at — the date when the company data was last deleted in the ISO 8601 format;
  • items.dates.created_at — date when the organization was opened in ISO 8601 format;
  • items.is_routing_available — a flag showing whether it is possible to create a route to the object;
  • items.stop_factors — a set of locking attributes corresponding to the query;
  • items.attribute_groups — additional attributes of the branch;
  • items.rubrics — branch categories;
  • items.attribute_groups — additional attributes of the branch;
  • items.reg_bc_url — enrollment URL of the business konnekshn view profile;
  • items.email_for_sending.allowed — permission to send a letter to the company;
  • items.employees_org_count — the number of employees in the organization. This field is only available in the commercial API;
  • items.itin — the individual number of the taxpayer. Field is available only in commercial API;
  • items.trade_license — the license of the branch. Field is available only in commercial API;
  • items.group — objects gathered in one linked card;
  • items.stat — data to generate message statistics;
  • items.has_discount — there are discounts;
  • items.poi_category — POI category;
  • context_rubrics — an array of contextual headings;
  • request_type — type the search request;
  • search_type — type of the request to send for the statistics;
  • dym — the block «you Probably mean»;
  • hash — underlying hash;
  • search_attributes — information about the performed search;
  • filters — filters for additional search;
  • widgets — widgets;
  • cb — context banner.
locale
string
Examples:
  • locale=ar_AE - Arabic for the UAE
  • locale=ru_RU - Russian for Russia

The locale with which the search is performed and given results.

List of available locales:

  • ar_AE — Arabic (UAE);
  • ar_BH — Arabic (Bahrain);
  • ar_EG — Arabic (Egypt);
  • ar_IQ — Arabic (Iraq);
  • ar_KW — Arabic (Kuwait);
  • ar_MA — Arabic (Morocco);
  • ar_OM — Arabic (Oman);
  • ar_QA — Arabic (Qatar);
  • ar_RU — Arabic (Russia);
  • ar_SA — Arabic (Saudi Arabia);
  • az_AZ — Azerbaijani (Azerbaijan);
  • cs_CZ — Czech (Czech Republic);
  • cs_RU — Czech (Russia);
  • en_AM — English (Armenia);;
  • en_AE — English (UAE);
  • en_BH — English (Bahrain);
  • en_CN — English (China);
  • en_CY — English (Cyprus);
  • en_EG — English (Egypt);
  • en_IQ — English (Iraq);
  • en_KW — English (Kuwait);
  • en_MA — English (Morocco);
  • en_MN — English (Mongolia);
  • en_OM — English (Oman);
  • en_QA — English (Qatar);
  • en_RU — English (Russia);
  • en_SA — English (Saudi Arabia);
  • es_CL — Spanish (Cyprus);
  • es_RU — Spanish (Russia);
  • hy_AM — Armenian (Armenia);
  • it_IT — Italian (Italy);
  • it_RU — Italian (Russia);
  • ka_GE — Georgian (Georgia);
  • kk_KZ — Kazakh (Kazakhstan);
  • ky_KG — Kyrgyz (Kyrgyzstan);
  • mn_MN — Mongolian (Mongolia);
  • ru_AM — Russian (Armenia);
  • ru_AZ — Russian (Azerbaijan);
  • ru_BY — Russian (Belarus);
  • ru_CN — Russian (China);
  • ru_GE — Russian (Georgia);
  • ru_KG — Russian (Kyrgyzstan);
  • ru_KZ — Russian (Kazakhstan);
  • ru_RU — Russian (Russia);
  • ru_TJ — Russian (Tajikistan);
  • ru_UZ — Russian (Uzbekistan);
  • tg_TJ — Tajik (Tajikistan);
  • uz_UZ — Uzbek (Uzbekistan);
  • zh_CN — Chinese (China).
opened_after_date
string
Example: opened_after_date=2001-01-24

Filters companies which have the opening date later than the passed parameter.

Accepts values in the YYYY-MM-DD format.

itin
string

Individual taxpayer identification number.

work_time
string
Examples:
  • work_time=now - Right now
  • work_time=tue,alltime - On Tuesday, open 24 hours

The company's working hours. Format: [day],[time] or now (current day and time).

Examples:

  • Monday, 17:00 — mon,17:00
  • Thursday, 9:00 — thu,09:00
  • Today, 9:00 — today,09:00
  • Friday, all day — fri,alltime
  • Now now
has_reviews
boolean

Filter by the presence of reviews on flamp.ru. Can be either true or false.

has_photos
boolean

Filter by the presence of photos. Can be either true or false.

has_site
boolean

Filter by the presence of a website. Can be either true or false.

has_rating
boolean

Filter by the presence of a rating on flamp.ru. Can be either true or false.

has_itin
boolean

Filter by the presence of an individual taxpayer number. Can be either true or false.

city_id
Array of strings

The IDs of the city separated by commas. They are used to filter branches by cities.

The maximum number is 50.

district_id
string

The IDs of the districts separated by commas. They are used to filter branches by districts.

The maximum number is 50.

Responses

Response Schema:
required
object

Response metadata.

required
object

Main result

Response samples

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