Get region by id
Directory of regions (2.0)
2GIS API Support: api@2gis.ru URL: https://docs.2gis.com/
Getting information about a region
Displays detailed information about the region by its unique identifier.
query Parameters
key required | string A unique key of API user. |
id required | string Region ID. Conflicts with |
branch_id required | string Branch ID. Conflicts with |
fields | Array of strings Additional fields that should be displayed in the response, comma separated.
|
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/region/get
Response samples
- 200
- 400
- 403
- 404
- 500
Content type
application/json
application/json
text/xml
{- "result": {
- "total": 1,
- "items": [
- {
- "id": "123456",
- "type": "region",
- "zoom_level": {
- "max": 22,
- "min": 22
}, - "online_languages": {
- "default_lang": "string",
- "available": "string"
}, - "name_grammatical_cases": {
- "dative": "to Novosibirsk",
- "genitive": "of Novosibirsk",
- "prepositional": "in Novosibirsk",
- "accusative": "Novosibirsk"
}, - "time_zone": {
- "name": "Asia/Novosibirsk",
- "offset": 240
}, - "seo": {
- "title": "string",
- "description": "string"
}, - "statistics": {
- "route_count": 0,
- "rubric_count": 0,
- "org_count": 0,
- "branch_count": 0
}, - "locale": "ru_RU",
- "country_code": "st",
- "name": "Moscow",
- "domain": "ru",
- "flags": {
- "parking_layer": true,
- "pedestrian_routing": true,
- "public_transport": true,
- "traffic": true,
- "flamp": true,
- "2gis_reviews": true,
- "metro": true,
- "road_network": true,
- "gdpr": true,
- "has_net_booklet": true,
- "truck_graph": true
}, - "uri_code": "nnovgorod",
- "settlements": [
- "string"
], - "tips_languages": "{\"ru\": \"ru\"}",
- "uri_aliases": [
- "string"
], - "code": "nnovgorod",
- "locales": "ru_RU",
- "bounds": "POLYGON((83.4457915421126 53.4866943332863,84.0879338133862 53.4866943332863,84.0879338133862 53.1585977185895,83.4457915421126 53.1585977185895,83.4457915421126 53.4866943332863)",
- "satellites": [
- {
- "id": "123456",
- "geometry": "POLYGON((83.4457915421126 53.4866943332863,84.0879338133862 53.4866943332863,84.0879338133862 53.1585977185895,83.4457915421126 53.1585977185895,83.4457915421126 53.4866943332863)",
- "centroid": "POINT(83.4457915421126 53.4866943332863)",
- "name": "Moscow"
}
], - "default_pos": {
- "zoom": "11",
- "lon": "43.2988455",
- "lat": "56.7724145"
}
}
]
}, - "meta": {
- "issue_date": "string",
- "code": 200,
- "api_version": "dev"
}
}