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: <ul> <li>`items.point` — object coordinates, specified in the WGS84 in the lon, lat format;</li> <li>`items.address` — address where the object is located;</li> <li>`items.adm_div` — belonging to an administrative territory;</li> <li>`items.full_address_name` — objects address with indication of a city;</li> <li>`items.geometry.centroid` — visual center of object geometry;</li> <li>`items.geometry.hover` — geometry of the area used to determine whether the cursor is in the object zone;</li> <li>`items.geometry.selection` — geometry for object selection;</li> </ul> The list of fields with additional information on the place: <ul> <li>`items.rubrics` — categories of the company;</li> <li>`items.org` — a company to which the branch belongs;</li> <li>`items.brand` — brand to which the branch belongs;</li> <li>`items.contact_groups` — the company's contact details (additional permission from the API key is required to obtain the information);</li> <li>`items.schedule` — opening hours of the company;</li> <li>`items.schedule_special` — special schedule company;</li> <li>`items.access_comment` — localized name for the type of access;</li> <li>`items.access_name` — localized name of the type of access;</li> <li>`items.access` — access type for a parking lot;</li> <li>`items.capacity` — parking lot capacity;</li> <li>`items.description` — map object description;</li> <li>`items.external_content` — additional company data (requires additional permission on API key);</li> <li>`items.flags` — a list of object attributes;</li> <li>`items.floors` — the number of floors (additional permission from the API key is required to obtain the information);</li> <li>`items.floor_plan` — the plan of floors (additional permission from the API key is required to obtain the information);</li> <li>`items.is_paid` — whether the parking facility is chargeable or not;</li> <li>`items.for_trucks` — truck parking;</li> <li>`items.paving_type` — type of parking paving;</li> <li>`items.is_incentive` — whether this parking is intercepting.;</li> <li>`items.purpose` — purpose of parking lot;</li> <li>`items.level_count` — the number of parking facility levels;</li> <li>`items.links` — linked objects (nearest parking, public transport stops, and more);</li> <li>`items.links.database_entrances` — information about entry points (requires additional permission on the API key);</li> <li>`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);</li> <li>`items.name_ex` — components of the object name;</li> <li>`items.reviews` — statistics on reviews about the object;</li> <li>`items.employees_org_count` — the number of employees of the organization (additional permission from the API key is required to obtain the information);</li> <li>`items.itin` — the individual number of the taxpayer (additional permission from the API key is required to obtain the information);</li> <li>`items.trade_license` — the license of the branch (additional permission from the API key is required to obtain the information);</li> <li>`items.fias_code` — FIAS code of streets and administrative territories;</li> <li>`items.address.components.fias_code` — FIAS code of buildings;</li> <li>`items.fns_code` — FNS code of administrative territories (additional permission for API key is required);</li> <li>`items.okato` — OKATO code of streets and administrative territories (additional permission for API key is required);</li> <li>`items.address.components.okato` — OKATO code of buildings (additional permission for API key is required);</li> <li>`items.oktmo` — OKTMO code of streets and administrative territories (additional permission for API key is required);</li> <li>`items.address.components.oktmo` — OKTMO code of buildings (additional permission for API key is required);</li> </ul> The list of command boxes: <ul> <li>`items.dates.deleted_at` — the date when the company data was last deleted in the ISO 8601 format;</li> <li>`items.dates.updated_at` — the date when the company data was last updated in the ISO 8601 format;</li> <li>`items.dates` — the time when the information on the company was added to the database;</li> <li>`items.geometry.style` — style ID for display;</li> <li>`items.detailed_subtype` — detailed type of administrative-territorial unit;</li> <li>`items.group` — objects gathered in one linked card;</li> <li>`items.delivery` — delivery is available</li> <li>`items.is_main_in_group` — an attribute meaning that it is the main object in the group of the hybrid objects.</li> <li>`items.routes` — transport routes passing through the station or public transport stop;</li> <li>`items.directions` — route directions;</li> <li>`items.barrier` — type of enclosure;</li> <li>`items.floor_id` — floor ID;</li> <li>`items.is_routing_available` — a flag showing whether it is possible to create a route to the object or not;</li> <li>`items.locale` — current locale for the region;</li> <li>`items.region_id` — unique identifier of the project;</li> <li>`items.segment_id` — unique identifier of the segment;</li> <li>`items.stop_factors` — a set of blocking attributes that match the query;</li> <li>`items.has_apartments_info` — an attribute of availability of information on apartments in the building;</li> <li>`items.timezone` — timezone in the POSIX format;</li> <li>`items.timezone_offset` — the offset the offset at the minute regarding UTC0;</li> <li>`items.comment` — comment for the entrance;</li> <li>`items.station_id` — the unique identifier of the stop to which this stopping platform is linked;</li> <li>`items.platforms` — the bus stop platform stop;</li> <li>`items.sources` — the ID of the object data source;</li> <li>`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;</li> <li>`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;</li> <li>`items.structure_info.apartments_count` — the data on the number of apartments (additional permission from the API key is required to obtain the information;</li> <li>`items.structure_info.porch_count` — the data on the number of entrances (additional permission from the API key is required to obtain the information;</li> <li>`items.route_logo` — icon of the underground;</li> <li>`items.is_deleted` — a sign of a deleted object;</li> <li>`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;</li> <li>`items.congestion` — branch congestion;</li> <li>`items.marker_alt` — relative height of marker placement;</li> <li>`items.purpose_code` — code of the purpose of the building;</li> <li>`items.poi_category` — POI category;</li> <li>`search_attributes` — information about the performed search;</li> <li>`items.name_back` — for the road sign, the localized name in the reverse direction, if available;</li> <li>`items.value_back` — for the road sign, the number of the kilometer in the reverse direction;</li> <li>`items.ev_charging_station ` — attributes for charging stations;</li> <li>`items.has_ads_model` — an indication of the presence of an advertising 3D model in the building;</li> <li>`items.has_otello_stories` — A sign that has story from Otello in the branch;</li> </ul>

fields

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: <ul> <li>`items.point` — object coordinates, specified in the WGS84 in the lon, lat format;</li> <li>`items.address` — address where the object is located;</li> <li>`items.adm_div` — belonging to an administrative territory;</li> <li>`items.full_address_name` — objects address with indication of a city;</li> <li>`items.geometry.centroid` — visual center of object geometry;</li> <li>`items.geometry.hover` — geometry of the area used to determine whether the cursor is in the object zone;</li> <li>`items.geometry.selection` — geometry for object selection;</li> </ul> The list of fields with additional information on the place: <ul> <li>`items.rubrics` — categories of the company;</li> <li>`items.org` — a company to which the branch belongs;</li> <li>`items.brand` — brand to which the branch belongs;</li> <li>`items.contact_groups` — the company's contact details (additional permission from the API key is required to obtain the information);</li> <li>`items.schedule` — opening hours of the company;</li> <li>`items.schedule_special` — special work schedule;</li> <li>`items.access_comment` — localized name for the type of access;</li> <li>`items.access_name` — localized name of the type of access;</li> <li>`items.access` — access type for a parking lot;</li> <li>`items.capacity` — parking lot capacity;</li> <li>`items.description` — map object description;</li> <li>`items.external_content` — additional company data (requires additional permission on API key);</li> <li>`items.flags` — a list of object attributes;</li> <li>`items.floors` — the number of floors (additional permission from the API key is required to obtain the information);</li> <li>`items.floor_plan` — the plan of floors (additional permission from the API key is required to obtain the information);</li> <li>`items.is_paid` — whether the parking facility is chargeable or not;</li> <li>`items.for_trucks` — truck parking;</li> <li>`items.paving_type` — type of parking paving;</li> <li>`items.is_incentive` — whether this parking is intercepting.;</li> <li>`items.purpose` — purpose of parking lot;</li> <li>`items.level_count` — the number of parking facility levels;</li> <li>`items.links` — linked objects (nearest parking, public transport stops, and more);</li> <li>`items.links.database_entrances` — information about entry points (requires additional permission on the API key);</li> <li>`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);</li> <li>`items.name_ex` — components of the object name;</li> <li>`items.reviews` — statistics on reviews about the object;</li> <li>`items.employees_org_count` — the number of employees of the organization (additional permission from the API key is required to obtain the information);</li> <li>`items.itin` — the individual number of the taxpayer (additional permission from the API key is required to obtain the information);</li> <li>`items.trade_license` — the license of the branch (additional permission from the API key is required to obtain the information);</li> <li>`items.fias_code` — FIAS code of streets and administrative territories;</li> <li>`items.address.components.fias_code` — FIAS code of buildings;</li> <li>`items.fns_code` — FNS code of administrative territories (additional permission for API key is required);</li> <li>`items.okato` — OKATO code of streets and administrative territories (additional permission for API key is required);</li> <li>`items.address.components.okato` — OKATO code of buildings (additional permission for API key is required);</li> <li>`items.oktmo` — OKTMO code of streets and administrative territories (additional permission for API key is required);</li> <li>`items.address.components.oktmo` — OKTMO code of buildings (additional permission for API key is required);</li> </ul> The list of command boxes: <ul> <li>`items.dates.deleted_at` — the date when the company data was last deleted in the ISO 8601 format;</li> <li>`items.dates.updated_at` — the date when the company data was last updated in the ISO 8601 format;</li> <li>`items.dates` — the time when the information on the company was added to the database;</li> <li>`items.geometry.style` — style ID for display;</li> <li>`items.detailed_subtype` — detailed type of administrative-territorial unit;</li> <li>`items.group` — objects gathered in one linked card;</li> <li>`items.delivery` — delivery is available</li> <li>`items.is_main_in_group` — an attribute meaning that it is the main object in the group of the hybrid objects.</li> <li>`items.routes` — transport routes passing through the station or public transport stop;</li> <li>`items.directions` — route directions;</li> <li>`items.barrier` — type of enclosure;</li> <li>`items.floor_id` — floor ID;</li> <li>`items.is_routing_available` — a flag showing whether it is possible to create a route to the object or not;</li> <li>`items.locale` — current locale for the region;</li> <li>`items.region_id` — unique identifier of the project;</li> <li>`items.segment_id` — unique identifier of the segment;</li> <li>`items.stop_factors` — a set of blocking attributes that match the query;</li> <li>`items.has_apartments_info` — an attribute of availability of information on apartments in the building;</li> <li>`items.timezone` — timezone in the POSIX format;</li> <li>`items.timezone_offset` — the offset the offset at the minute regarding UTC0;</li> <li>`items.comment` — comment for the entrance;</li> <li>`items.station_id` — the unique identifier of the stop to which this stopping platform is linked;</li> <li>`items.platforms` — the bus stop platform stop;</li> <li>`items.sources` — the ID of the object data source;</li> <li>`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;</li> <li>`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;</li> <li>`items.structure_info.apartments_count` — the data on the number of apartments (additional permission from the API key is required to obtain the information;</li> <li>`items.structure_info.porch_count` — the data on the number of entrances (additional permission from the API key is required to obtain the information;</li> <li>`items.route_logo` — icon of the underground;</li> <li>`items.is_deleted` — a sign of a deleted object;</li> <li>`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;</li> <li>`items.congestion` — branch congestion;</li> <li>`items.marker_alt` — relative height of marker placement;</li> <li>`items.purpose_code` — code of the purpose of the building;</li> <li>`items.poi_category` — POI category;</li> <li>`search_attributes` — information about the performed search;</li> <li>`items.name_back` — for the road sign, the localized name in the reverse direction, if available;</li> <li>`items.value_back` — for the road sign, the number of the kilometer in the reverse direction;</li> <li>`items.ev_charging_station ` — attributes for charging stations;</li> <li>`items.has_ads_model` — an indication of the presence of an advertising 3D model in the building;</li> <li>`items.has_otello_stories` — A sign that has story from Otello in the branch;</li> </ul>

Filter by the brand ID to which the company belongs.

brand_id

Filter by availability of the individual taxpayer identification number. It takes the true or false values.

has_itin

Filter by availability of photos. Takes the true or false values.

has_photos

Filter by availability of rating on flamp.ru. Takes the true or false values.

has_rating

Filter by availability of reviews on flamp.ru. Takes the true or false values.

has_reviews

Filter by availability of website. Takes the true or false values.

has_site

Filter by availability of the trading license. Takes the true or false values.

has_trade_license

Filters companies which have the opening date later than the passed parameter. Accepts values in the YYYY-MM-DD format.

opened_after_date

Filter by the ID of the organization to which the company belongs.

org_id

The ID of the category. You need to pass the option `region_id`. you can also pass a list of IDs of categories separated by commas, in this case, all the headings should be from the same region.

rubric_id

Opening hours of the company. Format: [day],[time] or now (current day and time). Examples: <ul> <li>Monday, 17:00 — `mon,17:00`</li> <li>Thursday, 9:00 — `thu,09:00`</li> <li>Today, 9:00 — `today,09:00`</li> <li>Friday, all day — `fri,alltime`</li> <li>Now `now`</li> </ul>

work_time

IP-address. IPv4 and IPv6 notations are allowed.


User coordinates in the format `lon, lat`.

location

The IDs of the buildings, separated by commas. They are used to filter objects in a building. The maximum number is 50.

building_id

The IDs of the cities separated by commas. They are used to filter objects by cities. The maximum number is 50.

city_id

The IDs of the districts, separated by commas. They are used to filter objects by district. The maximum number is 50.

district_id

Latitude of the point — center of the search area. Should be used together with the `lon` parameter. Allowed range of values: from -90 to 90 Can be used together with the `radius` parameter to filter the results in circumference.

Longitude of the point - center of the search area. Should be used together with the `lat` parameter. Allowed range of values: from -180 to 180 Can be used together with the `radius` parameter to filter the results in circumference.

Place IDs, separated by commas. Used to filter objects in the area. Maximum number is 50.

place_id

A center of the search area (point coordinates in the `lon, lat` format). It is used to filter results in circumference. The parameter conflicts with the parameters `polygon`, `point1`, `point2`.

point

The coordinates of the upper left vertex of a rectangular area limiting the search results in the `lon, lat` format. It is used to filter results in a rectangular area. The maximum distance between the points `point1` and `point2` is not more than 2 km. If the parameter `q` has been passed — the limitations are not imposed. The parameter conflicts with the parameters `point`, `polygon`.

point1

The coordinates of the lower right vertex of a rectangular area limiting the search results in the `lon, lat` format. It is used to filter results in a rectangular area. The maximum distance between the points `point2` and `point1` is not more than 2 km. If the parameter `q` has been passed — the limitations are not imposed. The parameter conflicts with the parameters `point`, `polygon`.

point2

Polygon in WKT format. It is used to filter the results in an arbitrary area. The permissible area of the polygon is ~ 6 km^2. If the q parameter is passed, no restrictions are imposed. The parameter conflicts with the parameters `point`, `point1`, `point2`.

polygon

Search radius in meters. Limitation: from 0 to 40,000 — if there is a search query (q), from 0 to 2,000 — if there is none. Default value: 250 - when combined with `point`, 0 - when combined with `lon`/`lat`. Used to filter the results in circumference.

radius

Region identifier. It is required if a geographical limit of search has not been specified. Details about the territorial division of the map into regions can be found in the description of the Regions API.


region_id

The IDs of the metro stations separated by commas. They are used to filter objects by metro stations. The maximum number is 50.

subway

The coordinates of the upper left vertex of a rectangular visibility scope, in the `lon, lat` format. The parameters `viewpoint 1` and `viewpoint 2` transmit the area of the map where the user looked before entering the request. It is used as one of the criteria for choosing where results are needed and for ranking. Does not strictly restrict the search results to the transmitted area only.

viewpoint1

The coordinates of the lower right vertex of a rectangular visibility scope, in the `lon, lat` format. The `viewpoint1` and `viewpoint2` parameters pass the map area where the user looked before entering the request. It is used as one of the criteria for choosing where results are needed and for ranking. Does not strictly restrict the search results to the transmitted area only.

viewpoint2

Specifying the method for entering the query text to the search engine:
 - ` hardware_qwerty_keyboard` — physical QWERTY keyboard
 - `on_screen_keyboard` — touch screen keyboard
  - `voice` — voice input
  - `hand_writing` — handwriting input
  - `scanning` — input that is used by people with disabilities. Using your finger or eye movements
  - `software_generated` — software-generated text
  - ʻother` — other input types


search_input_method

Specifying to the search engine that the request is complete (the user has pressed the completion button). Disables the prefix, i.e. "bank" will not be searched "banking".

search_is_query_text_complete

Specifying the search engine to use search mode near the user. Greatly increases the importance of distance from the user. Popularity, advertising and other parameters are still involved in the ranking, but to a lesser extent.

search_nearby

Type of search. Valid values: <ul> <li>`discovery` — the widest possible search with the possibility to open the linked objects (categories, corresponding to the request, will be opened before the branches that belong to them);</li> <li>`one_branch` — identical to discovery, but only one branch will be shown for a company;</li> <li>`indoor` — the configuration for high-quality search for branches in the building;</li> <li>`ads` — identical to discovery, but it will display only objects with advertising. In addition, only one branch, which if the first in the ranking, will be shown for a company;</li> <li>`discovery_partial_searcher` — identical to discovery, but it involves more options of intersection of links;</li> <li>`discovery_partial_searcher_strict` — identical to discovery_partial_searcher, but the prefix search will be disabled.</li> </ul>

search_type

Sorting of results. Valid values: <ul> <li>`distance` by increasing distance, if the `sort_point`, `point` or `location` parameter is passed (the distance is calculated from the passed point to the object geometry along the shortest path), otherwise - sorting by the object type and its area; </li> <li>`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;</li> <li>`rating` — by descending order of the rating;</li> <li>`flamp_rating` — by descending rating on Flamp;</li> <li>`creation_time` — by descending order of the date of the establishment of the company branch;</li> <li>`opened_time` — by descending order of the opening date;</li> <li>`name` — by name (alphabetically ascending).</li> </ul>

sort

The coordinates of the point from which you are sorting (the coordinates of the point in the `lon, lat` format). Deprecated parameter, the `location` parameter should be used instead.

sort_point

The types of objects among which the search is performed. When passing several types, less relevant results of some types may be crowded out by more relevant other types. Types should be comma separated. The adm_div value is an alias for all `adm_div.* types` at one and the same time. The list of available types: <ul> <li>`branch` — company branch;</li> <li>`building` — building;</li> <li>`street` — street;</li> <li>`parking` — parking lot;</li> <li>`station` — public transport stop or station;</li> <li>`station.metro` — metro station;</li> <li>`station_entrance` — the entrance to the station;</li> <li>`station_platform` — stopping platform;</li> <li>`attraction` — attraction;</li> <li>`crossroad` — crossing;</li> <li>`gate` — passage/thoroughfare;</li> <li>`road` — road;</li> <li>`route` — route;</li> <li>`adm_div` — administrative unit;</li> <li>`adm_div.country` — country;</li> <li>`adm_div.region` — region (region/province/republic, etc.);</li> <li>`adm_div.city` — city;</li> <li>`adm_div.district` — district;</li> <li>`adm_div.district_area` — district area;</li> <li>`adm_div.division` — area;</li> <li>`adm_div.living_area` — residential community, neighborhood;</li> <li>`adm_div.place` — various areal objects: parks, beaches, recreation centers, lakes and other places;</li> <li>`adm_div.settlement` — settlement;</li> <li>`coordinates` — global coordinate in the WGS84 coordinate system in `lon, lat` format;</li> <li>`coordinates_additional` — additional global coordinate in the WGS84 coordinate system in `lon, lat` format;</li> <li>`kilometer_road_sign` — kilometer road sign.</li> </ul> The list of available subtypes (`subtype`) for different types of objects can be viewed in the response schema inside items.

type

Types of geoobjects to search among. When passing multiple types, the less relevant results of some types may be replaced by the more relevant results of other types. The types are separated by commas.

The value 'adm_div `is an alias for all 'adm_div' types.* 'simultaneously.

List of available types:

* `adm_div` — administrative unit;
* `adm_div.city` — city;
* `adm_div.district_area` — district of the region;
* `adm_div.district` — district;
* `adm_div.division` — division;
* `adm_div.living_area` — residential area, neighborhood;
* `adm_div.place` — place;
* `adm_div.region` — region (region/province/republic, etc.);
* `adm_div.settlement` — locality;
* `coordinates` — global coordinate.


The types of geo-objects among which the search is performed. When passing several types, less relevant results of some types may be crowded out by more relevant other types. Types should be comma separated.

The adm_div value is an alias for all `adm_div.* types` at one and the same time.

The list of available types:

* `adm_div` — administrative unit;
* `adm_div.city` — city;
* `adm_div.region` — region (region/province/republic, etc.);
* `adm_div.district` — district;
* `adm_div.district_area` — district area;
* `adm_div.division` — area;
* `adm_div.living_area` — residential community, neighborhood;
* `adm_div.place` — place;
* `adm_div.settlement` — settlement;
* `attraction` — attraction;
* `building` — building;
`crossroad` — crossing;
* `gate` — passage/thoroughfare;
* `parking` — parking lot;
* `road` — road;
* `street` — street;
* `station_entrance`;
* `station_platform`;
* `coordinates` — global coordinate;
* `coordinates_additional` — additional global coordinate;
* `kilometer_road_sign` — kilometer road sign.


Filters objects which have been deleted later than the specified parameter. Accepts values in the YYYY-MM-DD format.

date

The IDs of categories, in which the deleted object could have been located, separated by commas.


rubrics

fias_code

The identifier of the object. May also contain a unique hash in id_hash format. It is used to generate the statistics. You can also pass multiple IDs separated by commas, but not more than 100. IDs should not be duplicated. Advertising will be chosen, if there is only one identifier in the request.

An example of a single record hasham statistics

itin

page

Number of search results displayed on one page.

page_size

Phone number, which is used for the search.

phone

Type of the service provider.

Possible values:
  - default — city service providers;
  - internet — Internet service providers;
  - all — all of the above mentioned.


servicing_group

site

trade_license

The time when the advertising weights were generated in the TIMESTAMP format

Available, if you can use color coding, for example for metro stations.

Route type. 

Possible values:

 * `bus`;
 * `trolleybus`;
 * `tram`;
 * `shuttle_bus`;
 * `metro`;
 * `suburban_train`;
 * `funicular_railway`;
 * `monorail`;
 * `river_transport`;
 * `cable_car`;
 * `light_rail`;
 * `premetro`;
 * `light_metro`;
 * `aeroexpress.

Station type. 

Possible values:

 * `stop` — ground transportation stop;
 * `railway` — railway station;
 * `metro`;
 * `river_transport`;
 * `trolleybus`;
 * `tram`;
 * `funicular_railway`;
 * `monorail`;
 * `cable_car`;
 * `light_rail`;
 * `premetro`;
 * `light_metro`.

Objects of result. 

Possible types of objects:

 * `branch` — company branch;
 * `adm_div` — administrative unit; * `building`;
 * `street`;
 * `attraction`;
 * `crossroad` — crossing;
 * `parking`;
 * `road`;
 * `gate` — passage/thoroughfare;
 * `route`;
 * `station` – stop;
 * `station_platform` — stopping platform;
 * `station_entrance` — the entrance to the station;
 * `road`;
 * `poi`;
 * `project`;
 * `coordinates` — global coordinate;
 * `coordinates_additional` — additional global coordinate;
 * `kilometer_road_sign` — kilometer road sign.

Result objects. 

Possible object types:

 * `branch` - branch.

Map object of the administrative unit type.

Belonging to the administrative territory of a higher level.

Territory name (to use it for the "share" functionality, for final points of the route, etc.).

The time when the information on the branch was added to the database.

Detailed type of administrative-territorial unit.

 Possible values:

 * `city` — a city;
 * `microdistrict` — a microdistrict;
 * `residential_district` — a residential area;
 * `residential_quarter` — a block;
 * `poselok` — a village;
 * `residential_complex` — a residential complex;
 * `selo` — a village;
 * `derevnja` — village;
 * `cottage_estate` — cottage settlement;
 * `urban_settlement` — urban-type settlement;
 * `workers_settlement` — work settlement;
 * `dacha_settlement` — country village;
 * `resort_settlement` — resort village;
 * `stanitsa` - village;
 * `sloboda` — sloboda;
 * `khutor` — farmstead;
 * `aul` — aul;
 * `aal` — aal;
 * `town` — (military) town;
 * `farmstead` — zaimka;
 * `vyselok` — settlement;
 * `municipality` — municipality;
 * `station` - station;
 * `townhouse_settlement` - settlement of townhouses;
 * `territory` — territory;
 * `cooperative` — cooperative;
 * `partnership` — partnership.

FIAS code. This field is available only for commercial API.

Federal Tax Service code. This field is available only for commercial API.

If true, it is possible to travel toward the object, if false or unavailable, then it is not.

Linked objects.

Possible values:

 * `entrances` — entry points;
 * `database_entrances` — entry points;
 * `branches` — companies;
 * `servicing` — service providers;
 * `providers`;
 * `airports`;
 * `parking` — parking lots;
 * `nearest_parking`;
 * `nearest_stations`;
 * `railway_terminals` — railway stations;
 * `bus_terminals` — bus stations;
 * `hotels`;
 * `river_ports` — river ports;
 * `seaports` — sea ports;
 * `attractions` — attractions;
 * `landmarks` — reference points.

OCATO code. This field is available only for commercial API.

OCTMO code. This field is available only for commercial API.

The coordinates of the search point specified in the WGS84 coordinate system in the lon, lat format.

A suggest corresponding to the request. The field is available only in autocomplete methods.

The ID of the object data source. If absent, the data source is 2GIS.

Summary information about the administrative unit.

Subtype of administrative unit.

Possible values:

 * `city`;
 * `settlement`;
 * `division`;
 * `district`;
 * `living_area` — neighborhood, residential community;
 * `place`;
 * `district_area` — district area;
 * `region` - region (region/province/republic, etc.).

Localized name of the type of settlement (only for subtype = settlement).

Type of object. 

Possible values:

 * `adm_div` — administrative unit.

adm_div

Belonging to the administrative territory.

Attraction name (to use it for the "share" functionality, for final points of the route, etc.).

External content. Additional data such as data about pictures.

Parameters of the search result. It is only returned in search methods of the version 3.0.

Localized name of the type of attraction.

Type of object. 

Possible values:

 * `attraction`.

attraction

Address where a company branch is located.

Clarification on the branch location at the specified address.

Presentation of the address field as a single string.

Number of employees in the company. This field is available only for commercial API. 

Available options:

 * no data
 * up to 15
 * 16-100
 * 101-250
 * 251-1000
 * more than 1000

Information about floors of the building.

Address view as a single line with indication of the city.

An attribute of availability of information on apartments in the building

Individual taxpayer identification number. This field is available only for commercial API.

Full proper name of the branch or a company name.

Link to pay for parking (diplink to another app, website).

Description of the purpose of the building.

A set of blocking attributes that match the query.

The data on the number of apartments and the material the building is made of. This field is available only for commercial API.

Timezone offset in minutes with respect to UTC0.

The license of the branch. This field is available only for commercial API.

Type of object. 

Possible values:

 * `branch` — company branch.

branch

Number of companies in the building for which you can write reviews on flamp.ru

Building name (to use it for the "share" functionality, for final points of the route, etc.).

Type of object. 

Possible values:

 * `building`.

building

Type of object. 

Possible values:

 * `coordinates` — global coordinate;
 * `coordinates_additional` — additional global coordinate.

coordinates

Crossing name (to use it for the "share" functionality, for final points of the route, etc.).

Type of object. 

Possible values:

 * `crossroad` — crossing.

crossroad

The maximum value of the attribute available in the sampling.

The minimum value of the attribute available in the sampling.

Map object of the passage/thoroughfare type.

Accessibility. 

Possible values:

 * `public`;
 * `paid`;
 * `restricted` — for official use only.

Comment about availability. For example, there may be specified a cost for the paid passage.

Type of enclosure. 

Possible values:

 * `gate`;
 * `gate_barrier` — lifting gate;
 * `turnstile` — turnstile;
 * `wicket` — small gate.

Full name of the passage or thoroughfare.

Description of the passage or thoroughfare.

Type of passage or thoroughfare. 

Possible values:

 * `main`;
 * `additional`;
 * `service`.

Type of object. 

Possible values:

 * `gate` — passage/thoroughfare.

gate

Element identifiers from the extended result context.

Precision of the found address:

 * `none` - the address is not recognized;
 * `other` - the street is not found, but the city/village, etc. is found. 
 * `street` - the street is found, but the house is not found;
 * `near` - the house number is not found, but the house with a close number on the same street is found;
 * `number` - the house with the correct number, but different building/corpus number is found;
 * `exact` - the house with the correct number and building/corpus number is found.

External source of the result.

 * 0 - None, the result is internal;
 * 1 - AiVectorSearch, the result is obtained from AI vector search service.

A geo object of the kilometer road sign type.

A localized name that includes the kilometer number, unit of measurement, and the name of the highway/street.

Localized name in the back direction if available.

The coordinates of the point specified in the WGS84 coordinate system in the lon, lat format.

Type of object. 

Possible values:

 * `kilometer_road_sign`.

The number of the kilometer in the back direction.

kilometer_road_sign

Number of company branches in this metacategory.

Short caption for the icon to be displayed in the UI.

Number of geo objects in this metacategory.

Number of companies in this metacategory.

A search string that is put in a search string and that is passed to the query to generate the search results.

The ID of a metacategory the branches of which it is necessary to find.

Type of access. 

Possible values:

 * `public`;
 * `handicapped_only` — only for persons with disabilities;
 * `customers_only` — only for clients;
 * residents_only — only for residents;
 * `taxi_only` — only for taxi.

Comment about payment, additional restrictions, etc.

Address of the building where the parking lot is located.

Parking lot name (to use it for the "share" functionality, for final points of the route, etc.).

Comment. The field is meant for specifying any additional information about the parking lot.

Type of parking coverage:

 * `asphalt`;
 * `concrete`;
 * `gravel`;
 * `unpaved`.

Purpose of parking lot. 

Possible values:

 * `car` — for cars;
 * `bike` — for bicycles;
 * `motorbike` — for motorcycles/mopeds.

Type of parking lot. 

Possible values:

 * `ground` — surface;
 * `underground`;
 * `multilevel`.

The time zone of the object in POSIX format.

Type of object. 

Possible values:

 * `parking`.

parking

Type of object. 

Possible values:

 * `project`.

project

Road name (to use it for the "share" functionality, for final points of the route, etc.).

Object type.

\Possible values:

 * `road`.

road

Object name (to use it for the "share" functionality, for final points of the route, etc.).

Route color, if any. For example, for metro lines. Format: "#rrggbb

The name of the starting point of the route.

Object type.

Possible values:

 * `route`.

route

An attribute indicating that the query requires the closest objects.

A sign that the most relevant result was found by a partial match.

An attribute indicating that the query requires objects not sensitive to the distance. For example, delivery.

Stopping point name (to use it for the "share" functionality, for final points of the route, etc.).

Linked objects. 

Possible values:

 * `entrances` — the entrances to the station;
 * `database_entrances` — entry points;
 * `nearest_stations` — stops nearby, including the connections to other metro stations, apart from the station linked to the entrance; * `nearest_platforms` — nearest stopping platforms.

Transport routes passing through the station or stop.

Search for branches by trade license