List of regions
Directory of regions (2.0)
2GIS API Support: api@2gis.ru URL: https://docs.2gis.com/
Getting a list of regions according to parameters
Provides a list of all available regions for the specified parameters.
query Parameters
key required | string A unique key of API user. |
page | integer Default: 1 The number of the requested page. |
page_size | integer [ 1 .. 2000 ] Default: 1000 Number of search results displayed on one page. |
locale | string The locale with which the search is performed and given results. |
locale_filter | Array of strings Example: locale_filter=ru_RU List of locales separated by commas that you use to filter. |
country_code_filter | string Example: country_code_filter=ru List of country codes separated by commas that you use to filter. |
fields | Array of strings Additional fields to be displayed in the response should be separated by commas.
|
type | string Default: "region" Examples:
A filter by object type, the types should be 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/list
Response samples
- 200
- 400
- 403
- 404
- 500
Content type
application/json
application/json
text/xml
{- "result": {
- "items": [
- {
- "id": "123456",
- "type": "region",
- "time_zone": {
- "name": "Asia/Novosibirsk",
- "offset": 240
}, - "zoom_level": {
- "min": 22,
- "max": 22
}, - "country_code": "st",
- "flags": {
- "2gis_reviews": true,
- "metro": true,
- "pedestrian_routing": true,
- "gdpr": true,
- "has_net_booklet": true,
- "road_network": true,
- "parking_layer": true,
- "public_transport": true,
- "traffic": true,
- "flamp": true,
- "truck_graph": true
}, - "tips_languages": "{\"ru\": \"ru\"}",
- "uri_code": "nnovgorod",
- "locale": "ru_RU",
- "statistics": {
- "rubric_count": 0,
- "org_count": 0,
- "branch_count": 0,
- "route_count": 0
}, - "bounds": "POLYGON((83.4457915421126 53.4866943332863,84.0879338133862 53.4866943332863,84.0879338133862 53.1585977185895,83.4457915421126 53.1585977185895,83.4457915421126 53.4866943332863)",
- "online_languages": {
- "available": "string",
- "default_lang": "string"
}, - "name_grammatical_cases": {
- "prepositional": "in Novosibirsk",
- "accusative": "Novosibirsk",
- "dative": "to Novosibirsk",
- "genitive": "of Novosibirsk"
}, - "locales": "ru_RU",
- "settlements": [
- "string"
], - "name": "Moscow",
- "domain": "ru",
- "seo": {
- "title": "string",
- "description": "string"
}, - "satellites": [
- {
- "id": "123456",
- "name": "Moscow",
- "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)"
}
], - "default_pos": {
- "lat": "56.7724145",
- "zoom": "11",
- "lon": "43.2988455"
}, - "uri_aliases": [
- "string"
], - "code": "nnovgorod"
}
], - "total": 1
}, - "meta": {
- "code": 200,
- "api_version": "dev",
- "issue_date": "string"
}
}