Overview | Urbi Documentation

Regions API

The Regions API is used to select a region that limits the searches for organizations, buildings, and places.

In terms of this API we use a word region (region_id) for an agglomeration that includes a large city ​​and its nearest settlements, as well as its satellite cities. These are territories with more detailed map and catalog data. Territories beyond the borders of the region — settlements, administrative divisions and so on — are called segments (segment_id).

In general, the regions and segments have nothing in common with the subjects of the Russian Federation and correspond to the 2GIS internal format of data storage only.

This API is primarily intended for internal use.

Outside the regions, the search for places and companies is geographically restricted.

This section presents an example of a request


This request takes the following parameters:

  • q=Moscow — the search is performed for the “Moscow” query
  • key=YOUR_KEY — your API key

The response to the request is returned in JSON format:

    "meta": {
        "api_version": "2.0.448950",
        "code": 200,
        "issue_date": "20200629"
    "result": {
        "items": [
                "id": "32",
                "name": "Moscow",
                "type": "region"
        "total": 1

An example of using the Regions API is given below.

  1. Get your API key:

    1. Sign in to the Platform Manager.
    2. Create a demo key (if you have not used Urbi products before) or request a production key: follow the link to contact a manager on the API Keys tab.

    In the Platform Manager, you can also:

    • See information on your current keys: which services are enabled, which limit is set for each, when a key will be deactivated, and more.
    • Set restrictions for a key by HTTP headers or by IP and subnet.
    • Check the statistics of request distribution for each key.
  2. Learn about the request and response formats.

  3. Check the examples of the Regions API requests.