Skip to main content

Get region by id

API docs by Redocly

Directory of regions (2.0)

2GIS API Support: api@2gis.ru URL: https://docs.2gis.com/

Region

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 parameter. You can also specify multiple IDs separated by commas.

branch_id
required
string

Branch ID. Conflicts with id parameter. Required to obtain region.

fields
Array of strings

Additional fields that should be displayed in the response, comma separated.
The list of available fields:

  • items.name_grammatical_cases — declination of the region name;
  • items.domain — domain value;
  • items.locales — a list of locales you can use when searching in this region;
  • items.time_zone — time zone;
  • items.bounds — geometry of the project boundaries in the WKT format;
  • items.statistics — statistics for the region;
  • items.locale — current locale for the region;
  • items.settlements — a list of satellite cities
  • items.satellites — a list of satellite cities in the form of objects;
  • items.code — region code;
  • items.uri_code — the region code that will be displayed in the domain;
  • items.uri_aliases — set of the region aliases;
  • items.allow_for_indexing — the list of project languages that can be used for indexing;
  • items.country_code — country code;
  • items.default_pos — the default position for project display;
  • items.zoom_level — the zoom level;
  • items.flags — signs of availability of certain information in the region;
  • items.seo — additional fields for SEO.

Responses

Response Schema:
required
object (ObjMeta)

Response metadata

required
object

Main result

Response samples

Content type
{
  • "meta": {
    • "api_version": "dev",
    • "issue_date": "string",
    • "code": 200
    },
  • "result": {
    • "total": 1,
    • "items": [
      ]
    }
}