/3.0/markers

Additional fields to be displayed in the response.

List of available fields:

 * `items.rubric_ids` — known rubric identifiers for the object;
* `items.floor_id` — floor ID;


fields

The additional fields that you want to display in the response, separated by commas. The list of available fields:: <ul> <li>`items.name` — object name;</li> <li>`items.org` — a company to which the branch belongs;</li> <li>`items.context` — dynamic information;</li> <li>`items.stop_factors` — a set of blocking attributes that match the query;</li> <li>`items.schedule` — opening hours;</li> <li>`items.reviews` — statistics on reviews;</li> <li>`items.temporary_unavailable_atm_services` — indication of the presence of non-functioning services at the ATM or terminal;</li> <li>`items.name_back` — revealed name in the reverse direction, if available;</li> <li>`items.value_back` — kilometer number in the reverse direction;</li> </ul>

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

User coordinates in the format `lon, lat`.

location

The height in pixels for the DOM object that displays the map.

map_height

The width in pixels for the DOM object that displays the map.

map_width

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

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

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 ascending order of the distance. If the `sort_point`, `point` or `location` parameter has been passed, the distance is calculated up to the center of the areal map objects (cities, districts, etc.) and by the shortest distance to the line (street) Otherwise - by the type of object 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>`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

page

Number of search results displayed on one page.

page_size

Type of object. 

Possible values:

 * `coordinates` — global coordinate.

coordinates

Coordinate marker

The ID of the geometry to which the marker belongs.

Object marker

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

Timezone offset in minutes with respect to UTC0.

A zoom calculated on the basis of viewpoint and the screen size.

A sign that the list of results has been created based on only a part of possible results.

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.

A set of blocking attributes that match the query.

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)

Is filled in only for type=adm_div, subtype=city|settlement and takes a single true value if the settlement is a district center.

Is filled in only for type=adm_div, subtype=city|settlement and accepts a single true value if the settlement is a regional center.

Whether there are pictures for the object.

A string whose presence indicates that the branch is temporarily not working. The line shows the code of the reason for closing.

Further information on temporarily closed branch.

A list of actions for external advertising resources.

Additional information about the name of the branch that needs to be shown in an open card.

A text reflecting the purpose of the CTA. If this field is available, it should be used as the text on the button.

Action name. If the field is unavailable, use the common localized phrase "Find out more".

Type of action.

Possible values:

 * link — web link;
 * phone — call by specified phone number;
 * callback — a callback request;
 * open_card — opening of a card of a directory object;
 * search_by_org – find all the branches of a company;
 * search_by_rubric – find all the branches of a category;
 * search_by_query — search by text; * search_buy_here — expand donors list of buy here; * search_by_meta_rubric - find all branches of metacategory; * miniapp_yclients - running miniapp yclients, only inside buy_here, is added to the end of the list; * miniapp_otello - running miniapp otello, only inside buy_here, is added to the end of the list.

Correspondence of types of action and the values of the value field:
 * link — the URL of the page you need to open;
 * phone — phone number in the +<digits without separators> format;
 * callback — the URL of the page where you need to send data to request a callback;
 * open_card — the ID of the directory object the card of which you need to open;
 * search_by_org — the ID of the company the branches of which you need to find;
 * search_by_rubric — the ID of the category, the branches of which you want to find;
 * search_by_query – the text of the query by which you need to search; * search_buy_here – list of AdsId from the array objects of the buy_where_owner option, separated by commas; * miniapp_yclients - data for launching the miniapp yclients; * miniapp_otello - data for launching the miniapp otello.

Description of the properties of the company.

A URL for registering the business connection of the profile views.

Total number of reviews (including reviews without text)

Whether it is necessary to show reviews for the entire company by default, instead of a single branch. Takes the true value if each branch of the company, that have the reviews activated, has more than 50% of the categories from the list.

Whether it is possible to display reviews for this branch, and add new reviews.

The average rating of the company. It is calculated as the average of the ratings of the branches.

The total number of reviews of the organization (the sum of the `general_review_count_with_stars` field for all branches)

Whether it is allowed to display reviews for this object, and add new reviews.

Whether it is allowed to post reviews for this object on Flamp.

The start date of the schedule changes work. Format: "YYYY-MM-DD"

End date changes in the schedule. Format: "YYYY-MM-DD"

The localized description of possible changes in opening hours. Used for holidays, time constraints, etc.

A sign that the company is open around the clock 7 days a week. If the field is absent, the company is not considered to be open 24 hours.

The area from which the data has been collected, in order to request the new data when leaving it.

The preferred rectangular area for displaying results on the map. The results may be outside of this area.

Informs if the text is suggested:

 * true - the text was generated by the prompter;
 * false-the text corresponds to a part of the query.

2GIS API Support

The directory of object markers

Returns a collection of markers satisfying the parameters passed in the request.
A marker is a representation of an object on the map, so only an object with coordinates can be a marker.
