/2.0/geo/get

Additional fields to display in the response are separated by commas. <br>List of available fields: <ul> <li>`items.adm_div` — administrative division;</li> <li>`items.address` — address where the organization's branch is located;</li> <li>`items.address.is_conditional` — flag for "conditional address";</li> <li>`items.full_address_name` — the same as address_name, but with the city;</li> <li>`items.floors` — number of floors;</li> <li>`items.attraction` — description of the attraction;</li> <li>`items.statistics` — summary information about the geo object;</li> <li>`items.level_count` — number of Parking levels;</li> <li>`items.capacity` — Parking capacity;</li> <li>`items.description` — description of the geo object;</li> <li>`items.context` — dynamic information;</li> <li>`items.access_name` — localized name of the access type;</li> <li>`items.is_paid` — whether Parking is paid;</li> <li>`items.for_trucks` — truck parking;</li> <li>`items.paving_type` — type of parking paving;</li> <li>`items.access` — type of access for Parking;</li> <li>`items.access_comment` — localized name for the access type;</li> <li>`items.schedule` — work schedule for a geo object (for example, for Parking);</li> <li>`hash` — base hash;</li> <li>`items.stat` — data for generating statistics messages;</li> <li>`search_attributes` — information about the search performed;</li> <li>`items.geometry.selection` - geometry for selecting the object;</li> <li>`items.geometry.hover` — geometry of the area used to determine whether the cursor is in the area of the object.</li> <li>`items.geometry.style` - ID of the style to display;</li> <li>`items.geometry.centroid` — visual center of the object geometry;</li> <li>`items.region_id` — unique project ID;</li> <li>`items.links` - related objects;</li> <li>`items.external_content` — additional branch data, such as booklets and photos;</li> <li>`items.is_routing_available` - flag for whether travel to the object is possible;</li> <li>`items.group` — objects linked to the combined card;</li> <li>`items.reviews` — statistics on branch reviews;</li> <li>`items.is_main_in_group` — indicates that this is the main object in the hybrid object group;</li> <li>`items.city_alias` — alias of the city, where the object is located;</li> <li>`items.detailed_subtype` — detailed type of administrative-territorial unit;</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>

fields

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

has_photos

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

viewpoint2

Type filter geoobjects, the types should be comma separated. <br>the Value `adm_div` is an alias for all types of `adm_div.*` at the same time. <br>List of available types: <ul> <li>`adm_div` — an administrative unit;</li> <li>`adm_div.city` is a city;</li> <li>`adm_div.district` is a district;</li> <li>`adm_div.division` is a district;</li> <li>`adm_div.living_area` — zhilmassiv neighborhood;</li> <li>`adm_div.place` place;</li> <li>`adm_div.settlement` — place;</li> <li>`adm_div.district_area` is a district of the region;</li> <li>`adm_div.region` is the region (oblast/Krai/Republic, etc.);</li> <li>`attraction` is a tourist attraction;</li> <li>`building` building;</li> <li>`crossroad` — intersection;</li> <li>`gate` — the passage/the passage.</li> <li>`parking` — parking;</li> <li>`poi` — POI;</li> <li>`road` — road;</li> <li>`street` — street;</li> <li>`kilometer_road_sign` — kilometer road sign.</li> </ul>

type

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.

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

Presentation of the address field as a single string.

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

Information about floors of the building.

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

Description of the purpose of the building.

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

Type of object. 

Possible values:

 * `building`.

building

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

Type of object. 

Possible values:

 * `crossroad` — crossing.

crossroad

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

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

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

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.

Timezone offset in minutes with respect to UTC0.

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

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.

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

Type of object. 

Possible values:

 * `street`.

street

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.

A verbal description of the structure location.

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`

Unique identifier of the object of attraction.

Alias of the city, where the object is located.

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.

A set of blocking attributes that match the query.

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.

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)

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.

The identifier of a default floor to be displayed on the map when showing floors of the building.

An array of floors of the building. Sorting: from the lower floors to the top ones.

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

A sign that it is the main object in the group of the hybrid objects.

Subtype of the merged object. 

Possible values:

 * `place`;
 * `stop` — public transport stop;
 * `railway` – railway station;
 * `metro` – subway station;
 * `river_transport` — river port;
 * `trolleybus`;
 * `tram`;
 * `funicular_railway`;
 * `monorail`;
 * `cable_car`;
 * `light_rail`;
 * `premetro`;
 * `light_metro.

Type of object.

Possible values:

 * `branch`;
 * `building`;
 * `attraction`;
 * `adm_div` — administrative division of territories;
 * `station`;
 * `station_platform`;
 * `station_entrance`.

Number of branches for which you can write a review on flamp.ru.

Information about the apartments in the building.

Number of the building to which the entrance is linked. Unloaded only when the entrances to residential buildings have their own individual addresses.

Number of entrance to residential building.

If available and equal to true, then POI is displayed for this entrance.

Unavailable for entrances without apartments. Must be identical for entrances with the same name.

If available and equal to true, the entrance is displayed in the list of entrances.

Unavailable for entrances with complex geometry.

Number of the last apartment of the range.

Number of the first apartment of the range.

A positive value of the number change step, it is 1 by default.

Number of the entrance to the station, if the object is an entrance.

Distance from the described object to the nearest stopping platform of this stop in meters.

Unique identifier of the reference point.

A stop ID for the "stopping platform", "metro entrance" types.

Subtype of the object. Use `place` for a place. For the stopping platform use the list of possible subtypes:

 * `stop` — public transport stop;
 * `railway` – railway station;
 * `metro` – subway station;
 * `river_transport` — river port;
 * `trolleybus`;
 * `tram`;
 * `funicular_railway`;
 * `monorail`;
 * `cable_car`;
 * `light_rail`;
 * `premetro`;
 * `light_metro`.

Type of the object.

Possible values:

 * station_platform — stopping platform;
 * station_entrance — the entrance to the station;
 * building;
 * branch — company branch;
 * adm_div — administrative unit.

The distance from the described object to the nearest metro station in meters.

Additional comment to the name of the stop, such as the name of the metro line (or lines), to which the station is linked.

Icon. Present if there are routes passing through the platform.

An array of types of transport passing through this stop.

The type of transition. 

Possible values:

 * `ground` — ground;
 * `underground` — underground;
 * `direct` — direct accessibility, from one station you immediately get to another.

Whether there is an underground connection with this station from the described object.

Parking lot capacity (number of parking spaces).

The ID of a separate parking lot object, is any.

Purpose of parking lot.

Possible values:

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

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

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.

Type of category.

Possible values:

 * primary — main;
 * additional;
 * geo.

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.

The algorithm used to choose advertising.

Number of buildings belonging to the object.

Number of apartments in a residential building. This field is available only for commercial APIs.

The category of the cultural heritage object. This field is available only for commercial API.

The name of the cultural heritage object. This field is available only for commercial API.

Number of elevators. This field is available only for commercial API.

The type of floors. This field is available only for commercial API.

Type of gas supply. This field is available only for commercial API.

The fact that the house is recognized as an emergency. This field is available only for commercial API.

Designation of the material the building is made of. This field is available only for commercial API.

Number of entrances in a residential building. This field is available only for commercial APIs.

Series/project of construction. This field is available only for commercial API.

Year of construction. This field is available only for commercial API.

2GIS API Support

Directory of map objects

Displays detailed information about the map object by its unique identifier.

Basic hash consisting of 16 characters. It is used to generate statistics and display advertising options.