# Словари географических объектов

Каждому населённому пункту, району, региону и стране присвоен свой уникальный идентификатор в базе данных ATI.SU.

Для получения геообъектов рекомендуем пользоваться этими идентификаторами. Получить объекты можно по кодам ФИАС, КЛАДР и координатам.

Если у вас нет кода населённого пункта, региона, страны или координат объекта, можете использовать автокомплит, получить код ATI.SU объекта и дальше пользоваться им.

База данных расширяется, но если вы не нашли необходимый населённый пункт, обратитесь <a href="https://chat.ati.su/ln/nqcx9p3xw6s/" target="_blank">в чат поддержки по API</a>.

Некоторые геообъекты мы внесли в справочник для совместимости с прежними версиями геосервиса. Такие объекты помечены атрибутом `“is_legacy”: true`. Настоятельно не рекомендуем использовать эти объекты, т.к. со временем мы их удалим.

## Методы получения населённых пунктов

Не у всех населённых пунктов есть перевод на русский и английский языки — название может вернуться на национальном языке, например, армянском или казахском.

<a id="post-v1-cities-by-ids"></a>

**Версия: Bearer token**

Получение населённых пунктов по списку идентификаторов (кодов ATI.SU)

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/gis-dict/v1/cities/by-ids' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "ids": [
    0
  ]
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `ids` — Список идентификаторов населённых пунктов (кодов ATI.SU) Допустимое количество элементов от 1 до 1000

**Пример ответа (200)**

```json
{
  "cities": [
    {
      "country_id": 0,
      "federal_district_id": 0,
      "region_id": 0,
      "district_ids": [
        0
      ],
      "name": "string",
      "alt_name": "string",
      "old_name": "string",
      "subdistrict": "string",
      "short_subdistrict": "string",
      "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "kladr": "string",
      "okato": "string",
      "oktmo": "string",
      "is_regional_center": false,
      "is_district_center": false,
      "size": 0,
      "geo_point": {
        "lat": 0.5,
        "lon": 0.5
      },
      "city_type_id": 0,
      "timezone": "string",
      "clarified_name": "string",
      "legacy_attributes": 0,
      "is_legacy": false
    }
  ]
}
```

**Описание полей ответа**
- `cities[].country_id` — Идентификатор страны
- `cities[].federal_district_id` — Идентификатор федерального округа Значение по умолчанию: `null`
- `cities[].region_id` — Идентификатор региона Значение по умолчанию: `null`
- `cities[].district_ids` — Идентификаторы районов Значение по умолчанию: `null`
- `cities[].name` — Название населённого пункта
- `cities[].alt_name` — Альтернативное название населённого пункта Значение по умолчанию: `null`
- `cities[].old_name` — Старое название населённого пункта Значение по умолчанию: `null`
- `cities[].subdistrict` — Часть района Значение по умолчанию: `null`
- `cities[].short_subdistrict` — Часть района с сокращениями типа Значение по умолчанию: `null`
- `cities[].fias_id` — Идентификатор ФИАС Значение по умолчанию: `null`
- `cities[].kladr` — Идентификатор КЛАДР Значение по умолчанию: `null`
- `cities[].okato` — Код ОКАТО Значение по умолчанию: `null`
- `cities[].oktmo` — Код ОКТМО Значение по умолчанию: `null`
- `cities[].is_regional_center` — Является ли населённый пункт региональным центром Значение по умолчанию: `false`
- `cities[].is_district_center` — Является ли населённый пункт районным центром Значение по умолчанию: `false`
- `cities[].size` — Размер населённого пункта. Members: 1 - Население менее 10 000 человек 2 - Население от 10 000 до 50 000 человек 3 - Население от 50 000 до 100 000 человек 4 - Население от 100 000 до 500 000 человек 5 - Население от 500 000 до 1 000 000 человек 6 - Население свыше 1 000 000 человек Members:
- `cities[].geo_point` — Координаты Значение по умолчанию: `null`
- `cities[].geo_point.lat` — Широта
- `cities[].geo_point.lon` — Долгота
- `cities[].city_type_id` — Идентификатор типа населённого пункта Значение по умолчанию: `null`
- `cities[].timezone` — Часовой пояс в формате IANA. Значение по умолчанию: `null`
- `cities[].clarified_name` — Название населённого пункта с уточнением типа и района при необходимости Если в регионе несколько населённых пунктов с одинаковым названием, то для них добавляется уточнение
- `cities[].legacy_attributes` — Атрибуты устаревшей записи населённого пункта Возвращаются только для населенных пунктов, помеченных как `is_legacy=true`. Значение по умолчанию: `null`
- `cities[].is_legacy` — Флаг, обозначающий, что объект является устаревшим Значение по умолчанию: `false`

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string",
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error` — Текстовый код ошибки
- `reason` — Человекочитаемое описание ошибки
- `details` — Дополнительная информация об ошибке

<a id="post-v1-cities-by-ids"></a>

**Версия: OAuth2.0**

Получение населённых пунктов по списку идентификаторов (кодов ATI.SU)

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/oauth2/gis-dict/v1/cities/by-ids' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "ids": [
    0
  ]
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `ids` — Список идентификаторов населённых пунктов (кодов ATI.SU) Допустимое количество элементов от 1 до 1000

**Пример ответа (200)**

```json
{
  "cities": [
    {
      "country_id": 0,
      "federal_district_id": 0,
      "region_id": 0,
      "district_ids": [
        0
      ],
      "name": "string",
      "alt_name": "string",
      "old_name": "string",
      "subdistrict": "string",
      "short_subdistrict": "string",
      "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "kladr": "string",
      "okato": "string",
      "oktmo": "string",
      "is_regional_center": false,
      "is_district_center": false,
      "size": 0,
      "geo_point": {
        "lat": 0.5,
        "lon": 0.5
      },
      "city_type_id": 0,
      "timezone": "string",
      "clarified_name": "string",
      "legacy_attributes": 0,
      "is_legacy": false
    }
  ]
}
```

**Описание полей ответа**
- `cities[].country_id` — Идентификатор страны
- `cities[].federal_district_id` — Идентификатор федерального округа Значение по умолчанию: `null`
- `cities[].region_id` — Идентификатор региона Значение по умолчанию: `null`
- `cities[].district_ids` — Идентификаторы районов Значение по умолчанию: `null`
- `cities[].name` — Название населённого пункта
- `cities[].alt_name` — Альтернативное название населённого пункта Значение по умолчанию: `null`
- `cities[].old_name` — Старое название населённого пункта Значение по умолчанию: `null`
- `cities[].subdistrict` — Часть района Значение по умолчанию: `null`
- `cities[].short_subdistrict` — Часть района с сокращениями типа Значение по умолчанию: `null`
- `cities[].fias_id` — Идентификатор ФИАС Значение по умолчанию: `null`
- `cities[].kladr` — Идентификатор КЛАДР Значение по умолчанию: `null`
- `cities[].okato` — Код ОКАТО Значение по умолчанию: `null`
- `cities[].oktmo` — Код ОКТМО Значение по умолчанию: `null`
- `cities[].is_regional_center` — Является ли населённый пункт региональным центром Значение по умолчанию: `false`
- `cities[].is_district_center` — Является ли населённый пункт районным центром Значение по умолчанию: `false`
- `cities[].size` — Размер населённого пункта. Members: 1 - Население менее 10 000 человек 2 - Население от 10 000 до 50 000 человек 3 - Население от 50 000 до 100 000 человек 4 - Население от 100 000 до 500 000 человек 5 - Население от 500 000 до 1 000 000 человек 6 - Население свыше 1 000 000 человек Members:
- `cities[].geo_point` — Координаты Значение по умолчанию: `null`
- `cities[].geo_point.lat` — Широта
- `cities[].geo_point.lon` — Долгота
- `cities[].city_type_id` — Идентификатор типа населённого пункта Значение по умолчанию: `null`
- `cities[].timezone` — Часовой пояс в формате IANA. Значение по умолчанию: `null`
- `cities[].clarified_name` — Название населённого пункта с уточнением типа и района при необходимости Если в регионе несколько населённых пунктов с одинаковым названием, то для них добавляется уточнение
- `cities[].legacy_attributes` — Атрибуты устаревшей записи населённого пункта Возвращаются только для населенных пунктов, помеченных как `is_legacy=true`. Значение по умолчанию: `null`
- `cities[].is_legacy` — Флаг, обозначающий, что объект является устаревшим Значение по умолчанию: `false`

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string",
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error` — Текстовый код ошибки
- `reason` — Человекочитаемое описание ошибки
- `details` — Дополнительная информация об ошибке


Пример ids `[1,3611]`.

<a id="post-v1-cities-by-coordinate"></a>

**Версия: Bearer token**

Получение населённого пункта по координате

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/gis-dict/v1/cities/by-coordinate' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "location": {
    "lat": 59.93904,
    "lon": 30.31581
  }
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `location` — Координаты
- `location.lat` — Широта
- `location.lon` — Долгота

**Пример ответа (200)**

```json
{
  "country_id": 0,
  "federal_district_id": 0,
  "region_id": 0,
  "district_ids": [
    0
  ],
  "name": "string",
  "alt_name": "string",
  "old_name": "string",
  "subdistrict": "string",
  "short_subdistrict": "string",
  "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "kladr": "string",
  "okato": "string",
  "oktmo": "string",
  "is_regional_center": false,
  "is_district_center": false,
  "size": 0,
  "geo_point": {
    "lat": 0.5,
    "lon": 0.5
  },
  "city_type_id": 0,
  "timezone": "string",
  "clarified_name": "string",
  "legacy_attributes": 0,
  "is_legacy": false
}
```

**Описание полей ответа**
- `country_id` — Идентификатор страны
- `federal_district_id` — Идентификатор федерального округа Значение по умолчанию: `null`
- `region_id` — Идентификатор региона Значение по умолчанию: `null`
- `district_ids` — Идентификаторы районов Значение по умолчанию: `null`
- `name` — Название населённого пункта
- `alt_name` — Альтернативное название населённого пункта Значение по умолчанию: `null`
- `old_name` — Старое название населённого пункта Значение по умолчанию: `null`
- `subdistrict` — Часть района Значение по умолчанию: `null`
- `short_subdistrict` — Часть района с сокращениями типа Значение по умолчанию: `null`
- `fias_id` — Идентификатор ФИАС Значение по умолчанию: `null`
- `kladr` — Идентификатор КЛАДР Значение по умолчанию: `null`
- `okato` — Код ОКАТО Значение по умолчанию: `null`
- `oktmo` — Код ОКТМО Значение по умолчанию: `null`
- `is_regional_center` — Является ли населённый пункт региональным центром Значение по умолчанию: `false`
- `is_district_center` — Является ли населённый пункт районным центром Значение по умолчанию: `false`
- `size` — Размер населённого пункта. Members: 1 - Население менее 10 000 человек 2 - Население от 10 000 до 50 000 человек 3 - Население от 50 000 до 100 000 человек 4 - Население от 100 000 до 500 000 человек 5 - Население от 500 000 до 1 000 000 человек 6 - Население свыше 1 000 000 человек Members:
- `geo_point` — Координаты Значение по умолчанию: `null`
- `geo_point.lat` — Широта
- `geo_point.lon` — Долгота
- `city_type_id` — Идентификатор типа населённого пункта Значение по умолчанию: `null`
- `timezone` — Часовой пояс в формате IANA. Значение по умолчанию: `null`
- `clarified_name` — Название населённого пункта с уточнением типа и района при необходимости Если в регионе несколько населённых пунктов с одинаковым названием, то для них добавляется уточнение
- `legacy_attributes` — Атрибуты устаревшей записи населённого пункта Возвращаются только для населенных пунктов, помеченных как `is_legacy=true`. Значение по умолчанию: `null`
- `is_legacy` — Флаг, обозначающий, что объект является устаревшим Значение по умолчанию: `false`

**Пример ответа (404)**

```json
{
  "error": "string",
  "reason": "string",
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error` — Текстовый код ошибки
- `reason` — Человекочитаемое описание ошибки
- `details` — Дополнительная информация об ошибке

<a id="post-v1-cities-by-coordinate"></a>

**Версия: OAuth2.0**

Получение населённого пункта по координате

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/oauth2/gis-dict/v1/cities/by-coordinate' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "location": {
    "lat": 59.93904,
    "lon": 30.31581
  }
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `location` — Координаты
- `location.lat` — Широта
- `location.lon` — Долгота

**Пример ответа (200)**

```json
{
  "country_id": 0,
  "federal_district_id": 0,
  "region_id": 0,
  "district_ids": [
    0
  ],
  "name": "string",
  "alt_name": "string",
  "old_name": "string",
  "subdistrict": "string",
  "short_subdistrict": "string",
  "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "kladr": "string",
  "okato": "string",
  "oktmo": "string",
  "is_regional_center": false,
  "is_district_center": false,
  "size": 0,
  "geo_point": {
    "lat": 0.5,
    "lon": 0.5
  },
  "city_type_id": 0,
  "timezone": "string",
  "clarified_name": "string",
  "legacy_attributes": 0,
  "is_legacy": false
}
```

**Описание полей ответа**
- `country_id` — Идентификатор страны
- `federal_district_id` — Идентификатор федерального округа Значение по умолчанию: `null`
- `region_id` — Идентификатор региона Значение по умолчанию: `null`
- `district_ids` — Идентификаторы районов Значение по умолчанию: `null`
- `name` — Название населённого пункта
- `alt_name` — Альтернативное название населённого пункта Значение по умолчанию: `null`
- `old_name` — Старое название населённого пункта Значение по умолчанию: `null`
- `subdistrict` — Часть района Значение по умолчанию: `null`
- `short_subdistrict` — Часть района с сокращениями типа Значение по умолчанию: `null`
- `fias_id` — Идентификатор ФИАС Значение по умолчанию: `null`
- `kladr` — Идентификатор КЛАДР Значение по умолчанию: `null`
- `okato` — Код ОКАТО Значение по умолчанию: `null`
- `oktmo` — Код ОКТМО Значение по умолчанию: `null`
- `is_regional_center` — Является ли населённый пункт региональным центром Значение по умолчанию: `false`
- `is_district_center` — Является ли населённый пункт районным центром Значение по умолчанию: `false`
- `size` — Размер населённого пункта. Members: 1 - Население менее 10 000 человек 2 - Население от 10 000 до 50 000 человек 3 - Население от 50 000 до 100 000 человек 4 - Население от 100 000 до 500 000 человек 5 - Население от 500 000 до 1 000 000 человек 6 - Население свыше 1 000 000 человек Members:
- `geo_point` — Координаты Значение по умолчанию: `null`
- `geo_point.lat` — Широта
- `geo_point.lon` — Долгота
- `city_type_id` — Идентификатор типа населённого пункта Значение по умолчанию: `null`
- `timezone` — Часовой пояс в формате IANA. Значение по умолчанию: `null`
- `clarified_name` — Название населённого пункта с уточнением типа и района при необходимости Если в регионе несколько населённых пунктов с одинаковым названием, то для них добавляется уточнение
- `legacy_attributes` — Атрибуты устаревшей записи населённого пункта Возвращаются только для населенных пунктов, помеченных как `is_legacy=true`. Значение по умолчанию: `null`
- `is_legacy` — Флаг, обозначающий, что объект является устаревшим Значение по умолчанию: `false`

**Пример ответа (404)**

```json
{
  "error": "string",
  "reason": "string",
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error` — Текстовый код ошибки
- `reason` — Человекочитаемое описание ошибки
- `details` — Дополнительная информация об ошибке


<a id="post-v1-cities-by-fias-ids"></a>

**Версия: Bearer token**

Получение населённых пунктов по списку идентификаторов ФИАС

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/gis-dict/v1/cities/by-fias-ids' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "fias_ids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `fias_ids` — Список идентификаторов ФИАС населённых пунктов Допустимое количество элементов от 1 до 1000

**Пример ответа (200)**

```json
{
  "cities": [
    {
      "country_id": 0,
      "federal_district_id": 0,
      "region_id": 0,
      "district_ids": [
        0
      ],
      "name": "string",
      "alt_name": "string",
      "old_name": "string",
      "subdistrict": "string",
      "short_subdistrict": "string",
      "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "kladr": "string",
      "okato": "string",
      "oktmo": "string",
      "is_regional_center": false,
      "is_district_center": false,
      "size": 0,
      "geo_point": {
        "lat": 0.5,
        "lon": 0.5
      },
      "city_type_id": 0,
      "timezone": "string",
      "clarified_name": "string",
      "legacy_attributes": 0,
      "is_legacy": false
    }
  ]
}
```

**Описание полей ответа**
- `cities[].country_id` — Идентификатор страны
- `cities[].federal_district_id` — Идентификатор федерального округа Значение по умолчанию: `null`
- `cities[].region_id` — Идентификатор региона Значение по умолчанию: `null`
- `cities[].district_ids` — Идентификаторы районов Значение по умолчанию: `null`
- `cities[].name` — Название населённого пункта
- `cities[].alt_name` — Альтернативное название населённого пункта Значение по умолчанию: `null`
- `cities[].old_name` — Старое название населённого пункта Значение по умолчанию: `null`
- `cities[].subdistrict` — Часть района Значение по умолчанию: `null`
- `cities[].short_subdistrict` — Часть района с сокращениями типа Значение по умолчанию: `null`
- `cities[].fias_id` — Идентификатор ФИАС Значение по умолчанию: `null`
- `cities[].kladr` — Идентификатор КЛАДР Значение по умолчанию: `null`
- `cities[].okato` — Код ОКАТО Значение по умолчанию: `null`
- `cities[].oktmo` — Код ОКТМО Значение по умолчанию: `null`
- `cities[].is_regional_center` — Является ли населённый пункт региональным центром Значение по умолчанию: `false`
- `cities[].is_district_center` — Является ли населённый пункт районным центром Значение по умолчанию: `false`
- `cities[].size` — Размер населённого пункта. Members: 1 - Население менее 10 000 человек 2 - Население от 10 000 до 50 000 человек 3 - Население от 50 000 до 100 000 человек 4 - Население от 100 000 до 500 000 человек 5 - Население от 500 000 до 1 000 000 человек 6 - Население свыше 1 000 000 человек Members:
- `cities[].geo_point` — Координаты Значение по умолчанию: `null`
- `cities[].geo_point.lat` — Широта
- `cities[].geo_point.lon` — Долгота
- `cities[].city_type_id` — Идентификатор типа населённого пункта Значение по умолчанию: `null`
- `cities[].timezone` — Часовой пояс в формате IANA. Значение по умолчанию: `null`
- `cities[].clarified_name` — Название населённого пункта с уточнением типа и района при необходимости Если в регионе несколько населённых пунктов с одинаковым названием, то для них добавляется уточнение
- `cities[].legacy_attributes` — Атрибуты устаревшей записи населённого пункта Возвращаются только для населенных пунктов, помеченных как `is_legacy=true`. Значение по умолчанию: `null`
- `cities[].is_legacy` — Флаг, обозначающий, что объект является устаревшим Значение по умолчанию: `false`

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string",
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error` — Текстовый код ошибки
- `reason` — Человекочитаемое описание ошибки
- `details` — Дополнительная информация об ошибке

<a id="post-v1-cities-by-fias-ids"></a>

**Версия: OAuth2.0**

Получение населённых пунктов по списку идентификаторов ФИАС

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/oauth2/gis-dict/v1/cities/by-fias-ids' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "fias_ids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `fias_ids` — Список идентификаторов ФИАС населённых пунктов Допустимое количество элементов от 1 до 1000

**Пример ответа (200)**

```json
{
  "cities": [
    {
      "country_id": 0,
      "federal_district_id": 0,
      "region_id": 0,
      "district_ids": [
        0
      ],
      "name": "string",
      "alt_name": "string",
      "old_name": "string",
      "subdistrict": "string",
      "short_subdistrict": "string",
      "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "kladr": "string",
      "okato": "string",
      "oktmo": "string",
      "is_regional_center": false,
      "is_district_center": false,
      "size": 0,
      "geo_point": {
        "lat": 0.5,
        "lon": 0.5
      },
      "city_type_id": 0,
      "timezone": "string",
      "clarified_name": "string",
      "legacy_attributes": 0,
      "is_legacy": false
    }
  ]
}
```

**Описание полей ответа**
- `cities[].country_id` — Идентификатор страны
- `cities[].federal_district_id` — Идентификатор федерального округа Значение по умолчанию: `null`
- `cities[].region_id` — Идентификатор региона Значение по умолчанию: `null`
- `cities[].district_ids` — Идентификаторы районов Значение по умолчанию: `null`
- `cities[].name` — Название населённого пункта
- `cities[].alt_name` — Альтернативное название населённого пункта Значение по умолчанию: `null`
- `cities[].old_name` — Старое название населённого пункта Значение по умолчанию: `null`
- `cities[].subdistrict` — Часть района Значение по умолчанию: `null`
- `cities[].short_subdistrict` — Часть района с сокращениями типа Значение по умолчанию: `null`
- `cities[].fias_id` — Идентификатор ФИАС Значение по умолчанию: `null`
- `cities[].kladr` — Идентификатор КЛАДР Значение по умолчанию: `null`
- `cities[].okato` — Код ОКАТО Значение по умолчанию: `null`
- `cities[].oktmo` — Код ОКТМО Значение по умолчанию: `null`
- `cities[].is_regional_center` — Является ли населённый пункт региональным центром Значение по умолчанию: `false`
- `cities[].is_district_center` — Является ли населённый пункт районным центром Значение по умолчанию: `false`
- `cities[].size` — Размер населённого пункта. Members: 1 - Население менее 10 000 человек 2 - Население от 10 000 до 50 000 человек 3 - Население от 50 000 до 100 000 человек 4 - Население от 100 000 до 500 000 человек 5 - Население от 500 000 до 1 000 000 человек 6 - Население свыше 1 000 000 человек Members:
- `cities[].geo_point` — Координаты Значение по умолчанию: `null`
- `cities[].geo_point.lat` — Широта
- `cities[].geo_point.lon` — Долгота
- `cities[].city_type_id` — Идентификатор типа населённого пункта Значение по умолчанию: `null`
- `cities[].timezone` — Часовой пояс в формате IANA. Значение по умолчанию: `null`
- `cities[].clarified_name` — Название населённого пункта с уточнением типа и района при необходимости Если в регионе несколько населённых пунктов с одинаковым названием, то для них добавляется уточнение
- `cities[].legacy_attributes` — Атрибуты устаревшей записи населённого пункта Возвращаются только для населенных пунктов, помеченных как `is_legacy=true`. Значение по умолчанию: `null`
- `cities[].is_legacy` — Флаг, обозначающий, что объект является устаревшим Значение по умолчанию: `false`

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string",
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error` — Текстовый код ошибки
- `reason` — Человекочитаемое описание ошибки
- `details` — Дополнительная информация об ошибке


Пример fias_ids `["c2deb16a-0330-4f05-821f-1d09c93331e6", "0c5b2444-70a0-4932-980c-b4dc0d3f02b5"]`.

<a id="post-v1-cities-by-kladr-codes"></a>

**Версия: Bearer token**

Получение населённых пунктов по списку идентификаторов КЛАДР

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/gis-dict/v1/cities/by-kladr-codes' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "kladr_codes": [
    "string"
  ]
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `kladr_codes` — Список идентификаторов КЛАДР населённых пунктов Допустимое количество элементов от 1 до 1000

**Пример ответа (200)**

```json
{
  "cities": [
    {
      "country_id": 0,
      "federal_district_id": 0,
      "region_id": 0,
      "district_ids": [
        0
      ],
      "name": "string",
      "alt_name": "string",
      "old_name": "string",
      "subdistrict": "string",
      "short_subdistrict": "string",
      "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "kladr": "string",
      "okato": "string",
      "oktmo": "string",
      "is_regional_center": false,
      "is_district_center": false,
      "size": 0,
      "geo_point": {
        "lat": 0.5,
        "lon": 0.5
      },
      "city_type_id": 0,
      "timezone": "string",
      "clarified_name": "string",
      "legacy_attributes": 0,
      "is_legacy": false
    }
  ]
}
```

**Описание полей ответа**
- `cities[].country_id` — Идентификатор страны
- `cities[].federal_district_id` — Идентификатор федерального округа Значение по умолчанию: `null`
- `cities[].region_id` — Идентификатор региона Значение по умолчанию: `null`
- `cities[].district_ids` — Идентификаторы районов Значение по умолчанию: `null`
- `cities[].name` — Название населённого пункта
- `cities[].alt_name` — Альтернативное название населённого пункта Значение по умолчанию: `null`
- `cities[].old_name` — Старое название населённого пункта Значение по умолчанию: `null`
- `cities[].subdistrict` — Часть района Значение по умолчанию: `null`
- `cities[].short_subdistrict` — Часть района с сокращениями типа Значение по умолчанию: `null`
- `cities[].fias_id` — Идентификатор ФИАС Значение по умолчанию: `null`
- `cities[].kladr` — Идентификатор КЛАДР Значение по умолчанию: `null`
- `cities[].okato` — Код ОКАТО Значение по умолчанию: `null`
- `cities[].oktmo` — Код ОКТМО Значение по умолчанию: `null`
- `cities[].is_regional_center` — Является ли населённый пункт региональным центром Значение по умолчанию: `false`
- `cities[].is_district_center` — Является ли населённый пункт районным центром Значение по умолчанию: `false`
- `cities[].size` — Размер населённого пункта. Members: 1 - Население менее 10 000 человек 2 - Население от 10 000 до 50 000 человек 3 - Население от 50 000 до 100 000 человек 4 - Население от 100 000 до 500 000 человек 5 - Население от 500 000 до 1 000 000 человек 6 - Население свыше 1 000 000 человек Members:
- `cities[].geo_point` — Координаты Значение по умолчанию: `null`
- `cities[].geo_point.lat` — Широта
- `cities[].geo_point.lon` — Долгота
- `cities[].city_type_id` — Идентификатор типа населённого пункта Значение по умолчанию: `null`
- `cities[].timezone` — Часовой пояс в формате IANA. Значение по умолчанию: `null`
- `cities[].clarified_name` — Название населённого пункта с уточнением типа и района при необходимости Если в регионе несколько населённых пунктов с одинаковым названием, то для них добавляется уточнение
- `cities[].legacy_attributes` — Атрибуты устаревшей записи населённого пункта Возвращаются только для населенных пунктов, помеченных как `is_legacy=true`. Значение по умолчанию: `null`
- `cities[].is_legacy` — Флаг, обозначающий, что объект является устаревшим Значение по умолчанию: `false`

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string",
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error` — Текстовый код ошибки
- `reason` — Человекочитаемое описание ошибки
- `details` — Дополнительная информация об ошибке

<a id="post-v1-cities-by-kladr-codes"></a>

**Версия: OAuth2.0**

Получение населённых пунктов по списку идентификаторов КЛАДР

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/oauth2/gis-dict/v1/cities/by-kladr-codes' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "kladr_codes": [
    "string"
  ]
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `kladr_codes` — Список идентификаторов КЛАДР населённых пунктов Допустимое количество элементов от 1 до 1000

**Пример ответа (200)**

```json
{
  "cities": [
    {
      "country_id": 0,
      "federal_district_id": 0,
      "region_id": 0,
      "district_ids": [
        0
      ],
      "name": "string",
      "alt_name": "string",
      "old_name": "string",
      "subdistrict": "string",
      "short_subdistrict": "string",
      "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "kladr": "string",
      "okato": "string",
      "oktmo": "string",
      "is_regional_center": false,
      "is_district_center": false,
      "size": 0,
      "geo_point": {
        "lat": 0.5,
        "lon": 0.5
      },
      "city_type_id": 0,
      "timezone": "string",
      "clarified_name": "string",
      "legacy_attributes": 0,
      "is_legacy": false
    }
  ]
}
```

**Описание полей ответа**
- `cities[].country_id` — Идентификатор страны
- `cities[].federal_district_id` — Идентификатор федерального округа Значение по умолчанию: `null`
- `cities[].region_id` — Идентификатор региона Значение по умолчанию: `null`
- `cities[].district_ids` — Идентификаторы районов Значение по умолчанию: `null`
- `cities[].name` — Название населённого пункта
- `cities[].alt_name` — Альтернативное название населённого пункта Значение по умолчанию: `null`
- `cities[].old_name` — Старое название населённого пункта Значение по умолчанию: `null`
- `cities[].subdistrict` — Часть района Значение по умолчанию: `null`
- `cities[].short_subdistrict` — Часть района с сокращениями типа Значение по умолчанию: `null`
- `cities[].fias_id` — Идентификатор ФИАС Значение по умолчанию: `null`
- `cities[].kladr` — Идентификатор КЛАДР Значение по умолчанию: `null`
- `cities[].okato` — Код ОКАТО Значение по умолчанию: `null`
- `cities[].oktmo` — Код ОКТМО Значение по умолчанию: `null`
- `cities[].is_regional_center` — Является ли населённый пункт региональным центром Значение по умолчанию: `false`
- `cities[].is_district_center` — Является ли населённый пункт районным центром Значение по умолчанию: `false`
- `cities[].size` — Размер населённого пункта. Members: 1 - Население менее 10 000 человек 2 - Население от 10 000 до 50 000 человек 3 - Население от 50 000 до 100 000 человек 4 - Население от 100 000 до 500 000 человек 5 - Население от 500 000 до 1 000 000 человек 6 - Население свыше 1 000 000 человек Members:
- `cities[].geo_point` — Координаты Значение по умолчанию: `null`
- `cities[].geo_point.lat` — Широта
- `cities[].geo_point.lon` — Долгота
- `cities[].city_type_id` — Идентификатор типа населённого пункта Значение по умолчанию: `null`
- `cities[].timezone` — Часовой пояс в формате IANA. Значение по умолчанию: `null`
- `cities[].clarified_name` — Название населённого пункта с уточнением типа и района при необходимости Если в регионе несколько населённых пунктов с одинаковым названием, то для них добавляется уточнение
- `cities[].legacy_attributes` — Атрибуты устаревшей записи населённого пункта Возвращаются только для населенных пунктов, помеченных как `is_legacy=true`. Значение по умолчанию: `null`
- `cities[].is_legacy` — Флаг, обозначающий, что объект является устаревшим Значение по умолчанию: `false`

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string",
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error` — Текстовый код ошибки
- `reason` — Человекочитаемое описание ошибки
- `details` — Дополнительная информация об ошибке


Пример kladr_codes `["7800000000000", "7700000000000"]`.

<a id="get-v1-city-types"></a>

**Версия: Bearer token**

Получение всех типов населённых пунктов

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/gis-dict/v1/city-types' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Пример ответа (200)**

```json
{
  "city_types": [
    {
      "city_type_id": 0,
      "name": "string",
      "short_name": "string"
    }
  ]
}
```

**Описание полей ответа**
- `city_types[].city_type_id` — Идентификатор типа населённого пункта
- `city_types[].name` — Название типа
- `city_types[].short_name` — Сокращённое название типа

<a id="get-v1-city-types"></a>

**Версия: OAuth2.0**

Получение всех типов населённых пунктов

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/oauth2/gis-dict/v1/city-types' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Пример ответа (200)**

```json
{
  "city_types": [
    {
      "city_type_id": 0,
      "name": "string",
      "short_name": "string"
    }
  ]
}
```

**Описание полей ответа**
- `city_types[].city_type_id` — Идентификатор типа населённого пункта
- `city_types[].name` — Название типа
- `city_types[].short_name` — Сокращённое название типа


## Метод получения районов

<a id="post-v1-districts-by-ids"></a>

**Версия: Bearer token**

Получение районов по списку идентификаторов (кодов ATI.SU)

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/gis-dict/v1/districts/by-ids' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "ids": [
    0
  ]
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `ids` — Список идентификаторов районов (кодов ATI.SU) Допустимое количество элементов от 1 до 1000

**Пример ответа (200)**

```json
{
  "districts": [
    {
      "district_id": 0,
      "country_id": 0,
      "federal_district_id": 0,
      "name": "string",
      "short_name": "string",
      "region_id": 0
    }
  ]
}
```

**Описание полей ответа**
- `districts[].district_id` — Идентификатор района
- `districts[].country_id` — Идентификатор страны
- `districts[].federal_district_id` — Идентификатор федерального округа Значение по умолчанию: `null`
- `districts[].name` — Название района
- `districts[].short_name` — Название района с сокращениями типа
- `districts[].region_id` — Идентификатор региона Значение по умолчанию: `null`

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string",
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error` — Текстовый код ошибки
- `reason` — Человекочитаемое описание ошибки
- `details` — Дополнительная информация об ошибке

<a id="post-v1-districts-by-ids"></a>

**Версия: OAuth2.0**

Получение районов по списку идентификаторов (кодов ATI.SU)

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/oauth2/gis-dict/v1/districts/by-ids' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "ids": [
    0
  ]
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `ids` — Список идентификаторов районов (кодов ATI.SU) Допустимое количество элементов от 1 до 1000

**Пример ответа (200)**

```json
{
  "districts": [
    {
      "district_id": 0,
      "country_id": 0,
      "federal_district_id": 0,
      "name": "string",
      "short_name": "string",
      "region_id": 0
    }
  ]
}
```

**Описание полей ответа**
- `districts[].district_id` — Идентификатор района
- `districts[].country_id` — Идентификатор страны
- `districts[].federal_district_id` — Идентификатор федерального округа Значение по умолчанию: `null`
- `districts[].name` — Название района
- `districts[].short_name` — Название района с сокращениями типа
- `districts[].region_id` — Идентификатор региона Значение по умолчанию: `null`

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string",
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error` — Текстовый код ошибки
- `reason` — Человекочитаемое описание ошибки
- `details` — Дополнительная информация об ошибке


Пример ids `[8456, 8464 , 6857]`.

## Метод получения федеральных округов

<a id="get-v1-federal-districts"></a>

**Версия: Bearer token**

Получение всех федеральных округов

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/gis-dict/v1/federal-districts' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Пример ответа (200)**

```json
{
  "federal_districts": [
    {
      "federal_district_id": 0,
      "country_id": 0,
      "name": "string",
      "is_legacy": false
    }
  ]
}
```

**Описание полей ответа**
- `federal_districts[].federal_district_id` — Идентификатор фед. округа
- `federal_districts[].country_id` — Идентификатор страны
- `federal_districts[].name` — Название федерального округа
- `federal_districts[].is_legacy` — Флаг, обозначающий, что объект является устаревшим. Значение по умолчанию: `false`

<a id="get-v1-federal-districts"></a>

**Версия: OAuth2.0**

Получение всех федеральных округов

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/oauth2/gis-dict/v1/federal-districts' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Пример ответа (200)**

```json
{
  "federal_districts": [
    {
      "federal_district_id": 0,
      "country_id": 0,
      "name": "string",
      "is_legacy": false
    }
  ]
}
```

**Описание полей ответа**
- `federal_districts[].federal_district_id` — Идентификатор фед. округа
- `federal_districts[].country_id` — Идентификатор страны
- `federal_districts[].name` — Название федерального округа
- `federal_districts[].is_legacy` — Флаг, обозначающий, что объект является устаревшим. Значение по умолчанию: `false`


## Методы получения регионов

<a id="post-v1-regions-by-ids"></a>

**Версия: Bearer token**

Получение регионов по списку идентификаторов (кодов ATI.SU)

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/gis-dict/v1/regions/by-ids' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "ids": [
    0
  ]
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `ids` — Список идентификаторов регионов (кодов ATI.SU)

**Пример ответа (200)**

```json
{
  "regions": [
    {
      "region_id": 0,
      "name": "string",
      "country_id": 0,
      "federal_district_id": 0,
      "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tax_region_code": "string",
      "clarified_name": "string",
      "regional_center_id": 0,
      "is_legacy": false
    }
  ]
}
```

**Описание полей ответа**
- `regions[].region_id` — Идентификатор региона
- `regions[].name` — Название региона
- `regions[].country_id` — Идентификатор страны
- `regions[].federal_district_id` — Идентификатор федерального округа Значение по умолчанию: `null`
- `regions[].fias_id` — Идентификатор ФИАС Значение по умолчанию: `null`
- `regions[].tax_region_code` — Код региона для ФНС. Значение по умолчанию: `null`
- `regions[].clarified_name` — Название региона с уточнением, что это регион при необходимости. Если название региона совпадает с каким-нибудь городом, то для него добавляется уточнение.
- `regions[].regional_center_id` — Идентификатор регионального центра Значение по умолчанию: `null`
- `regions[].is_legacy` — Флаг, обозначающий, что объект является устаревшим. Значение по умолчанию: `false`

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string",
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error` — Текстовый код ошибки
- `reason` — Человекочитаемое описание ошибки
- `details` — Дополнительная информация об ошибке

<a id="post-v1-regions-by-ids"></a>

**Версия: OAuth2.0**

Получение регионов по списку идентификаторов (кодов ATI.SU)

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/oauth2/gis-dict/v1/regions/by-ids' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "ids": [
    0
  ]
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `ids` — Список идентификаторов регионов (кодов ATI.SU)

**Пример ответа (200)**

```json
{
  "regions": [
    {
      "region_id": 0,
      "name": "string",
      "country_id": 0,
      "federal_district_id": 0,
      "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tax_region_code": "string",
      "clarified_name": "string",
      "regional_center_id": 0,
      "is_legacy": false
    }
  ]
}
```

**Описание полей ответа**
- `regions[].region_id` — Идентификатор региона
- `regions[].name` — Название региона
- `regions[].country_id` — Идентификатор страны
- `regions[].federal_district_id` — Идентификатор федерального округа Значение по умолчанию: `null`
- `regions[].fias_id` — Идентификатор ФИАС Значение по умолчанию: `null`
- `regions[].tax_region_code` — Код региона для ФНС. Значение по умолчанию: `null`
- `regions[].clarified_name` — Название региона с уточнением, что это регион при необходимости. Если название региона совпадает с каким-нибудь городом, то для него добавляется уточнение.
- `regions[].regional_center_id` — Идентификатор регионального центра Значение по умолчанию: `null`
- `regions[].is_legacy` — Флаг, обозначающий, что объект является устаревшим. Значение по умолчанию: `false`

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string",
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error` — Текстовый код ошибки
- `reason` — Человекочитаемое описание ошибки
- `details` — Дополнительная информация об ошибке


Пример ids `[1, 680, 681]`.

<a id="post-v1-regions-by-coordinate"></a>

**Версия: Bearer token**

Получение региона по координате

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/gis-dict/v1/regions/by-coordinate' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "location": {
    "lat": 59.93904,
    "lon": 30.31581
  }
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `location` — Координаты
- `location.lat` — Широта
- `location.lon` — Долгота

**Пример ответа (200)**

```json
{
  "region_id": 0,
  "name": "string",
  "country_id": 0,
  "federal_district_id": 0,
  "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tax_region_code": "string",
  "clarified_name": "string",
  "regional_center_id": 0,
  "is_legacy": false
}
```

**Описание полей ответа**
- `region_id` — Идентификатор региона
- `name` — Название региона
- `country_id` — Идентификатор страны
- `federal_district_id` — Идентификатор федерального округа Значение по умолчанию: `null`
- `fias_id` — Идентификатор ФИАС Значение по умолчанию: `null`
- `tax_region_code` — Код региона для ФНС. Значение по умолчанию: `null`
- `clarified_name` — Название региона с уточнением, что это регион при необходимости. Если название региона совпадает с каким-нибудь городом, то для него добавляется уточнение.
- `regional_center_id` — Идентификатор регионального центра Значение по умолчанию: `null`
- `is_legacy` — Флаг, обозначающий, что объект является устаревшим. Значение по умолчанию: `false`

**Пример ответа (404)**

```json
{
  "error": "string",
  "reason": "string",
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error` — Текстовый код ошибки
- `reason` — Человекочитаемое описание ошибки
- `details` — Дополнительная информация об ошибке

<a id="post-v1-regions-by-coordinate"></a>

**Версия: OAuth2.0**

Получение региона по координате

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/oauth2/gis-dict/v1/regions/by-coordinate' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "location": {
    "lat": 59.93904,
    "lon": 30.31581
  }
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `location` — Координаты
- `location.lat` — Широта
- `location.lon` — Долгота

**Пример ответа (200)**

```json
{
  "region_id": 0,
  "name": "string",
  "country_id": 0,
  "federal_district_id": 0,
  "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tax_region_code": "string",
  "clarified_name": "string",
  "regional_center_id": 0,
  "is_legacy": false
}
```

**Описание полей ответа**
- `region_id` — Идентификатор региона
- `name` — Название региона
- `country_id` — Идентификатор страны
- `federal_district_id` — Идентификатор федерального округа Значение по умолчанию: `null`
- `fias_id` — Идентификатор ФИАС Значение по умолчанию: `null`
- `tax_region_code` — Код региона для ФНС. Значение по умолчанию: `null`
- `clarified_name` — Название региона с уточнением, что это регион при необходимости. Если название региона совпадает с каким-нибудь городом, то для него добавляется уточнение.
- `regional_center_id` — Идентификатор регионального центра Значение по умолчанию: `null`
- `is_legacy` — Флаг, обозначающий, что объект является устаревшим. Значение по умолчанию: `false`

**Пример ответа (404)**

```json
{
  "error": "string",
  "reason": "string",
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error` — Текстовый код ошибки
- `reason` — Человекочитаемое описание ошибки
- `details` — Дополнительная информация об ошибке


<a id="post-v1-regions-by-fias-ids"></a>

**Версия: Bearer token**

Получение регионов по списку идентификаторов ФИАС

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/gis-dict/v1/regions/by-fias-ids' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "fias_ids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `fias_ids` — Список идентификаторов ФИАС регионов Допустимое количество элементов от 1 до 1000

**Пример ответа (200)**

```json
{
  "regions": [
    {
      "region_id": 0,
      "name": "string",
      "country_id": 0,
      "federal_district_id": 0,
      "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tax_region_code": "string",
      "clarified_name": "string",
      "regional_center_id": 0,
      "is_legacy": false
    }
  ]
}
```

**Описание полей ответа**
- `regions[].region_id` — Идентификатор региона
- `regions[].name` — Название региона
- `regions[].country_id` — Идентификатор страны
- `regions[].federal_district_id` — Идентификатор федерального округа Значение по умолчанию: `null`
- `regions[].fias_id` — Идентификатор ФИАС Значение по умолчанию: `null`
- `regions[].tax_region_code` — Код региона для ФНС. Значение по умолчанию: `null`
- `regions[].clarified_name` — Название региона с уточнением, что это регион при необходимости. Если название региона совпадает с каким-нибудь городом, то для него добавляется уточнение.
- `regions[].regional_center_id` — Идентификатор регионального центра Значение по умолчанию: `null`
- `regions[].is_legacy` — Флаг, обозначающий, что объект является устаревшим. Значение по умолчанию: `false`

<a id="post-v1-regions-by-fias-ids"></a>

**Версия: OAuth2.0**

Получение регионов по списку идентификаторов ФИАС

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/oauth2/gis-dict/v1/regions/by-fias-ids' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "fias_ids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `fias_ids` — Список идентификаторов ФИАС регионов Допустимое количество элементов от 1 до 1000

**Пример ответа (200)**

```json
{
  "regions": [
    {
      "region_id": 0,
      "name": "string",
      "country_id": 0,
      "federal_district_id": 0,
      "fias_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tax_region_code": "string",
      "clarified_name": "string",
      "regional_center_id": 0,
      "is_legacy": false
    }
  ]
}
```

**Описание полей ответа**
- `regions[].region_id` — Идентификатор региона
- `regions[].name` — Название региона
- `regions[].country_id` — Идентификатор страны
- `regions[].federal_district_id` — Идентификатор федерального округа Значение по умолчанию: `null`
- `regions[].fias_id` — Идентификатор ФИАС Значение по умолчанию: `null`
- `regions[].tax_region_code` — Код региона для ФНС. Значение по умолчанию: `null`
- `regions[].clarified_name` — Название региона с уточнением, что это регион при необходимости. Если название региона совпадает с каким-нибудь городом, то для него добавляется уточнение.
- `regions[].regional_center_id` — Идентификатор регионального центра Значение по умолчанию: `null`
- `regions[].is_legacy` — Флаг, обозначающий, что объект является устаревшим. Значение по умолчанию: `false`


Пример fias_ids `["6d1ebb35-70c6-4129-bd55-da3969658f5d", "29251dcf-00a1-4e34-98d4-5c47484a36d4"]`.

## Методы получения стран

<a id="post-v1-countries-by-ids"></a>

**Версия: Bearer token**

Получение стран по списку идентификаторов (кодов ATI.SU)

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/gis-dict/v1/countries/by-ids' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "ids": [
    0
  ]
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `ids` — Список идентификаторов стран (кодов ATI.SU) Допустимое количество элементов от 1 до 1000

**Пример ответа (200)**

```json
{
  "countries": [
    {
      "country_id": 0,
      "name": "string",
      "iso_3166_alpha2": "string",
      "iso_3166_alpha3": "string",
      "iso_3166_numeric": 0,
      "is_legacy": false
    }
  ]
}
```

**Описание полей ответа**
- `countries[].country_id` — Идентификатор страны
- `countries[].name` — Название страны
- `countries[].iso_3166_alpha2` — Двухбуквенный код страны по ISO-3166
- `countries[].iso_3166_alpha3` — Трехбуквенный код страны по ISO-3166
- `countries[].iso_3166_numeric` — Числовой код страны по ISO-3166
- `countries[].is_legacy` — Флаг, обозначающий, что объект является устаревшим. Значение по умолчанию: `false`

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string",
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error` — Текстовый код ошибки
- `reason` — Человекочитаемое описание ошибки
- `details` — Дополнительная информация об ошибке

<a id="post-v1-countries-by-ids"></a>

**Версия: OAuth2.0**

Получение стран по списку идентификаторов (кодов ATI.SU)

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/oauth2/gis-dict/v1/countries/by-ids' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "ids": [
    0
  ]
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `ids` — Список идентификаторов стран (кодов ATI.SU) Допустимое количество элементов от 1 до 1000

**Пример ответа (200)**

```json
{
  "countries": [
    {
      "country_id": 0,
      "name": "string",
      "iso_3166_alpha2": "string",
      "iso_3166_alpha3": "string",
      "iso_3166_numeric": 0,
      "is_legacy": false
    }
  ]
}
```

**Описание полей ответа**
- `countries[].country_id` — Идентификатор страны
- `countries[].name` — Название страны
- `countries[].iso_3166_alpha2` — Двухбуквенный код страны по ISO-3166
- `countries[].iso_3166_alpha3` — Трехбуквенный код страны по ISO-3166
- `countries[].iso_3166_numeric` — Числовой код страны по ISO-3166
- `countries[].is_legacy` — Флаг, обозначающий, что объект является устаревшим. Значение по умолчанию: `false`

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string",
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error` — Текстовый код ошибки
- `reason` — Человекочитаемое описание ошибки
- `details` — Дополнительная информация об ошибке


Пример ids `[1, 50]`.

<a id="post-v1-countries-by-coordinate"></a>

**Версия: Bearer token**

Получение страны по координате

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/gis-dict/v1/countries/by-coordinate' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "location": {
    "lat": 59.93904,
    "lon": 30.31581
  }
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `location` — Координаты
- `location.lat` — Широта
- `location.lon` — Долгота

**Пример ответа (200)**

```json
{
  "country_id": 0,
  "name": "string",
  "iso_3166_alpha2": "string",
  "iso_3166_alpha3": "string",
  "iso_3166_numeric": 0,
  "is_legacy": false
}
```

**Описание полей ответа**
- `country_id` — Идентификатор страны
- `name` — Название страны
- `iso_3166_alpha2` — Двухбуквенный код страны по ISO-3166
- `iso_3166_alpha3` — Трехбуквенный код страны по ISO-3166
- `iso_3166_numeric` — Числовой код страны по ISO-3166
- `is_legacy` — Флаг, обозначающий, что объект является устаревшим. Значение по умолчанию: `false`

**Пример ответа (404)**

```json
{
  "error": "string",
  "reason": "string",
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error` — Текстовый код ошибки
- `reason` — Человекочитаемое описание ошибки
- `details` — Дополнительная информация об ошибке

<a id="post-v1-countries-by-coordinate"></a>

**Версия: OAuth2.0**

Получение страны по координате

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/oauth2/gis-dict/v1/countries/by-coordinate' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "location": {
    "lat": 59.93904,
    "lon": 30.31581
  }
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `location` — Координаты
- `location.lat` — Широта
- `location.lon` — Долгота

**Пример ответа (200)**

```json
{
  "country_id": 0,
  "name": "string",
  "iso_3166_alpha2": "string",
  "iso_3166_alpha3": "string",
  "iso_3166_numeric": 0,
  "is_legacy": false
}
```

**Описание полей ответа**
- `country_id` — Идентификатор страны
- `name` — Название страны
- `iso_3166_alpha2` — Двухбуквенный код страны по ISO-3166
- `iso_3166_alpha3` — Трехбуквенный код страны по ISO-3166
- `iso_3166_numeric` — Числовой код страны по ISO-3166
- `is_legacy` — Флаг, обозначающий, что объект является устаревшим. Значение по умолчанию: `false`

**Пример ответа (404)**

```json
{
  "error": "string",
  "reason": "string",
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error` — Текстовый код ошибки
- `reason` — Человекочитаемое описание ошибки
- `details` — Дополнительная информация об ошибке


## Методы получения направлений

<a id="get-v1-directions"></a>

**Версия: Bearer token**

Получение всех направлений

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/gis-dict/v1/directions' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Пример ответа (200)**

```json
{
  "directions": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}
```

**Описание полей ответа**
- `directions[].id` — Идентификатор направления
- `directions[].name` — Описание направления

<a id="get-v1-directions"></a>

**Версия: OAuth2.0**

Получение всех направлений

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/oauth2/gis-dict/v1/directions' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Пример ответа (200)**

```json
{
  "directions": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}
```

**Описание полей ответа**
- `directions[].id` — Идентификатор направления
- `directions[].name` — Описание направления


<a id="get-v1-direction-from-{from}-to-{to}"></a>

**Версия: Bearer token**

Получение направления между городами

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/gis-dict/v1/direction/from/0/to/0' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Пример ответа (200)**

```json
{
  "id": 0,
  "name": "string"
}
```

**Описание полей ответа**
- `id` — Идентификатор направления. Может быть битовой маской
- `name` — Описание направления. Может быть перечислением направлений

<a id="get-v1-direction-from-{from}-to-{to}"></a>

**Версия: OAuth2.0**

Получение направления между городами

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/oauth2/gis-dict/v1/direction/from/0/to/0' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Пример ответа (200)**

```json
{
  "id": 0,
  "name": "string"
}
```

**Описание полей ответа**
- `id` — Идентификатор направления. Может быть битовой маской
- `name` — Описание направления. Может быть перечислением направлений


## Метод для работы с улицами

<a id="get-v1.0-dictionaries-streetTypes"></a>

Получение списка типов улиц

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/dictionaries/streetTypes' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Пример ответа (200)**

```json
[
  {
    "Id": 0,
    "Id2": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Name": "string",
    "ShortName": "string"
  }
]
```

**Описание полей ответа**
- `[].Id` — Id
- `[].Id2` — Guid
- `[].Name` — Название
- `[].ShortName` — Короткое название


## Автокомплит

Метод автокомплита предназначен для поиска населённых пунктов, регионов, стран или направлений по их названию. Если у вас уже есть идентификатор объекта (код ATI.SU, ФИАС, КЛАДР) или его координаты, рекомендуем использовать соответствующие методы, указанные выше.

Если вы не нашли нужный населённый пункт, попробуйте добавить название района, региона или страны в поисковую строку. Например, вместо слова «Бор» написать «Бор Ленинградская», чтобы найти населённые пункты Бор Ленинградской области.

<a id="post-v1-autocomplete-suggestions"></a>

**Версия: Bearer token**

Автокомплит до населённого пункта

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/gis-dict/v1/autocomplete/suggestions' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "prefix": "санкт",
  "suggestion_types": 15,
  "limit": 15,
  "country_id": 1
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `prefix` — Поисковая строка
- `suggestion_types` — Тип элемента для автокомплита. В запросе может быть маской, в ответе не может быть маской. Значение по умолчанию: `1` Members: 1 - Населённый пункт 2 - Регион 4 - Страна 8 - Направление
- `limit` — Сколько элементов нужно вернуть пользователю Значение по умолчанию: `10`
- `country_id` — Страна по умолчанию для сортировки объектов. Объекты из этой страны будут наверху списка. Если не передать или передать `null`, то для залогиненного пользователя настройка возьмется из кабинета. Значение по умолчанию: `null`

**Пример ответа (200)**

```json
{
  "suggestions": [
    {
      "type": 0,
      "direction": {
        "id": 0,
        "name": "string",
        "short_name": "string"
      },
      "country": {
        "id": 0,
        "name": "string",
        "short_name": "string"
      },
      "region": {
        "id": 0,
        "name": "string",
        "short_name": "string"
      },
      "districts": [
        {
          "id": 0,
          "name": "string",
          "short_name": "string"
        }
      ],
      "subdistrict": {
        "name": "string",
        "short_name": "string"
      },
      "city": {
        "id": 0,
        "name": "string",
        "short_name": "string",
        "city_type": {
          "city_type_id": 0,
          "name": "string",
          "short_name": "string"
        },
        "old_name": "string",
        "alt_name": "string"
      },
      "address": "string",
      "geo_point": {
        "lat": 0.5,
        "lon": 0.5
      }
    }
  ]
}
```

**Описание полей ответа**
- `suggestions[].type` — Тип элемента для автокомплита. В запросе может быть маской, в ответе не может быть маской. Значение по умолчанию: `1` Members: 1 - Населённый пункт 2 - Регион 4 - Страна 8 - Направление
- `suggestions[].direction` — Направление Значение по умолчанию: `null`
- `suggestions[].direction.id` — Идентификатор географического объекта
- `suggestions[].direction.name` — Название географического объекта
- `suggestions[].direction.short_name` — Короткое название географического объекта
- `suggestions[].country` — Страна Значение по умолчанию: `null`
- `suggestions[].country.id` — Идентификатор географического объекта
- `suggestions[].country.name` — Название географического объекта
- `suggestions[].country.short_name` — Короткое название географического объекта
- `suggestions[].region` — Регион Значение по умолчанию: `null`
- `suggestions[].region.id` — Идентификатор географического объекта
- `suggestions[].region.name` — Название географического объекта
- `suggestions[].region.short_name` — Короткое название географического объекта
- `suggestions[].districts` — Районы Значение по умолчанию: `null`
- `suggestions[].districts[].id` — Идентификатор географического объекта
- `suggestions[].districts[].name` — Название географического объекта
- `suggestions[].districts[].short_name` — Короткое название географического объекта
- `suggestions[].subdistrict` — Часть района Значение по умолчанию: `null`
- `suggestions[].subdistrict.name` — Название части района
- `suggestions[].subdistrict.short_name` — Короткое название части района
- `suggestions[].city` — Населённый пункт Значение по умолчанию: `null`
- `suggestions[].city.id` — Идентификатор географического объекта
- `suggestions[].city.name` — Название географического объекта
- `suggestions[].city.short_name` — Короткое название географического объекта
- `suggestions[].city.city_type` — Тип нас. пункта
- `suggestions[].city.city_type.city_type_id` — Идентификатор типа населённого пункта
- `suggestions[].city.city_type.name` — Название типа
- `suggestions[].city.city_type.short_name` — Сокращённое название типа
- `suggestions[].city.old_name` — Старое название Значение по умолчанию: `null`
- `suggestions[].city.alt_name` — Альтернативное название Значение по умолчанию: `null`
- `suggestions[].address` — Адрес
- `suggestions[].geo_point` — Координаты объекта
- `suggestions[].geo_point.lat` — Широта
- `suggestions[].geo_point.lon` — Долгота

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string",
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error` — Текстовый код ошибки
- `reason` — Человекочитаемое описание ошибки
- `details` — Дополнительная информация об ошибке

<a id="post-v1-autocomplete-suggestions"></a>

**Версия: OAuth2.0**

Автокомплит до населённого пункта

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/oauth2/gis-dict/v1/autocomplete/suggestions' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "prefix": "санкт",
  "suggestion_types": 15,
  "limit": 15,
  "country_id": 1
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `prefix` — Поисковая строка
- `suggestion_types` — Тип элемента для автокомплита. В запросе может быть маской, в ответе не может быть маской. Значение по умолчанию: `1` Members: 1 - Населённый пункт 2 - Регион 4 - Страна 8 - Направление
- `limit` — Сколько элементов нужно вернуть пользователю Значение по умолчанию: `10`
- `country_id` — Страна по умолчанию для сортировки объектов. Объекты из этой страны будут наверху списка. Если не передать или передать `null`, то для залогиненного пользователя настройка возьмется из кабинета. Значение по умолчанию: `null`

**Пример ответа (200)**

```json
{
  "suggestions": [
    {
      "type": 0,
      "direction": {
        "id": 0,
        "name": "string",
        "short_name": "string"
      },
      "country": {
        "id": 0,
        "name": "string",
        "short_name": "string"
      },
      "region": {
        "id": 0,
        "name": "string",
        "short_name": "string"
      },
      "districts": [
        {
          "id": 0,
          "name": "string",
          "short_name": "string"
        }
      ],
      "subdistrict": {
        "name": "string",
        "short_name": "string"
      },
      "city": {
        "id": 0,
        "name": "string",
        "short_name": "string",
        "city_type": {
          "city_type_id": 0,
          "name": "string",
          "short_name": "string"
        },
        "old_name": "string",
        "alt_name": "string"
      },
      "address": "string",
      "geo_point": {
        "lat": 0.5,
        "lon": 0.5
      }
    }
  ]
}
```

**Описание полей ответа**
- `suggestions[].type` — Тип элемента для автокомплита. В запросе может быть маской, в ответе не может быть маской. Значение по умолчанию: `1` Members: 1 - Населённый пункт 2 - Регион 4 - Страна 8 - Направление
- `suggestions[].direction` — Направление Значение по умолчанию: `null`
- `suggestions[].direction.id` — Идентификатор географического объекта
- `suggestions[].direction.name` — Название географического объекта
- `suggestions[].direction.short_name` — Короткое название географического объекта
- `suggestions[].country` — Страна Значение по умолчанию: `null`
- `suggestions[].country.id` — Идентификатор географического объекта
- `suggestions[].country.name` — Название географического объекта
- `suggestions[].country.short_name` — Короткое название географического объекта
- `suggestions[].region` — Регион Значение по умолчанию: `null`
- `suggestions[].region.id` — Идентификатор географического объекта
- `suggestions[].region.name` — Название географического объекта
- `suggestions[].region.short_name` — Короткое название географического объекта
- `suggestions[].districts` — Районы Значение по умолчанию: `null`
- `suggestions[].districts[].id` — Идентификатор географического объекта
- `suggestions[].districts[].name` — Название географического объекта
- `suggestions[].districts[].short_name` — Короткое название географического объекта
- `suggestions[].subdistrict` — Часть района Значение по умолчанию: `null`
- `suggestions[].subdistrict.name` — Название части района
- `suggestions[].subdistrict.short_name` — Короткое название части района
- `suggestions[].city` — Населённый пункт Значение по умолчанию: `null`
- `suggestions[].city.id` — Идентификатор географического объекта
- `suggestions[].city.name` — Название географического объекта
- `suggestions[].city.short_name` — Короткое название географического объекта
- `suggestions[].city.city_type` — Тип нас. пункта
- `suggestions[].city.city_type.city_type_id` — Идентификатор типа населённого пункта
- `suggestions[].city.city_type.name` — Название типа
- `suggestions[].city.city_type.short_name` — Сокращённое название типа
- `suggestions[].city.old_name` — Старое название Значение по умолчанию: `null`
- `suggestions[].city.alt_name` — Альтернативное название Значение по умолчанию: `null`
- `suggestions[].address` — Адрес
- `suggestions[].geo_point` — Координаты объекта
- `suggestions[].geo_point.lat` — Широта
- `suggestions[].geo_point.lon` — Долгота

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string",
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error` — Текстовый код ошибки
- `reason` — Человекочитаемое описание ошибки
- `details` — Дополнительная информация об ошибке


## Геокодирование

Эти API методы позволяют преобразовывать координаты в адрес и наоборот, что значительно упрощает работу с адресами. Прямое геокодирование используется для определения координат по адресу или названию. Обратное геокодирование позволяет по координатам определить ближайший адрес.

### Доступ к сервису

Доступ к API методам геокодирования платный, предоставляется по запросу.

Чтобы узнать условия использования, свяжитесь с отделом продаж по телефону +7&nbsp;812&nbsp;602-01-06.

<a id="post-v1-direct-geocoding"></a>

**Версия: Bearer token**

Получение координаты гео-объекта по адресной строке (платный)

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/gis-dict/v1/direct-geocoding' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "address": "Россия, Ленинградская область, Гатчинский муниципальный округ, Вырица, Вокзальная улица, д. 23",
  "exact_in_bounding_box": false,
  "max_level": 3,
  "bounding_box": {
    "sw": {
      "lat": 59.93904,
      "lon": 30.31581
    },
    "ne": {
      "lat": 59.93904,
      "lon": 30.31581
    }
  },
  "count": 1
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `address` — Адресная строка.
- `exact_in_bounding_box` — Флаг, указывающий, что искать объекты нужно строго в области, обозначенной в параметре bounding_box. Для true вне области не ищем. Для false приоритет для объектов внутри области. Если true, то обязательно передавать bounding_box. Значение по умолчанию: `false` ! Зарезервирован на будущее, сейчас не используется.
- `max_level` — Максимальный уровень, до которого необходимо провести гео-кодирование. Возможные значения 1 — страна 2 — область/регион 3 — населённый пункт 4 — улица 5 — дом
- `bounding_box` — Область поиска. Задается координатами нижнего левого угла и верхнего правого. Значение по умолчанию: `null`
- `bounding_box.sw` — Точка, обозначающая нижний левый угол области поиска.
- `bounding_box.sw.lat` — Широта
- `bounding_box.sw.lon` — Долгота
- `bounding_box.ne` — Точка, обозначающая верхний правый угол области поиска.
- `bounding_box.ne.lat` — Широта
- `bounding_box.ne.lon` — Долгота
- `count` — Ограничение количества элементов в выдаче. Диапазон значений от `1` до `10`. Значение по умолчанию: `1`

**Пример ответа (200)**

```json
{
  "max_count_exceeded": false,
  "uncertainty_score": 0,
  "uncertainty_reasons": [
    "string"
  ],
  "suggestions": [
    {
      "uncertainty_score": 0,
      "uncertainty_reasons": [
        "string"
      ],
      "level": 0,
      "country": {
        "id": 0,
        "name": "string",
        "short_name": "string"
      },
      "region": {
        "id": 0,
        "name": "string",
        "short_name": "string"
      },
      "districts": [
        {
          "id": 0,
          "name": "string",
          "short_name": "string"
        }
      ],
      "subdistrict": {
        "name": "string",
        "short_name": "string"
      },
      "city": {
        "id": 0,
        "name": "string",
        "city_type": {
          "city_type_id": 0,
          "name": "string",
          "short_name": "string"
        }
      },
      "geo_point": {
        "lat": 0.5,
        "lon": 0.5
      },
      "name": "string",
      "street": {
        "name": "string",
        "short_name": "string"
      },
      "house": {
        "id": 0,
        "name": "string",
        "short_name": "string"
      }
    }
  ]
}
```

**Описание полей ответа**
- `max_count_exceeded` — Флаг, указывающий, что найдено больше результатов, чем просили в параметре count и требуется уточнение. Значение по умолчанию: `false`
- `uncertainty_score` — Минимальная степень неуверенности в точности распознавания среди всех результатов.
- `uncertainty_reasons` — Ошибки распознавания, которые приводят к тому, что нельзя быть на 100% уверенными в результате
- `suggestions` — Распознанные адреса
- `suggestions[].uncertainty_score` — Степень неуверенности в точности распознавания. Рассчитывается как сумма весов ошибок распознавания из поля uncertainty_reasons. 0 - абсолютно уверены.
- `suggestions[].uncertainty_reasons` — Ошибки распознавания, которые приводят к тому, что нельзя быть на 100% уверенными в результате.
- `suggestions[].level` — Уровень, до которого удалось распознать Возможные значения 1 — страна 2 — область/регион 3 — населённый пункт 4 — улица 5 — дом
- `suggestions[].country` — Название и идентификатор страны Значение по умолчанию: `null`
- `suggestions[].country.id` — Идентификатор географического объекта
- `suggestions[].country.name` — Название географического объекта
- `suggestions[].country.short_name` — Короткое название географического объекта
- `suggestions[].region` — Название и идентификатор региона Значение по умолчанию: `null`
- `suggestions[].region.id` — Идентификатор географического объекта
- `suggestions[].region.name` — Название географического объекта
- `suggestions[].region.short_name` — Короткое название географического объекта
- `suggestions[].districts` — Районы Значение по умолчанию: `null`
- `suggestions[].districts[].id` — Идентификатор географического объекта
- `suggestions[].districts[].name` — Название географического объекта
- `suggestions[].districts[].short_name` — Короткое название географического объекта
- `suggestions[].subdistrict` — Часть района Значение по умолчанию: `null`
- `suggestions[].subdistrict.name` — Название части района
- `suggestions[].subdistrict.short_name` — Короткое название части района
- `suggestions[].city` — Название, идентификатор и тип населённого пункта населённого пункта Значение по умолчанию: `null`
- `suggestions[].city.id` — Идентификатор населённого пункта
- `suggestions[].city.name` — Название населённого пункта
- `suggestions[].city.city_type` — Тип населённого пункта
- `suggestions[].city.city_type.city_type_id` — Идентификатор типа населённого пункта
- `suggestions[].city.city_type.name` — Название типа населённого пункта
- `suggestions[].city.city_type.short_name` — Короткое название типа населённого пункта
- `suggestions[].geo_point` — Координаты объекта, который удалось распознать Значение по умолчанию: `null`
- `suggestions[].geo_point.lat` — Широта
- `suggestions[].geo_point.lon` — Долгота
- `suggestions[].name` — Название для именованных объектов (магазины, склады, месторождения и т.п.) Значение по умолчанию: `null`
- `suggestions[].street` — Название и идентификатор улицы Значение по умолчанию: `null`
- `suggestions[].street.name` — Название улицы
- `suggestions[].street.short_name` — Название улицы с коротким типом
- `suggestions[].house` — Номер и идентификатор дома/строения Значение по умолчанию: `null`
- `suggestions[].house.id` — Идентификатор географического объекта
- `suggestions[].house.name` — Название географического объекта
- `suggestions[].house.short_name` — Короткое название географического объекта

**Пример ответа (400)**

```json
{
  "error_list": [
    {
      "error": "string",
      "reason": "string",
      "details": {
        "any-key": null
      }
    }
  ],
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error_list[].error` — Текстовый код ошибки
- `error_list[].reason` — Человекочитаемое описание ошибки
- `error_list[].details` — Дополнительная информация об ошибке

<a id="post-v1-direct-geocoding"></a>

**Версия: OAuth2.0**

Получение координаты гео-объекта по адресной строке (платный)

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/oauth2/gis-dict/v1/direct-geocoding' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "address": "Россия, Ленинградская область, Гатчинский муниципальный округ, Вырица, Вокзальная улица, д. 23",
  "exact_in_bounding_box": false,
  "max_level": 3,
  "bounding_box": {
    "sw": {
      "lat": 59.93904,
      "lon": 30.31581
    },
    "ne": {
      "lat": 59.93904,
      "lon": 30.31581
    }
  },
  "count": 1
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `address` — Адресная строка.
- `exact_in_bounding_box` — Флаг, указывающий, что искать объекты нужно строго в области, обозначенной в параметре bounding_box. Для true вне области не ищем. Для false приоритет для объектов внутри области. Если true, то обязательно передавать bounding_box. Значение по умолчанию: `false` ! Зарезервирован на будущее, сейчас не используется.
- `max_level` — Максимальный уровень, до которого необходимо провести гео-кодирование. Возможные значения 1 — страна 2 — область/регион 3 — населённый пункт 4 — улица 5 — дом
- `bounding_box` — Область поиска. Задается координатами нижнего левого угла и верхнего правого. Значение по умолчанию: `null`
- `bounding_box.sw` — Точка, обозначающая нижний левый угол области поиска.
- `bounding_box.sw.lat` — Широта
- `bounding_box.sw.lon` — Долгота
- `bounding_box.ne` — Точка, обозначающая верхний правый угол области поиска.
- `bounding_box.ne.lat` — Широта
- `bounding_box.ne.lon` — Долгота
- `count` — Ограничение количества элементов в выдаче. Диапазон значений от `1` до `10`. Значение по умолчанию: `1`

**Пример ответа (200)**

```json
{
  "max_count_exceeded": false,
  "uncertainty_score": 0,
  "uncertainty_reasons": [
    "string"
  ],
  "suggestions": [
    {
      "uncertainty_score": 0,
      "uncertainty_reasons": [
        "string"
      ],
      "level": 0,
      "country": {
        "id": 0,
        "name": "string",
        "short_name": "string"
      },
      "region": {
        "id": 0,
        "name": "string",
        "short_name": "string"
      },
      "districts": [
        {
          "id": 0,
          "name": "string",
          "short_name": "string"
        }
      ],
      "subdistrict": {
        "name": "string",
        "short_name": "string"
      },
      "city": {
        "id": 0,
        "name": "string",
        "city_type": {
          "city_type_id": 0,
          "name": "string",
          "short_name": "string"
        }
      },
      "geo_point": {
        "lat": 0.5,
        "lon": 0.5
      },
      "name": "string",
      "street": {
        "name": "string",
        "short_name": "string"
      },
      "house": {
        "id": 0,
        "name": "string",
        "short_name": "string"
      }
    }
  ]
}
```

**Описание полей ответа**
- `max_count_exceeded` — Флаг, указывающий, что найдено больше результатов, чем просили в параметре count и требуется уточнение. Значение по умолчанию: `false`
- `uncertainty_score` — Минимальная степень неуверенности в точности распознавания среди всех результатов.
- `uncertainty_reasons` — Ошибки распознавания, которые приводят к тому, что нельзя быть на 100% уверенными в результате
- `suggestions` — Распознанные адреса
- `suggestions[].uncertainty_score` — Степень неуверенности в точности распознавания. Рассчитывается как сумма весов ошибок распознавания из поля uncertainty_reasons. 0 - абсолютно уверены.
- `suggestions[].uncertainty_reasons` — Ошибки распознавания, которые приводят к тому, что нельзя быть на 100% уверенными в результате.
- `suggestions[].level` — Уровень, до которого удалось распознать Возможные значения 1 — страна 2 — область/регион 3 — населённый пункт 4 — улица 5 — дом
- `suggestions[].country` — Название и идентификатор страны Значение по умолчанию: `null`
- `suggestions[].country.id` — Идентификатор географического объекта
- `suggestions[].country.name` — Название географического объекта
- `suggestions[].country.short_name` — Короткое название географического объекта
- `suggestions[].region` — Название и идентификатор региона Значение по умолчанию: `null`
- `suggestions[].region.id` — Идентификатор географического объекта
- `suggestions[].region.name` — Название географического объекта
- `suggestions[].region.short_name` — Короткое название географического объекта
- `suggestions[].districts` — Районы Значение по умолчанию: `null`
- `suggestions[].districts[].id` — Идентификатор географического объекта
- `suggestions[].districts[].name` — Название географического объекта
- `suggestions[].districts[].short_name` — Короткое название географического объекта
- `suggestions[].subdistrict` — Часть района Значение по умолчанию: `null`
- `suggestions[].subdistrict.name` — Название части района
- `suggestions[].subdistrict.short_name` — Короткое название части района
- `suggestions[].city` — Название, идентификатор и тип населённого пункта населённого пункта Значение по умолчанию: `null`
- `suggestions[].city.id` — Идентификатор населённого пункта
- `suggestions[].city.name` — Название населённого пункта
- `suggestions[].city.city_type` — Тип населённого пункта
- `suggestions[].city.city_type.city_type_id` — Идентификатор типа населённого пункта
- `suggestions[].city.city_type.name` — Название типа населённого пункта
- `suggestions[].city.city_type.short_name` — Короткое название типа населённого пункта
- `suggestions[].geo_point` — Координаты объекта, который удалось распознать Значение по умолчанию: `null`
- `suggestions[].geo_point.lat` — Широта
- `suggestions[].geo_point.lon` — Долгота
- `suggestions[].name` — Название для именованных объектов (магазины, склады, месторождения и т.п.) Значение по умолчанию: `null`
- `suggestions[].street` — Название и идентификатор улицы Значение по умолчанию: `null`
- `suggestions[].street.name` — Название улицы
- `suggestions[].street.short_name` — Название улицы с коротким типом
- `suggestions[].house` — Номер и идентификатор дома/строения Значение по умолчанию: `null`
- `suggestions[].house.id` — Идентификатор географического объекта
- `suggestions[].house.name` — Название географического объекта
- `suggestions[].house.short_name` — Короткое название географического объекта

**Пример ответа (400)**

```json
{
  "error_list": [
    {
      "error": "string",
      "reason": "string",
      "details": {
        "any-key": null
      }
    }
  ],
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error_list[].error` — Текстовый код ошибки
- `error_list[].reason` — Человекочитаемое описание ошибки
- `error_list[].details` — Дополнительная информация об ошибке


Метод нужен для определения адресного объекта по координате

<a id="post-v1-reverse-geocoding"></a>

**Версия: Bearer token**

Получение адресной структуры гео-объекта по координате (платный)

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/gis-dict/v1/reverse-geocoding' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "location": {
    "lat": 59.93904,
    "lon": 30.31581
  },
  "max_level": 3,
  "count": 1
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `location` — Координаты точки, от которой необходимо провести обратное гео-кодирование.
- `location.lat` — Широта
- `location.lon` — Долгота
- `max_level` — Максимальный уровень, до которого необходимо провести гео-кодирование. Возможные значения 1 — страна 2 — область/регион 3 — населённый пункт 4 — улица 5 — дом
- `count` — Ограничение количества элементов в выдаче. Диапазон значений от `1` до `10`. Значение по умолчанию: `1`

**Пример ответа (200)**

```json
{
  "max_count_exceeded": false,
  "uncertainty_score": 0,
  "uncertainty_reasons": [
    "string"
  ],
  "suggestions": [
    {
      "uncertainty_score": 0,
      "uncertainty_reasons": [
        "string"
      ],
      "level": 0,
      "country": {
        "id": 0,
        "name": "string",
        "short_name": "string"
      },
      "region": {
        "id": 0,
        "name": "string",
        "short_name": "string"
      },
      "districts": [
        {
          "id": 0,
          "name": "string",
          "short_name": "string"
        }
      ],
      "subdistrict": {
        "name": "string",
        "short_name": "string"
      },
      "city": {
        "id": 0,
        "name": "string",
        "city_type": {
          "city_type_id": 0,
          "name": "string",
          "short_name": "string"
        }
      },
      "geo_point": {
        "lat": 0.5,
        "lon": 0.5
      },
      "name": "string",
      "street": {
        "name": "string",
        "short_name": "string"
      },
      "house": {
        "id": 0,
        "name": "string",
        "short_name": "string"
      }
    }
  ]
}
```

**Описание полей ответа**
- `max_count_exceeded` — Флаг, указывающий, что найдено больше результатов, чем просили в параметре count и требуется уточнение. Значение по умолчанию: `false`
- `uncertainty_score` — Минимальная степень неуверенности в точности распознавания среди всех результатов.
- `uncertainty_reasons` — Ошибки распознавания, которые приводят к тому, что нельзя быть на 100% уверенными в результате
- `suggestions` — Распознанные адреса
- `suggestions[].uncertainty_score` — Степень неуверенности в точности распознавания. Рассчитывается как сумма весов ошибок распознавания из поля uncertainty_reasons. 0 - абсолютно уверены.
- `suggestions[].uncertainty_reasons` — Ошибки распознавания, которые приводят к тому, что нельзя быть на 100% уверенными в результате.
- `suggestions[].level` — Уровень, до которого удалось распознать Возможные значения 1 — страна 2 — область/регион 3 — населённый пункт 4 — улица 5 — дом
- `suggestions[].country` — Название и идентификатор страны Значение по умолчанию: `null`
- `suggestions[].country.id` — Идентификатор географического объекта
- `suggestions[].country.name` — Название географического объекта
- `suggestions[].country.short_name` — Короткое название географического объекта
- `suggestions[].region` — Название и идентификатор региона Значение по умолчанию: `null`
- `suggestions[].region.id` — Идентификатор географического объекта
- `suggestions[].region.name` — Название географического объекта
- `suggestions[].region.short_name` — Короткое название географического объекта
- `suggestions[].districts` — Районы Значение по умолчанию: `null`
- `suggestions[].districts[].id` — Идентификатор географического объекта
- `suggestions[].districts[].name` — Название географического объекта
- `suggestions[].districts[].short_name` — Короткое название географического объекта
- `suggestions[].subdistrict` — Часть района Значение по умолчанию: `null`
- `suggestions[].subdistrict.name` — Название части района
- `suggestions[].subdistrict.short_name` — Короткое название части района
- `suggestions[].city` — Название, идентификатор и тип населённого пункта населённого пункта Значение по умолчанию: `null`
- `suggestions[].city.id` — Идентификатор населённого пункта
- `suggestions[].city.name` — Название населённого пункта
- `suggestions[].city.city_type` — Тип населённого пункта
- `suggestions[].city.city_type.city_type_id` — Идентификатор типа населённого пункта
- `suggestions[].city.city_type.name` — Название типа населённого пункта
- `suggestions[].city.city_type.short_name` — Короткое название типа населённого пункта
- `suggestions[].geo_point` — Координаты объекта, который удалось распознать Значение по умолчанию: `null`
- `suggestions[].geo_point.lat` — Широта
- `suggestions[].geo_point.lon` — Долгота
- `suggestions[].name` — Название для именованных объектов (магазины, склады, месторождения и т.п.) Значение по умолчанию: `null`
- `suggestions[].street` — Название и идентификатор улицы Значение по умолчанию: `null`
- `suggestions[].street.name` — Название улицы
- `suggestions[].street.short_name` — Название улицы с коротким типом
- `suggestions[].house` — Номер и идентификатор дома/строения Значение по умолчанию: `null`
- `suggestions[].house.id` — Идентификатор географического объекта
- `suggestions[].house.name` — Название географического объекта
- `suggestions[].house.short_name` — Короткое название географического объекта

**Пример ответа (400)**

```json
{
  "error_list": [
    {
      "error": "string",
      "reason": "string",
      "details": {
        "any-key": null
      }
    }
  ],
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error_list[].error` — Текстовый код ошибки
- `error_list[].reason` — Человекочитаемое описание ошибки
- `error_list[].details` — Дополнительная информация об ошибке

<a id="post-v1-reverse-geocoding"></a>

**Версия: OAuth2.0**

Получение адресной структуры гео-объекта по координате (платный)

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/oauth2/gis-dict/v1/reverse-geocoding' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "location": {
    "lat": 59.93904,
    "lon": 30.31581
  },
  "max_level": 3,
  "count": 1
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Описание полей запроса**
- `location` — Координаты точки, от которой необходимо провести обратное гео-кодирование.
- `location.lat` — Широта
- `location.lon` — Долгота
- `max_level` — Максимальный уровень, до которого необходимо провести гео-кодирование. Возможные значения 1 — страна 2 — область/регион 3 — населённый пункт 4 — улица 5 — дом
- `count` — Ограничение количества элементов в выдаче. Диапазон значений от `1` до `10`. Значение по умолчанию: `1`

**Пример ответа (200)**

```json
{
  "max_count_exceeded": false,
  "uncertainty_score": 0,
  "uncertainty_reasons": [
    "string"
  ],
  "suggestions": [
    {
      "uncertainty_score": 0,
      "uncertainty_reasons": [
        "string"
      ],
      "level": 0,
      "country": {
        "id": 0,
        "name": "string",
        "short_name": "string"
      },
      "region": {
        "id": 0,
        "name": "string",
        "short_name": "string"
      },
      "districts": [
        {
          "id": 0,
          "name": "string",
          "short_name": "string"
        }
      ],
      "subdistrict": {
        "name": "string",
        "short_name": "string"
      },
      "city": {
        "id": 0,
        "name": "string",
        "city_type": {
          "city_type_id": 0,
          "name": "string",
          "short_name": "string"
        }
      },
      "geo_point": {
        "lat": 0.5,
        "lon": 0.5
      },
      "name": "string",
      "street": {
        "name": "string",
        "short_name": "string"
      },
      "house": {
        "id": 0,
        "name": "string",
        "short_name": "string"
      }
    }
  ]
}
```

**Описание полей ответа**
- `max_count_exceeded` — Флаг, указывающий, что найдено больше результатов, чем просили в параметре count и требуется уточнение. Значение по умолчанию: `false`
- `uncertainty_score` — Минимальная степень неуверенности в точности распознавания среди всех результатов.
- `uncertainty_reasons` — Ошибки распознавания, которые приводят к тому, что нельзя быть на 100% уверенными в результате
- `suggestions` — Распознанные адреса
- `suggestions[].uncertainty_score` — Степень неуверенности в точности распознавания. Рассчитывается как сумма весов ошибок распознавания из поля uncertainty_reasons. 0 - абсолютно уверены.
- `suggestions[].uncertainty_reasons` — Ошибки распознавания, которые приводят к тому, что нельзя быть на 100% уверенными в результате.
- `suggestions[].level` — Уровень, до которого удалось распознать Возможные значения 1 — страна 2 — область/регион 3 — населённый пункт 4 — улица 5 — дом
- `suggestions[].country` — Название и идентификатор страны Значение по умолчанию: `null`
- `suggestions[].country.id` — Идентификатор географического объекта
- `suggestions[].country.name` — Название географического объекта
- `suggestions[].country.short_name` — Короткое название географического объекта
- `suggestions[].region` — Название и идентификатор региона Значение по умолчанию: `null`
- `suggestions[].region.id` — Идентификатор географического объекта
- `suggestions[].region.name` — Название географического объекта
- `suggestions[].region.short_name` — Короткое название географического объекта
- `suggestions[].districts` — Районы Значение по умолчанию: `null`
- `suggestions[].districts[].id` — Идентификатор географического объекта
- `suggestions[].districts[].name` — Название географического объекта
- `suggestions[].districts[].short_name` — Короткое название географического объекта
- `suggestions[].subdistrict` — Часть района Значение по умолчанию: `null`
- `suggestions[].subdistrict.name` — Название части района
- `suggestions[].subdistrict.short_name` — Короткое название части района
- `suggestions[].city` — Название, идентификатор и тип населённого пункта населённого пункта Значение по умолчанию: `null`
- `suggestions[].city.id` — Идентификатор населённого пункта
- `suggestions[].city.name` — Название населённого пункта
- `suggestions[].city.city_type` — Тип населённого пункта
- `suggestions[].city.city_type.city_type_id` — Идентификатор типа населённого пункта
- `suggestions[].city.city_type.name` — Название типа населённого пункта
- `suggestions[].city.city_type.short_name` — Короткое название типа населённого пункта
- `suggestions[].geo_point` — Координаты объекта, который удалось распознать Значение по умолчанию: `null`
- `suggestions[].geo_point.lat` — Широта
- `suggestions[].geo_point.lon` — Долгота
- `suggestions[].name` — Название для именованных объектов (магазины, склады, месторождения и т.п.) Значение по умолчанию: `null`
- `suggestions[].street` — Название и идентификатор улицы Значение по умолчанию: `null`
- `suggestions[].street.name` — Название улицы
- `suggestions[].street.short_name` — Название улицы с коротким типом
- `suggestions[].house` — Номер и идентификатор дома/строения Значение по умолчанию: `null`
- `suggestions[].house.id` — Идентификатор географического объекта
- `suggestions[].house.name` — Название географического объекта
- `suggestions[].house.short_name` — Короткое название географического объекта

**Пример ответа (400)**

```json
{
  "error_list": [
    {
      "error": "string",
      "reason": "string",
      "details": {
        "any-key": null
      }
    }
  ],
  "details": {
    "any-key": null
  }
}
```

**Описание полей ответа**
- `error_list[].error` — Текстовый код ошибки
- `error_list[].reason` — Человекочитаемое описание ошибки
- `error_list[].details` — Дополнительная информация об ошибке


## Устаревшие методы

:::danger
Методы будут доступны до 1 апреля 2026 года — после этого они будут отключены.
:::

<a id="get-v1.0-dictionaries-cities"></a>

Получение списка всех городов с возможностью поиска по префиксу имени, по id городов или только по названию города

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/dictionaries/cities?name=string&cityNameOnly=false' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Пример ответа (200)**

```json
[
  {
    "Id2": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "CityId": 0,
    "RegionId": 0,
    "CountryId": 0,
    "FullName": "string",
    "ShortName": "string",
    "FullNameEng": "string",
    "ShortNameEng": "string",
    "IsRegionalCenter": false,
    "CitySize": 0,
    "FiasId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Longitude": 0.5,
    "Latitude": 0.5,
    "CityName": "string",
    "RegionName": "string",
    "CountryName": "string",
    "CityNameEng": "string",
    "RegionNameEng": "string",
    "CountryNameEng": "string",
    "CountryCodeName": "string"
  }
]
```

**Описание полей ответа**
- `[].CityId` — Id города
- `[].RegionId` — Id региона
- `[].CountryId` — Id страны
- `[].FullName` — Составное название состоящее из названий города, региона и страны разделенные через запятую
- `[].ShortName` — Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)
- `[].FullNameEng` — Составное название состоящее из названий города, региона и страны разделенные через запятую, на английском
- `[].ShortNameEng` — Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России), на английском
- `[].IsRegionalCenter` — Является ли город региональным центром
- `[].CitySize` — Размер города по числу жителей
- `[].FiasId` — идентификатор в базе данных ФИАС
- `[].Longitude` — Долгота города
- `[].Latitude` — Широта города
- `[].CityName` — Название города
- `[].RegionName` — Название региона
- `[].CountryName` — Название страны
- `[].CityNameEng` — Название города на английском
- `[].RegionNameEng` — Название региона на английском
- `[].CountryNameEng` — Название страны на английском
- `[].CountryCodeName` — Буквенный код страны


<a id="get-v1.0-dictionaries-cities-byfias-{fias}"></a>

Получение конкретного города по его идентификатору в базе ФИАС

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/dictionaries/cities/byfias/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Пример ответа (200)**

```json
{
  "Id2": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "CityId": 0,
  "RegionId": 0,
  "CountryId": 0,
  "FullName": "string",
  "ShortName": "string",
  "FullNameEng": "string",
  "ShortNameEng": "string",
  "IsRegionalCenter": false,
  "CitySize": 0,
  "FiasId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Longitude": 0.5,
  "Latitude": 0.5,
  "CityName": "string",
  "RegionName": "string",
  "CountryName": "string",
  "CityNameEng": "string",
  "RegionNameEng": "string",
  "CountryNameEng": "string",
  "CountryCodeName": "string"
}
```

**Описание полей ответа**
- `CityId` — Id города
- `RegionId` — Id региона
- `CountryId` — Id страны
- `FullName` — Составное название состоящее из названий города, региона и страны разделенные через запятую
- `ShortName` — Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)
- `FullNameEng` — Составное название состоящее из названий города, региона и страны разделенные через запятую, на английском
- `ShortNameEng` — Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России), на английском
- `IsRegionalCenter` — Является ли город региональным центром
- `CitySize` — Размер города по числу жителей
- `FiasId` — идентификатор в базе данных ФИАС
- `Longitude` — Долгота города
- `Latitude` — Широта города
- `CityName` — Название города
- `RegionName` — Название региона
- `CountryName` — Название страны
- `CityNameEng` — Название города на английском
- `RegionNameEng` — Название региона на английском
- `CountryNameEng` — Название страны на английском
- `CountryCodeName` — Буквенный код страны

**Пример ответа (404)**

```json
{
  "Reason": "string",
  "Error": "string"
}
```

**Описание полей ответа**
- `Reason` — Причина ошибки
- `Error` — Ключ ошибки


<a id="get-v1.0-dictionaries-cities-{cityId}"></a>

Получение конкретного города по его идентификатору

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/dictionaries/cities/0' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Пример ответа (200)**

```json
{
  "Id2": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "CityId": 0,
  "RegionId": 0,
  "CountryId": 0,
  "FullName": "string",
  "ShortName": "string",
  "FullNameEng": "string",
  "ShortNameEng": "string",
  "IsRegionalCenter": false,
  "CitySize": 0,
  "FiasId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Longitude": 0.5,
  "Latitude": 0.5,
  "CityName": "string",
  "RegionName": "string",
  "CountryName": "string",
  "CityNameEng": "string",
  "RegionNameEng": "string",
  "CountryNameEng": "string",
  "CountryCodeName": "string"
}
```

**Описание полей ответа**
- `CityId` — Id города
- `RegionId` — Id региона
- `CountryId` — Id страны
- `FullName` — Составное название состоящее из названий города, региона и страны разделенные через запятую
- `ShortName` — Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)
- `FullNameEng` — Составное название состоящее из названий города, региона и страны разделенные через запятую, на английском
- `ShortNameEng` — Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России), на английском
- `IsRegionalCenter` — Является ли город региональным центром
- `CitySize` — Размер города по числу жителей
- `FiasId` — идентификатор в базе данных ФИАС
- `Longitude` — Долгота города
- `Latitude` — Широта города
- `CityName` — Название города
- `RegionName` — Название региона
- `CountryName` — Название страны
- `CityNameEng` — Название города на английском
- `RegionNameEng` — Название региона на английском
- `CountryNameEng` — Название страны на английском
- `CountryCodeName` — Буквенный код страны

**Пример ответа (404)**

```json
{
  "Reason": "string",
  "Error": "string"
}
```

**Описание полей ответа**
- `Reason` — Причина ошибки
- `Error` — Ключ ошибки


<a id="get-v1.0-dictionaries-regions"></a>

Получение списка регионов

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/dictionaries/regions' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Пример ответа (200)**

```json
[
  {
    "Id": 0,
    "Id2": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Name": "string",
    "NameEng": "string",
    "RegionClearName": "string",
    "RegionTypeAbbr": "string",
    "CountryId": 0,
    "RegionCode": "string"
  }
]
```

**Описание полей ответа**
- `[].Id` — Id
- `[].Id2` — Guid
- `[].Name` — Название
- `[].NameEng` — Название на английском
- `[].RegionClearName` — Только название области или края. Напр, Московская область -> Московская
- `[].RegionTypeAbbr` — Тип региона. Напр, Московская область -> обл.
- `[].CountryId` — Id страны
- `[].RegionCode` — Код региона


<a id="post-compass-v1-locations-parse"></a>

Получение города, соответствующего указанному адресу

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/dictionaries/locations/parse' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '[
  "string"
]'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Пример ответа (200)**

```json
{
  "any-key": {
    "city_id": 0,
    "is_success": false,
    "street": "string"
  }
}
```

**Описание полей ответа**
- `any-key.city_id` — Id города
- `any-key.is_success` — Геокодирование завершено успешно
- `any-key.street` — Улица/район


Актуальный метод получения ближайших городов переехал в раздел [Расчёт расстояний](https://ati.su/developers/raw/paid-api/route.md)

<a id="get-v1.0-dictionaries-cities-{cityId}-near"></a>

Получение списка ближайших городов по городу

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/dictionaries/cities/0/near?count=0&radius=0&largeCityCount=0' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/geo.openapi.json)

**Пример ответа (200)**

```json
[
  {
    "Id2": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "CityId": 0,
    "RegionId": 0,
    "CountryId": 0,
    "FullName": "string",
    "ShortName": "string",
    "FullNameEng": "string",
    "ShortNameEng": "string",
    "IsRegionalCenter": false,
    "CitySize": 0,
    "FiasId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Longitude": 0.5,
    "Latitude": 0.5,
    "CityName": "string",
    "RegionName": "string",
    "CountryName": "string",
    "CityNameEng": "string",
    "RegionNameEng": "string",
    "CountryNameEng": "string",
    "CountryCodeName": "string"
  }
]
```

**Описание полей ответа**
- `[].CityId` — Id города
- `[].RegionId` — Id региона
- `[].CountryId` — Id страны
- `[].FullName` — Составное название состоящее из названий города, региона и страны разделенные через запятую
- `[].ShortName` — Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)
- `[].FullNameEng` — Составное название состоящее из названий города, региона и страны разделенные через запятую, на английском
- `[].ShortNameEng` — Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России), на английском
- `[].IsRegionalCenter` — Является ли город региональным центром
- `[].CitySize` — Размер города по числу жителей
- `[].FiasId` — идентификатор в базе данных ФИАС
- `[].Longitude` — Долгота города
- `[].Latitude` — Широта города
- `[].CityName` — Название города
- `[].RegionName` — Название региона
- `[].CountryName` — Название страны
- `[].CityNameEng` — Название города на английском
- `[].RegionNameEng` — Название региона на английском
- `[].CountryNameEng` — Название страны на английском
- `[].CountryCodeName` — Буквенный код страны

**Пример ответа (404)**

```json
{
  "Reason": "string",
  "Error": "string"
}
```

**Описание полей ответа**
- `Reason` — Причина ошибки
- `Error` — Ключ ошибки