Suggests. /3.0/suggests

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.contact_groups` — the company's contact details;</li> <li>`items.schedule` — opening hours of the 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.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.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.fns_code` — FIAS code of streets and administrative territories (additional permission is required from the API key);</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.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>`search_attributes` — information about the performed search.</li> <li>`items.purpose_code` — code of the purpose of the building;</li> <li>`items.ads.options` — advertising options;</li> <li>`items.poi_category` — POI category;</li> <li>`items.marker_alt` — relative height of marker placement;</li> <li>`items.search_query` — search string that is put in a search string to generate search results (this field is available only for objects with type `metarubric`);</li> </ul>

fields

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

User location (coordinate format: `lon, lat`).

location

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. 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 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. <brThe 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

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

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. The types should be comma separated. The list of available types: <ul> <li>`adm_div.district` — district;</li> <li>`adm_div.district_area` — district area;</li> <li>`adm_div.settlement` — settlement;</li> <li>`adm_div.city` — city;</li> <li>`adm_div.country` — country;</li> <li>`adm_div.region` — region (region/province/republic, etc.);</li> <li>`adm_div.place` — place;</li> <li>`adm_div.living_area` — neighborhood, residential community;</li> <li>`adm_div.division` — area;</li> <li>`building` — building;</li> <li>`station` — stop;</li> <li>`street` — street;</li> <li>`attraction` — attraction;</li> <li>`crossroad` — intersection;</li> <li>`station.metro` — metro station;</li> <li>`station_entrance`;</li> <li>`branch` — company branch office;</li> <li>`rubric` — category;</li> <li>`meta_rubric` — metacategory;</li> <li>`attribute` — additional attribute;</li> <li>`route` — route;</li> <li>`route_type` — route type;</li> <li>`road` — road;</li> <li>`parking` — parking lot;</li> <li>`org` — company;</li> <li>`coordinates` — global coordinate;</li> <li>`special` — special;</li> <li>`market.category` — product categories. Requires market.suggestor_category;</li> <li>`market.suggestor_category` — required to open product categories;</li> <li>`market.attribute` — product names;</li> <li>`market.brand` — products brand;</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

The type of tips to use. Available types: <ul> <li>`route_endpoint` — perfect for a quick search of final objects of the route. All the results have id and coordinates;</li> <li>`rubric` — category tips;</li> <li>`places` - place tips;</li> <li>`address` - address tips;</li> <li>`global_address` — alias of `address`. Deprecated type, you need to use `address` instead;</li> <li>`city_selector` — settlement suggests. Can be used without specifying a project;</li> <li>`object` — tips on directory objects (categories, companies, streets, cities, etc.); <li>`default` - used by default (object).</li> </ul>

suggest_type

One or more types of used suggester.

Available types:
 - route_endpoint — is perfect for a quick search of final objects of the route. All the results have id, and coordinates;
 - street — street suggests;
 - rubric — category suggests;
 - places — place suggests;
 - attribute — suggests for additional attributes;
 - address — address suggests;
 - global_address — alias of `address`. Deprecated type, you need to use `address` instead;
 - global — alias of default;
 - city_selector — settlement suggests. Can be used without specifying a project;
 - object — object suggester. If any object is clearly defined in the result, it will be added to a collection as a directory object;
 - default.

One or more types of suggests. The list of available types of suggests: <ul> <li>`adm_div.district` — district;</li> <li>`adm_div.district_area` — district area;</li> <li>`adm_div.settlement` — settlement;</li> <li>`adm_div.city` — city</li>;<li>`adm_div.country` — country;</li> <li>`adm_div.region` — region (region/province/republic, etc.);</li> <li>`adm_div.place` — place ;</li> <li>`adm_div.living_area` — neighborhood, residential community;</li> <li>`adm_div.division` — area;</li> <li>`building` — building;</li> <li>`station` — stop;</li> <li>`street` — street;</li> <li>`attraction` — attraction;</li> <li>`crossroad` — crossing;</li> <li>`station.metro` — metro station;</li> <li>`branch` — company branch;</li> <li>`rubric` — category;</li> <li>`meta_rubric` — metacategory;</li> <li>`attribute` — additional attribute;</li> <li>`route` — route;</li> <li>`route_type` — route type;</li> <li>`road` — road;</li> <li>`parking` — parking lot;</li> <li>`org` — company;</li> <li>`coordinates` — global coordinate;</li> <li>`special` — special;</li> <li>`discount` — discounts;</li> <li>`user_queries` — user suggest;</li> <li>`kilometer_road_sign` — kilometer road sign.</li> </ul>

types

Number of search results displayed on one page.

page_size

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`.

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.

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

Field set describing additional attribute

Unique identifier of the additional attribute.

Set of attributes of the performed search.

attribute

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.

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

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.

Advertising materials of the default branch.

The time when the information about the default branch was created in the database.

The time zone of the object in POSIX format.

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`.

Type of object. 

Possible values:

 * `parking`.

parking

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

Number of company branches in this category.

The key word by which the category has been found.

Type of object. 

Possible values:

 * `rubric`.

rubric

user_query

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.

Object type.

Possible values:

 * `station`.

station

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

Type of object. 

Possible values:

 * `street`.

street

Object with the description of a tip that affect the display

The unique identifier of the building to which this address is linked.

Building name (in the address for branches).

An array of address components. 

Possible values:

 * `street_number` — typical address;
 * `number` — only building number;
 * `location` — generic description.

The name of the location to which the building relates.

A verbal description of the structure location.

Building number, including fractions and letters. It may be a proper name, if it is used like this.

number

Building number, including fractions and letters.

street_number

The ID of the administrative unit object.

Is filled in only for type=city and takes a single true value if the city is the main city of the current project (e.g. Novosibirsk).

The ID of the administrative unit object. 

Possible values:

 * `city`;
 * `settlement`;
 * `division`;
 * `district`;
 * `living_area` — neighborhood, residential community;
 * `place`;
 * `district_area`;
 * `region` – region/province/republic, etc;
 * `country`

A list of actions for external advertising resources.

Advertising materials for donors of APP ("Advertisement in Partners' Profiles").

Advertising materials for the owner of the owned category.

Advertising materials for donors of FMCG.

Advertising materials for the owner of FMCG.

Contains full name (for sole proprietor) or name (for legal entity), form of ownership (sole proprietor, LLC, etc.).

An indication that a branch or organization has stories.

Indicates the presence of an advertising poi on the map.

Unique identifier of the object of attraction.

A list of additional attributes in this group.

A sign that is there is an intersection between the context categories and the categories of additional attributes of this group.

A sign that is there is an intersection between the primary categories of the branch and the categories of additional attributes of this group.

Name of the group of additional attributes.

An array of IDs of categories linked to a group of additional attributes

Alias of the city, where the object is located.

The key describes the value of the workload score for which time intervals and days are set. Acceptable score values: 1 - 10. Not all points may be present in the data.

The key describes the day of the week for which the intervals with the specified score are presented. Acceptable values: "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun".

The values of the intervals are 0 - 23. (0 — from 0 to 1, 23 - from 23 to 24 hours).

Contact value for displaying on the screen.

Type of contact.

Possible values:

 * `email`;
 * `website`;
 * `phone`;
 * `fax`;
 * `icq`;
 * `jabber`;
 * `skype`;
 * `vkontakte`;
 * `twitter`;
 * `instagram`;
 * `facebook`;
 * `pobox`;
 * `youtube`;
 * `odnoklassniki` — ok.ru;
 * `googleplus`;
 * `linkedin`;
 * `pinterest`;
 * `whatsapp`;
 * `telegram`;
 * `viber`;
 * `jivo`.

A distance to a certain point in meters. It is calculated with respect to the point specified in the request in `point` or `sort_point` parameter, and in passed parameter `sort=distance`.

Whether the object is within the boundaries of the sorting.

The code of the group of service providers.

The codes of groups of service providers.

The date when a company was open in the ISO 8601 format.

The date when a company was deleted from the database in the ISO 8601 format.

The date when company data was last updated in the ISO 8601 format.

An object describing properties of the company's delivery

Contact telephone number of the company for order placement

Unique 64-bit identified of the route direction (subroute).

The sequence of stopping platforms of the route.

Route direction.

Possible values:

 * `forward` — going forward;
 * `backward` — going backward;
 * `additional` — optional direction;
 * `circular` — a circular route with a final stop;
 * `loop` — circular route with no final stop.

Geometry of the area used to determine whether the cursor is in the object zone.

Stop ID. Format: #rrggbb, hexadecimal record.

Permission to send an email to the company.

email address a user should use to send emails to the company.

Additional data of the branch, such as booklets and photos.

Album code.

Possible values:

 * `common`;
 * `view`;
 * `facilities`.

A URL of the main photo of the branch in 2GIS business listings.

Type of booklet.

Possible values:
 * `buildings`;
 * `saunas`.

A title of the personal page of the branch in 2GIS business listings.

An address of the personal page of the branch in 2GIS business listings.

A code of the personal page of the branch in 2GIS business listings.

URL of the main photo of the branch discounts in 2GIS business listings.

Address of the branch discounts in 2GIS business listings.

Code of the branch discounts in 2GIS business listings.

Is filled in only for type=city and takes a single true value if the city is the main city of the current project (e.g. Novosibirsk)