/2.0/geo/get
Directory of map objects (2.0)
2GIS API Support: api@2gis.ru URL: https://docs.2gis.com/
Getting information about map object
Displays detailed information about the map object by its unique identifier.
query Parameters
key required | string A unique key of API user. |
id required | string Map object ID. |
hash | string Basic hash consisting of 16 characters. It is used to generate statistics and display advertising options. |
locale | string The locale with which the search is performed and given results. |
fields | Array of strings Additional fields to display in the response are separated by commas.
|
Responses
Response Schema: application/jsonapplication/jsontext/xml
application/json
application/json
text/xml
required | object (ObjMeta) Response metadata |
required | object Main result |
https://catalog.api.2gis.com/2.0/geo/get
Response samples
- 200
- 400
- 403
- 404
- 500
Content type
application/json
application/json
text/xml
{- "result": {
- "total": 1,
- "items": [
- {
- "id": "141806935212033",
- "type": "adm_div",
- "region_id": "1",
- "segment_id": "123456",
- "full_name": "string",
- "subtype_specification": "string",
- "external_content": [
- {
- "type": "photo_album",
- "subtype": "common",
- "count": 3,
}
], - "oktmo": "35",
- "attraction": {
- "id": "141806935212033",
- "subtype_name": "string",
- "name": "string",
- "description": "string",
- "dates": "string",
- "authors": "string"
}, - "geometry": {
- "hover": "POLYGON((36.193851601974 51.7466070840044,36.1943391434488 51.7466070840044,36.1943391434488 51.7474670961949,36.193851601974 51.7474670961949,36.193851601974 51.7466070840044))",
- "selection": "POINT(83.306820839303 54.6230101954005)",
- "centroid": "POINT(83.306820839303 54.6230101954005)"
}, - "context": {
- "distance": 0
}, - "statistics": {
- "filials_count": 1,
- "area": 0,
- "length": 0,
- "building_count": 0
}, - "adm_div": [
- {
- "id": "123456",
- "type": "city",
- "caption": "string",
- "name": "Ust-Kamenogorsk",
- "is_default": true,
- "flags": {
- "temporary_closed": "string",
- "temporary_closed_parameters": [
- {
- "type": "string",
- "value": "string",
- "name": "string"
}
], - "has_model": { },
- "photos": true,
- "is_default": true,
- "is_region_center": true,
- "is_district_area_center": true
}, - "city_alias": "novosibirsk",
- "detailed_subtype": "poselok"
}
], - "fns_code": "35",
- "links": {
- "entrances": [
- {
- "id": "123456",
- "geometry": {
- "vectors": [
- "string"
], - "normals": [
- "string"
], - "points": [
- "string"
]
}, - "entity_number": "string",
- "is_primary": true,
- "entity_name": "string",
- "comment": "string",
- "is_visible_on_map": true,
- "is_visible_in_ui": true,
- "entrance_display_name": "string"
}
], - "attractions": [
- {
- "id": "123456",
- "authors": "string",
- "dates": "string",
- "description": "string",
- "subtype_name": "Fountain",
- "name": "Fountain in Narymsky public garden"
}
], - "seaports": {
- "items": [
- {
- "id": "123456",
- "additional_info": "Marine Glory square, 1",
- "name": "Marine passenger terminal"
}
], - "count": 0
}, - "parking": [
- {
- "id": "123456",
- "name": "Underground Parking, Sun City",
- "purpose": "string",
- "capacity": "string",
- "is_paid": true,
- "comment": "50 rub per hour, first 2 hours free."
}
], - "airports": {
- "count": 0,
- "items": [
- {
- "id": "123456",
- "name": "Tolmachevo airport",
- "additional_info": "Airport, Ob-4"
}
]
}, - "database_entrances": [
- {
- "id": "123456",
- "has_poi": true,
- "is_visible_on_map": true,
- "apartments_info": {
- "calculated": true,
- "floors": [
- {
- "name": null,
- "apartments": null
}
]
}, - "is_visible_in_ui": true,
- "comment": "string",
- "entity_name": "string",
- "entity_number": "string",
- "building_number": "string",
- "is_primary": true,
- "geometry": {
- "vectors": [
- "string"
], - "normals": [
- "string"
], - "points": [
- "string"
]
}, - "entrance_display_name": "string",
- "relative_geometry": {
- "dy": 0,
- "direction": 0,
- "dx": 0
}, - "name": "string"
}
], - "nearest_platforms": [
- {
- "id": "123456",
- "transition_type": "string",
- "heading_to": "Nakhabino",
- "name": "Krasniy Prospekt metro station",
- "comment": "Leninskaya line",
- "color": "#D10000",
- "route_logo": "string",
- "route_types": [
- "string"
]
}
], - "providers": {
- "count": 1,
- "allowed_for_reviews_count": 0,
- "items": [
- {
- "id": "123_24J2I19H1J0fghdw7GJ0JJ16153",
- "org_id": "string",
- "name": "string",
- "additional_info": "string",
- "contacts": [
- {
- "type": null,
- "comment": null,
- "url": null,
- "value": null,
- "text": null,
- "print_text": null
}
]
}
]
}, - "bus_terminals": {
- "count": 0,
- "items": [
- {
- "id": "123456",
- "name": "Bus station, Novosibirsk",
- "additional_info": "Krasnyy Prospekt, 4"
}
]
}, - "servicing": {
- "count": 1,
- "allowed_for_reviews_count": 0,
- "items": [
- {
- "id": "123_24J2I19H1J0fghdw7GJ0JJ16153",
- "org_id": "string",
- "name": "string",
- "additional_info": "string",
- "contacts": [
- {
- "type": null,
- "comment": null,
- "url": null,
- "value": null,
- "text": null,
- "print_text": null
}
]
}
]
}, - "landmarks": [
- {
- "id": "123456",
- "type": "station_platform",
- "subtype": "string",
- "station_id": "123456",
- "name": "string",
- "entrance_display_name": "string",
- "distance": 0,
- "azimuth": 360
}
], - "river_ports": {
- "count": 0,
- "items": [
- {
- "id": "123456",
- "additional_info": "Leningrad highway, 51",
- "name": "Moscow North river terminal"
}
]
}, - "nearest_stations": [
- {
- "id": "123456",
- "route_types": [
- "string"
], - "route_logo": "string",
- "internal_transition": true,
- "name": "Krasniy Prospekt metro station",
- "comment": "Leninskaya line",
- "distance": 0,
- "entrance": {
- "id": "123456",
- "geometry": {
- "hover": "POLYGON((36.193851601974 51.7466070840044,36.1943391434488 51.7466070840044,36.1943391434488 51.7474670961949,36.193851601974 51.7474670961949,36.193851601974 51.7466070840044))",
- "selection": "POINT(83.306820839303 54.6230101954005)",
- "centroid": "POINT(83.306820839303 54.6230101954005)"
}, - "name": "string",
- "entrance_display_name": "string"
}, - "color": "#D10000"
}
], - "nearest_parking": [
- {
- "id": "123456"
}
], - "hotels": {
- "items": [
- {
- "id": "123456",
- "name": "Aquarius, Motel",
- "additional_info": "Mira St, 18a bld1"
}
], - "count": 0
}, - "nearest_metro": [
- {
- "id": "123456",
- "distance": 500
}
], - "railway_terminals": {
- "items": [
- {
- "id": "123456",
- "additional_info": "Shirokaya Street, 26a",
- "name": "Novosibirsk-Western, railway station"
}
], - "count": 0
}, - "branches": {
- "count": 1,
- "allowed_for_reviews_count": 0,
- "items": [
- {
- "id": "123_24J2I19H1J0fghdw7GJ0JJ16153",
- "org_id": "string",
- "name": "string",
- "additional_info": "string",
- "contacts": [
- {
- "type": null,
- "comment": null,
- "url": null,
- "value": null,
- "text": null,
- "print_text": null
}
]
}
]
}
}, - "rubrics": [
- {
- "id": "123456",
- "name": "string",
- "alias": "string",
- "parent_id": "123456",
- "kind": "string"
}
], - "description": "string",
- "okato": "35",
- "point": "54.991984,82.901886",
- "name": "string",
- "city_alias": "novosibirsk",
- "sources": [
- "string"
], - "search_attributes": {
- "suggested_text": "string",
- "suggest_parts": [
- {
- "text": "string",
- "is_suggested": true
}
]
}, - "detailed_subtype": "poselok",
- "fias_code": "dcb1bc1b-2324-449a-8b68-03e49ba1f541",
- "reviews": {
- "items": [
- {
- "tag": "string",
- "is_reviewable": true
}
], - "general_rating": "4.73",
- "general_review_count": 0,
- "general_review_count_with_stars": 0,
- "is_reviewable": true,
- "is_reviewable_on_flamp": true
}, - "locale": "ru_RU",
- "dates": {
- "deleted_at": "2013-06-01T11:43:03.273144+07:00",
- "created_at": "2012-04-18T12:08:03.273144+07:00",
- "updated_at": "2012-06-18T11:43:03.273144+07:00"
}, - "flags": {
- "temporary_closed": "string",
- "temporary_closed_parameters": [
- {
- "type": "string",
- "value": "string",
- "name": "string"
}
], - "has_model": { },
- "photos": true,
- "is_default": true,
- "is_region_center": true,
- "is_district_area_center": true
}, - "is_routing_available": true,
- "caption": "string",
- "subtype": "string"
}
]
}, - "meta": {
- "issue_date": "string",
- "code": 200,
- "api_version": "dev"
}
}