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

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

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

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

База данных расширяется, но если вы не нашли необходимый населённый пункт, обратитесь в чат поддержки по API.

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

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

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

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

post

/gw/gis-dict/v1/cities/by-ids

Развернуть все Свернуть все

body

{...}

ids*: [int32]

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

Допустимое количество элементов от 1 до 1000

}

CURL

Копировать

Пример ответа

Ответ

200 OK

Развернуть все Свернуть все

Пример

Модель

{...}

"cities":[...]

{...}

"country_id":0,

"federal_district_id":0,

"region_id":0,

"district_ids":[...],

"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*:[{...}]

Модель, описывающая сущность "Населённый пункт"

city_id*: int32

Идентификатор населённого пункта

read only

country_id*: int32

Идентификатор страны

federal_district_id: int32 (nullable)

Идентификатор федерального округа

Значение по умолчанию: null

region_id: int32 (nullable)

Идентификатор региона

Значение по умолчанию: null

district_ids: [int32]

Идентификаторы районов

Значение по умолчанию: null

name*: string

Название населённого пункта

alt_name: string (nullable)

Альтернативное название населённого пункта

Значение по умолчанию: null

old_name: string (nullable)

Старое название населённого пункта

Значение по умолчанию: null

subdistrict: string (nullable)

Часть района

Значение по умолчанию: null

short_subdistrict: string (nullable)

Часть района с сокращениями типа

Значение по умолчанию: null

fias_id: uuid (nullable)

Идентификатор ФИАС

Значение по умолчанию: null

kladr: string (nullable)

Идентификатор КЛАДР

Значение по умолчанию: null

okato: string (nullable)

Код ОКАТО

Значение по умолчанию: null

oktmo: string (nullable)

Код ОКТМО

Значение по умолчанию: null

is_regional_center: boolean

Является ли населённый пункт региональным центром

Значение по умолчанию: false

is_district_center: boolean

Является ли населённый пункт районным центром

Значение по умолчанию: false

size*: enum

[1, 2, 3, 4, 5, 6]

Размер населённого пункта.

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

lat: double

Широта

lon: double

Долгота

}

city_type_id: int32 (nullable)

Идентификатор типа населённого пункта

Значение по умолчанию: null

timezone: string (nullable)

Часовой пояс в формате IANA.

Значение по умолчанию: null

clarified_name*: string

Название населённого пункта с уточнением типа и района при необходимости Если в регионе несколько населённых пунктов с одинаковым названием, то для них добавляется уточнение

legacy_attributes: int32 (nullable)

Атрибуты устаревшей записи населённого пункта

Возвращаются только для населенных пунктов, помеченных как is_legacy=true. Значение по умолчанию: null

is_legacy: boolean

Флаг, обозначающий, что объект является устаревшим

Значение по умолчанию: false

}]

}

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string",

"details":{...}

"any-key":null

}

{...}

error: string

Текстовый код ошибки

reason: string

Человекочитаемое описание ошибки

details:{...}

Дополнительная информация об ошибке

any-key: {missing-type-info}

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

post

/gw/gis-dict/v1/cities/by-coordinate

Развернуть все Свернуть все

body

{...}

location*:{...}

Координаты

lat*: double

Широта

lon*: double

Долгота

}

CURL

Копировать

Пример ответа

Ответ

200 OK

Развернуть все Свернуть все

Пример

Модель

{...}

"country_id":0,

"federal_district_id":0,

"region_id":0,

"district_ids":[...],

"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

}

{...}

Модель, описывающая сущность "Населённый пункт"

city_id*: int32

Идентификатор населённого пункта

read only

country_id*: int32

Идентификатор страны

federal_district_id: int32 (nullable)

Идентификатор федерального округа

Значение по умолчанию: null

region_id: int32 (nullable)

Идентификатор региона

Значение по умолчанию: null

district_ids: [int32]

Идентификаторы районов

Значение по умолчанию: null

name*: string

Название населённого пункта

alt_name: string (nullable)

Альтернативное название населённого пункта

Значение по умолчанию: null

old_name: string (nullable)

Старое название населённого пункта

Значение по умолчанию: null

subdistrict: string (nullable)

Часть района

Значение по умолчанию: null

short_subdistrict: string (nullable)

Часть района с сокращениями типа

Значение по умолчанию: null

fias_id: uuid (nullable)

Идентификатор ФИАС

Значение по умолчанию: null

kladr: string (nullable)

Идентификатор КЛАДР

Значение по умолчанию: null

okato: string (nullable)

Код ОКАТО

Значение по умолчанию: null

oktmo: string (nullable)

Код ОКТМО

Значение по умолчанию: null

is_regional_center: boolean

Является ли населённый пункт региональным центром

Значение по умолчанию: false

is_district_center: boolean

Является ли населённый пункт районным центром

Значение по умолчанию: false

size*: enum

[1, 2, 3, 4, 5, 6]

Размер населённого пункта.

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

lat: double

Широта

lon: double

Долгота

}

city_type_id: int32 (nullable)

Идентификатор типа населённого пункта

Значение по умолчанию: null

timezone: string (nullable)

Часовой пояс в формате IANA.

Значение по умолчанию: null

clarified_name*: string

legacy_attributes: int32 (nullable)

Атрибуты устаревшей записи населённого пункта

Возвращаются только для населенных пунктов, помеченных как is_legacy=true. Значение по умолчанию: null

is_legacy: boolean

Флаг, обозначающий, что объект является устаревшим

Значение по умолчанию: false

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string",

"details":{...}

"any-key":null

}

{...}

error: string

Текстовый код ошибки

reason: string

Человекочитаемое описание ошибки

details:{...}

Дополнительная информация об ошибке

any-key: {missing-type-info}

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

post

/gw/gis-dict/v1/cities/by-fias-ids

Развернуть все Свернуть все

body

{...}

fias_ids*: [uuid]

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

Допустимое количество элементов от 1 до 1000

}

CURL

Копировать

Пример ответа

Ответ

200 OK

Развернуть все Свернуть все

Пример

Модель

{...}

"cities":[...]

{...}

"country_id":0,

"federal_district_id":0,

"region_id":0,

"district_ids":[...],

"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*:[{...}]

Модель, описывающая сущность "Населённый пункт"

city_id*: int32

Идентификатор населённого пункта

read only

country_id*: int32

Идентификатор страны

federal_district_id: int32 (nullable)

Идентификатор федерального округа

Значение по умолчанию: null

region_id: int32 (nullable)

Идентификатор региона

Значение по умолчанию: null

district_ids: [int32]

Идентификаторы районов

Значение по умолчанию: null

name*: string

Название населённого пункта

alt_name: string (nullable)

Альтернативное название населённого пункта

Значение по умолчанию: null

old_name: string (nullable)

Старое название населённого пункта

Значение по умолчанию: null

subdistrict: string (nullable)

Часть района

Значение по умолчанию: null

short_subdistrict: string (nullable)

Часть района с сокращениями типа

Значение по умолчанию: null

fias_id: uuid (nullable)

Идентификатор ФИАС

Значение по умолчанию: null

kladr: string (nullable)

Идентификатор КЛАДР

Значение по умолчанию: null

okato: string (nullable)

Код ОКАТО

Значение по умолчанию: null

oktmo: string (nullable)

Код ОКТМО

Значение по умолчанию: null

is_regional_center: boolean

Является ли населённый пункт региональным центром

Значение по умолчанию: false

is_district_center: boolean

Является ли населённый пункт районным центром

Значение по умолчанию: false

size*: enum

[1, 2, 3, 4, 5, 6]

Размер населённого пункта.

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

lat: double

Широта

lon: double

Долгота

}

city_type_id: int32 (nullable)

Идентификатор типа населённого пункта

Значение по умолчанию: null

timezone: string (nullable)

Часовой пояс в формате IANA.

Значение по умолчанию: null

clarified_name*: string

legacy_attributes: int32 (nullable)

Атрибуты устаревшей записи населённого пункта

Возвращаются только для населенных пунктов, помеченных как is_legacy=true. Значение по умолчанию: null

is_legacy: boolean

Флаг, обозначающий, что объект является устаревшим

Значение по умолчанию: false

}]

}

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string",

"details":{...}

"any-key":null

}

{...}

error: string

Текстовый код ошибки

reason: string

Человекочитаемое описание ошибки

details:{...}

Дополнительная информация об ошибке

any-key: {missing-type-info}

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

post

/gw/gis-dict/v1/cities/by-kladr-codes

Развернуть все Свернуть все

body

{...}

kladr_codes*: [string]

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

Допустимое количество элементов от 1 до 1000

}

CURL

Копировать

Пример ответа

Ответ

200 OK

Развернуть все Свернуть все

Пример

Модель

{...}

"cities":[...]

{...}

"country_id":0,

"federal_district_id":0,

"region_id":0,

"district_ids":[...],

"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*:[{...}]

Модель, описывающая сущность "Населённый пункт"

city_id*: int32

Идентификатор населённого пункта

read only

country_id*: int32

Идентификатор страны

federal_district_id: int32 (nullable)

Идентификатор федерального округа

Значение по умолчанию: null

region_id: int32 (nullable)

Идентификатор региона

Значение по умолчанию: null

district_ids: [int32]

Идентификаторы районов

Значение по умолчанию: null

name*: string

Название населённого пункта

alt_name: string (nullable)

Альтернативное название населённого пункта

Значение по умолчанию: null

old_name: string (nullable)

Старое название населённого пункта

Значение по умолчанию: null

subdistrict: string (nullable)

Часть района

Значение по умолчанию: null

short_subdistrict: string (nullable)

Часть района с сокращениями типа

Значение по умолчанию: null

fias_id: uuid (nullable)

Идентификатор ФИАС

Значение по умолчанию: null

kladr: string (nullable)

Идентификатор КЛАДР

Значение по умолчанию: null

okato: string (nullable)

Код ОКАТО

Значение по умолчанию: null

oktmo: string (nullable)

Код ОКТМО

Значение по умолчанию: null

is_regional_center: boolean

Является ли населённый пункт региональным центром

Значение по умолчанию: false

is_district_center: boolean

Является ли населённый пункт районным центром

Значение по умолчанию: false

size*: enum

[1, 2, 3, 4, 5, 6]

Размер населённого пункта.

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

lat: double

Широта

lon: double

Долгота

}

city_type_id: int32 (nullable)

Идентификатор типа населённого пункта

Значение по умолчанию: null

timezone: string (nullable)

Часовой пояс в формате IANA.

Значение по умолчанию: null

clarified_name*: string

legacy_attributes: int32 (nullable)

Атрибуты устаревшей записи населённого пункта

Возвращаются только для населенных пунктов, помеченных как is_legacy=true. Значение по умолчанию: null

is_legacy: boolean

Флаг, обозначающий, что объект является устаревшим

Значение по умолчанию: false

}]

}

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string",

"details":{...}

"any-key":null

}

{...}

error: string

Текстовый код ошибки

reason: string

Человекочитаемое описание ошибки

details:{...}

Дополнительная информация об ошибке

any-key: {missing-type-info}

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

get

/gw/gis-dict/v1/city-types

CURL

Копировать

Пример ответа

Ответ

200 OK

Развернуть все Свернуть все

Пример

Модель

{...}

"city_types":[...]

{...}

"city_type_id":0,

"name":"string",

"short_name":"string"

}

]

}

{...}

city_types*:[{...}]

Модель, описывающая сущность "Тип населённого пункта"

city_type_id*: int32

Идентификатор типа населённого пункта

name*: string

Название типа

short_name*: string

Сокращённое название типа

}]

}

304 Not Modified

Развернуть все Свернуть все

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

get

/v1.0/dictionaries/cities/{cityId}/near

cityId

int32

Идентификатор города

count

int32

Количество БКГ

radius

int32

Радиус в км

largeCityCount

int32

Размер БКГ

CURL

Копировать

Пример ответа

Ответ

200 Города

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"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"

}

]

[{...}]

Id2: guid

CityId: int32

Id города

RegionId: int32 (nullable)

Id региона

CountryId: int32 (nullable)

Id страны

FullName: string

Составное название состоящее из названий города, региона и страны разделенные через запятую

ShortName: string

Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)

FullNameEng: string

Составное название состоящее из названий города, региона и страны разделенные через запятую, на английском

ShortNameEng: string

Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России), на английском

IsRegionalCenter: boolean

Является ли город региональным центром

CitySize: int32

Размер города по числу жителей

FiasId: guid (nullable)

идентификатор в базе данных ФИАС

Longitude: double (nullable)

Долгота города

Latitude: double (nullable)

Широта города

CityName: string

Название города

RegionName: string

Название региона

CountryName: string

Название страны

CityNameEng: string

Название города на английском

RegionNameEng: string

Название региона на английском

CountryNameEng: string

Название страны на английском

CountryCodeName: string

Буквенный код страны

}]

404 Город не найден

Развернуть все Свернуть все

Пример

Модель

{...}

"Reason":"string",

"Error":"string"

}

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

post

/gw/gis-dict/v1/districts/by-ids

Развернуть все Свернуть все

body

{...}

ids*: [int32]

Список идентификаторов районов (кодов ATI.SU)

Допустимое количество элементов от 1 до 1000

}

CURL

Копировать

Пример ответа

Ответ

200 OK

Развернуть все Свернуть все

Пример

Модель

{...}

"districts":[...]

{...}

"district_id":0,

"country_id":0,

"federal_district_id":0,

"name":"string",

"short_name":"string",

"region_id":0

}

]

}

{...}

districts*:[{...}]

district_id*: int32

Идентификатор района

country_id*: int32

Идентификатор страны

federal_district_id: int32 (nullable)

Идентификатор федерального округа

Значение по умолчанию: null

name*: string

Название района

short_name*: string

Название района с сокращениями типа

region_id: int32 (nullable)

Идентификатор региона

Значение по умолчанию: null

}]

}

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string",

"details":{...}

"any-key":null

}

{...}

error: string

Текстовый код ошибки

reason: string

Человекочитаемое описание ошибки

details:{...}

Дополнительная информация об ошибке

any-key: {missing-type-info}

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

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

get

/gw/gis-dict/v1/federal-districts

CURL

Копировать

Пример ответа

Ответ

200 OK

Развернуть все Свернуть все

Пример

Модель

{...}

"federal_districts":[...]

{...}

"federal_district_id":0,

"country_id":0,

"name":"string",

"is_legacy":false

}

]

}

{...}

federal_districts*:[{...}]

Модель, описывающая сущность "Федеральный округ"

federal_district_id*: int32

Идентификатор фед. округа

country_id*: int32

Идентификатор страны

name*: string

Название страны

is_legacy: boolean

Флаг, обозначающий, что объект является устаревшим.

Значение по умолчанию: false

}]

}

304 Not Modified

Развернуть все Свернуть все

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

post

/gw/gis-dict/v1/regions/by-ids

Развернуть все Свернуть все

body

{...}

ids*: [int32]

Список идентификаторов регионов (кодов ATI.SU)

}

CURL

Копировать

Пример ответа

Ответ

200 OK

Развернуть все Свернуть все

Пример

Модель

{...}

"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*: int32

Идентификатор региона

name*: string

Название региона

country_id*: int32

Идентификатор страны

federal_district_id: int32 (nullable)

Идентификатор федерального округа

Значение по умолчанию: null

fias_id: uuid (nullable)

Идентификатор ФИАС

Значение по умолчанию: null

tax_region_code: string (nullable)

Код региона для ФНС.

Значение по умолчанию: null

clarified_name*: string

Название региона с уточнением, что это регион при необходимости. Если название региона совпадает с каким-нибудь городом, то для него добавляется уточнение.

regional_center_id: int32 (nullable)

Идентификатор регионального центра

Значение по умолчанию: null

is_legacy: boolean

Флаг, обозначающий, что объект является устаревшим.

Значение по умолчанию: false

}]

}

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string",

"details":{...}

"any-key":null

}

{...}

error: string

Текстовый код ошибки

reason: string

Человекочитаемое описание ошибки

details:{...}

Дополнительная информация об ошибке

any-key: {missing-type-info}

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

post

/gw/gis-dict/v1/regions/by-coordinate

Развернуть все Свернуть все

body

{...}

location*:{...}

Координаты

lat*: double

Широта

lon*: double

Долгота

}

CURL

Копировать

Пример ответа

Ответ

200 OK

Развернуть все Свернуть все

Пример

Модель

{...}

"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*: int32

Идентификатор региона

name*: string

Название региона

country_id*: int32

Идентификатор страны

federal_district_id: int32 (nullable)

Идентификатор федерального округа

Значение по умолчанию: null

fias_id: uuid (nullable)

Идентификатор ФИАС

Значение по умолчанию: null

tax_region_code: string (nullable)

Код региона для ФНС.

Значение по умолчанию: null

clarified_name*: string

regional_center_id: int32 (nullable)

Идентификатор регионального центра

Значение по умолчанию: null

is_legacy: boolean

Флаг, обозначающий, что объект является устаревшим.

Значение по умолчанию: false

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string",

"details":{...}

"any-key":null

}

{...}

error: string

Текстовый код ошибки

reason: string

Человекочитаемое описание ошибки

details:{...}

Дополнительная информация об ошибке

any-key: {missing-type-info}

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

post

/gw/gis-dict/v1/regions/by-fias-ids

Развернуть все Свернуть все

body

{...}

fias_ids*: [uuid]

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

Допустимое количество элементов от 1 до 1000

}

CURL

Копировать

Пример ответа

Ответ

200 OK

Развернуть все Свернуть все

Пример

Модель

{...}

"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*: int32

Идентификатор региона

name*: string

Название региона

country_id*: int32

Идентификатор страны

federal_district_id: int32 (nullable)

Идентификатор федерального округа

Значение по умолчанию: null

fias_id: uuid (nullable)

Идентификатор ФИАС

Значение по умолчанию: null

tax_region_code: string (nullable)

Код региона для ФНС.

Значение по умолчанию: null

clarified_name*: string

regional_center_id: int32 (nullable)

Идентификатор регионального центра

Значение по умолчанию: null

is_legacy: boolean

Флаг, обозначающий, что объект является устаревшим.

Значение по умолчанию: false

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

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

post

/gw/gis-dict/v1/countries/by-ids

Развернуть все Свернуть все

body

{...}

ids*: [int32]

Список идентификаторов стран (кодов ATI.SU)

Допустимое количество элементов от 1 до 1000

}

CURL

Копировать

Пример ответа

Ответ

200 OK

Развернуть все Свернуть все

Пример

Модель

{...}

"countries":[...]

{...}

"country_id":0,

"name":"string",

"iso_3166_alpha2":"string",

"iso_3166_alpha3":"string",

"iso_3166_numeric":0,

"is_legacy":false

}

]

}

{...}

countries*:[{...}]

Модель, описывающая сущность "Страна"

country_id*: int32

Идентификатор страны

name*: string

Название страны

iso_3166_alpha2*: string

Двухбуквенный код страны по ISO-3166

iso_3166_alpha3*: string

Трехбуквенный код страны по ISO-3166

iso_3166_numeric*: int32

Числовой код страны по ISO-3166

is_legacy: boolean

Флаг, обозначающий, что объект является устаревшим.

Значение по умолчанию: false

}]

}

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string",

"details":{...}

"any-key":null

}

{...}

error: string

Текстовый код ошибки

reason: string

Человекочитаемое описание ошибки

details:{...}

Дополнительная информация об ошибке

any-key: {missing-type-info}

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

post

/gw/gis-dict/v1/countries/by-coordinate

Развернуть все Свернуть все

body

{...}

location*:{...}

Координаты

lat*: double

Широта

lon*: double

Долгота

}

CURL

Копировать

Пример ответа

Ответ

200 OK

Развернуть все Свернуть все

Пример

Модель

{...}

"country_id":0,

"name":"string",

"iso_3166_alpha2":"string",

"iso_3166_alpha3":"string",

"iso_3166_numeric":0,

"is_legacy":false

}

{...}

Модель, описывающая сущность "Страна"

country_id*: int32

Идентификатор страны

name*: string

Название страны

iso_3166_alpha2*: string

Двухбуквенный код страны по ISO-3166

iso_3166_alpha3*: string

Трехбуквенный код страны по ISO-3166

iso_3166_numeric*: int32

Числовой код страны по ISO-3166

is_legacy: boolean

Флаг, обозначающий, что объект является устаревшим.

Значение по умолчанию: false

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string",

"details":{...}

"any-key":null

}

{...}

error: string

Текстовый код ошибки

reason: string

Человекочитаемое описание ошибки

details:{...}

Дополнительная информация об ошибке

any-key: {missing-type-info}

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

get

/gw/gis-dict/v1/directions

CURL

Копировать

Пример ответа

Ответ

200 OK

Развернуть все Свернуть все

Пример

Модель

{...}

"directions":[...]

{...}

"id":0,

"name":"string"

}

]

}

{...}

directions*:[{...}]

Направление "Север", "Юг" и т.д.

id*: int32

Идентификатор направления

name*: string

Описание направления

}]

}

304 Not Modified

Развернуть все Свернуть все

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

get

/gw/gis-dict/v1/direction/from/{from}/to/{to}

from

int32

Код ATI.SU для населённого пункта “откуда”

int32

Код ATI.SU для населённого пункта “куда”

CURL

Копировать

Пример ответа

Ответ

200 OK

Развернуть все Свернуть все

Пример

Модель

{...}

"id":0,

"name":"string"

}

{...}

Направление "Север", "Юг" и т.д.

id*: int32

Идентификатор направления

name*: string

Описание направления

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

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

get

/v1.0/dictionaries/streetTypes

CURL

Копировать

Пример ответа

Ответ

200 Типы улиц

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"Id":0,

"Id2":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name":"string",

"ShortName":"string"

}

]

[{...}]

Id: int64

Id2: guid

Guid

Name: string

Название

ShortName: string

Короткое название

}]

Загрузка...

Развернуть все Свернуть все

Загрузка...

Автокомплит

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

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

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

post

/gw/gis-dict/v1/autocomplete/suggestions

Развернуть все Свернуть все

body

{...}

prefix*: string

От (0 до 200 символов)

Поисковая строка

suggestion_types: enum

[1, 2, 4, 8]

Тип элемента для автокомплита. В запросе может быть маской, в ответе не может быть маской.

Members:

1 - Населённый пункт
2 - Регион
4 - Страна
8 - Направление

limit: int32 (nullable)

>=1 and <= 50

Сколько элементов нужно вернуть пользователю

Значение по умолчанию: 10

country_id: int32 (nullable)

Страна по умолчанию для сортировки объектов. Объекты из этой страные будут наверху списка.

Если не передать или передать null, то для залогиненного пользователя настройка возьмется из кабинета. Значение по умолчанию: null

}

CURL

Копировать

Пример ответа

Ответ

200 OK

Развернуть все Свернуть все

Пример

Модель

{...}

"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: enum

[1, 2, 4, 8]

Тип элемента для автокомплита. В запросе может быть маской, в ответе не может быть маской.

Members:

1 - Населённый пункт
2 - Регион
4 - Страна
8 - Направление

direction:{...}

Направление

Значение по умолчанию: null

id: int32

Идентификатор географического объекта

Название географического объекта

short_name: string (nullable)

Короткое название географического объекта

}

country:{...}

Страна

Значение по умолчанию: null

id: int32

Идентификатор географического объекта

Название географического объекта

short_name: string (nullable)

Короткое название географического объекта

}

region:{...}

Регион

Значение по умолчанию: null

id: int32

Идентификатор географического объекта

Название географического объекта

short_name: string (nullable)

Короткое название географического объекта

}

districts:[{...}]

Районы

Значение по умолчанию: null

id: int32

Идентификатор географического объекта

Название географического объекта

short_name: string (nullable)

Короткое название географического объекта

}]

subdistrict:{...}

Часть района

Значение по умолчанию: null

Название части района

short_name: string

Короткое название части района

}

city:{...}

Населённый пункт

Значение по умолчанию: null

id: int32

Идентификатор географического объекта

Название географического объекта

short_name: string (nullable)

Короткое название географического объекта

city_type:{...}

Тип нас. пункта

city_type_id*: int32

Идентификатор типа населённого пункта

name*: string

Название типа

short_name*: string

Сокращённое название типа

}

old_name: string (nullable)

Старое название

Значение по умолчанию: null

alt_name: string (nullable)

Альтернативное название

Значение по умолчанию: null

}

address: string

Адрес

geo_point:{...}

Координаты объекта

lat: double

Широта

lon: double

Долгота

}

}]

}

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string",

"details":{...}

"any-key":null

}

{...}

error: string

Текстовый код ошибки

reason: string

Человекочитаемое описание ошибки

details:{...}

Дополнительная информация об ошибке

any-key: {missing-type-info}

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

За один запрос можно передать не более 20 адресов — они должны быть уникальны в рамках запроса. Количество запросов ограничено.

Важно! Метод выполняет поиск только среди городов, идентификаторы других сущностей в нём не возвращаются.

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

post

/v1.0/dictionaries/locations/parse

                    
                      Развернуть все
                      
                      Свернуть все
                      
body

                        array
                      
                      [
  "string"
]

                      Адреса, которые нужно обработать
                    
        [string]

CURL

Копировать

Пример ответа

Ответ

200 Результат геокодирования

Развернуть все Свернуть все

Пример

Модель

{...}

"any-key":{...}

"city_id":0,

"is_success":false,

"street":"string"

}

{...}

any-key:{...}

city_id: int32

Id города

is_success*: boolean

Геокодирование завершено успешно

street: string

Улица/район

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

Методы будут доступны до 1 сентября 2025 года — после этого они поддерживаться не будут.

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

get

/v1.0/dictionaries/cities

name

string

Слово для поиска

cityNameOnly

boolean

Поиск только по названию города

CURL

Копировать

Пример ответа

Ответ

200 Города

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"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"

}

]

[{...}]

Id2: guid

CityId: int32

Id города

RegionId: int32 (nullable)

Id региона

CountryId: int32 (nullable)

Id страны

FullName: string

Составное название состоящее из названий города, региона и страны разделенные через запятую

ShortName: string

FullNameEng: string

Составное название состоящее из названий города, региона и страны разделенные через запятую, на английском

ShortNameEng: string

IsRegionalCenter: boolean

Является ли город региональным центром

CitySize: int32

Размер города по числу жителей

FiasId: guid (nullable)

идентификатор в базе данных ФИАС

Longitude: double (nullable)

Долгота города

Latitude: double (nullable)

Широта города

CityName: string

Название города

RegionName: string

Название региона

CountryName: string

Название страны

CityNameEng: string

Название города на английском

RegionNameEng: string

Название региона на английском

CountryNameEng: string

Название страны на английском

CountryCodeName: string

Буквенный код страны

}]

Данный запрос API возвращает очень много данных (примерно 45 МБ).
Чтобы не повесить ваш браузер, показываем сокращённый образец ответа.

[...]

{...},

"Id2":"38331511-9812-e411-8e11-00259038ec34",

"CityId":1,

"RegionId":153,

"CountryId":1,

"FullName":"Санкт-Петербург, Санкт-Петербург (регион), Россия",

"ShortName":"Санкт-Петербург",

"FullNameEng":"St. Petersburg, Sankt-Peterburg (region), Russia",

"ShortNameEng":"St. Petersburg",

"IsRegionalCenter":true,

"CitySize":6,

"FiasId":"c2deb16a-0330-4f05-821f-1d09c93331e6",

"Longitude":30.310143,

"Latitude":59.937282,

"CityName":"Санкт-Петербург",

"RegionName":"Санкт-Петербург (регион)",

"CountryName":"Россия",

"CityNameEng":"St. Petersburg",

"RegionNameEng":"Sankt-Peterburg (region)",

"CountryNameEng":"Russia",

"CountryCodeName":"RUS"

{...},

"Id2":"39331511-9812-e411-8e11-00259038ec34",

"CityId":2,

"RegionId":151,

"CountryId":1,

"FullName":"МКАД 94км Ярославское ш, Москва (регион), Россия",

"ShortName":"МКАД 94км Ярославское ш, Москва (регион)",

"FullNameEng":"Moskva (MKAD 94 km), Moskva (region), Russia",

"ShortNameEng":"Moskva (MKAD 94 km), Moskva (region)",

"IsRegionalCenter":false,

"CitySize":0,

"FiasId":"cca6a6dc-5bee-4f16-be8a-ae29428095e0",

"Longitude":37.7287673,

"Latitude":55.8808959,

"CityName":"МКАД 94км Ярославское ш",

"RegionName":"Москва (регион)",

"CountryName":"Россия",

"CityNameEng":"Moskva (MKAD 94 km)",

"RegionNameEng":"Moskva (region)",

"CountryNameEng":"Russia",

"CountryCodeName":"RUS"

{...},

"Id2":"3a331511-9812-e411-8e11-00259038ec34",

"CityId":3,

"RegionId":40,

"CountryId":1,

"FullName":"Апшеронск, Краснодарский край, Россия",

"ShortName":"Апшеронск, Краснодарский край",

"FullNameEng":"Apsheronsk, Krasnodarskiy kray, Russia",

"ShortNameEng":"Apsheronsk, Krasnodarskiy kray",

"IsRegionalCenter":false,

"CitySize":1,

"FiasId":"7b9a7eb9-0d6d-4135-ad1c-3c059db9f386",

"Longitude":39.7302397,

"Latitude":44.4696808,

"CityName":"Апшеронск",

"RegionName":"Краснодарский край",

"CountryName":"Россия",

"CityNameEng":"Apsheronsk",

"RegionNameEng":"Krasnodarskiy kray",

"CountryNameEng":"Russia",

"CountryCodeName":"RUS"

{...},

"Id2":"3b331511-9812-e411-8e11-00259038ec34",

"CityId":4,

"RegionId":0,

"CountryId":32,

"FullName":"Есеница, Словения",

"ShortName":"Есеница, SLO",

"FullNameEng":"Jesenice, Slovenia",

"ShortNameEng":"Jesenice, SLO",

"IsRegionalCenter":false,

"CitySize":1,

"FiasId":null,

"Longitude":14.0556974,

"Latitude":46.4364207,

"CityName":"Есеница",

"RegionName":null,

"CountryName":"Словения",

"CityNameEng":"Jesenice",

"RegionNameEng":null,

"CountryNameEng":"Slovenia",

"CountryCodeName":"SLO"

{...},

"Id2":"3c331511-9812-e411-8e11-00259038ec34",

"CityId":5,

"RegionId":null,

"CountryId":32,

"FullName":"Постойна, Словения",

"ShortName":"Постойна, SLO",

"FullNameEng":"Postonja, Slovenia",

"ShortNameEng":"Postonja, SLO",

"IsRegionalCenter":false,

"CitySize":0,

"FiasId":null,

"Longitude":14.213397,

"Latitude":45.7750626,

"CityName":"Постойна",

"RegionName":null,

"CountryName":"Словения",

"CityNameEng":"Postonja",

"RegionNameEng":null,

"CountryNameEng":"Slovenia",

"CountryCodeName":"SLO"

{...},

"Id2":"3d331511-9812-e411-8e11-00259038ec34",

"CityId":6,

"RegionId":null,

"CountryId":32,

"FullName":"Крань, Словения",

"ShortName":"Крань, SLO",

"FullNameEng":"Kranj, Slovenia",

"ShortNameEng":"Kranj, SLO",

"IsRegionalCenter":false,

"CitySize":0,

"FiasId":null,

"Longitude":14.3556543,

"Latitude":46.2392066,

"CityName":"Крань",

"RegionName":null,

"CountryName":"Словения",

"CityNameEng":"Kranj",

"RegionNameEng":null,

"CountryNameEng":"Slovenia",

"CountryCodeName":"SLO"

{...},

"Id2":"3e331511-9812-e411-8e11-00259038ec34",

"CityId":7,

"RegionId":41,

"CountryId":1,

"FullName":"Ачинск, Красноярский край, Россия",

"ShortName":"Ачинск, Красноярский край",

"FullNameEng":"Achinsk, Krasnoyarskiy kray, Russia",

"ShortNameEng":"Achinsk, Krasnoyarskiy kray",

"IsRegionalCenter":false,

"CitySize":4,

"FiasId":"c3689d32-dea5-49c8-b69b-b8d2daa1d36b",

"Longitude":90.5170516,

"Latitude":56.28236,

"CityName":"Ачинск",

"RegionName":"Красноярский край",

"CountryName":"Россия",

"CityNameEng":"Achinsk",

"RegionNameEng":"Krasnoyarskiy kray",

"CountryNameEng":"Russia",

"CountryCodeName":"RUS"

{...},

"Id2":"3f331511-9812-e411-8e11-00259038ec34",

"CityId":8,

"RegionId":0,

"CountryId":32,

"FullName":"Кочевье, Словения",

"ShortName":"Кочевье, SLO",

"FullNameEng":"Kocevje, Slovenia",

"ShortNameEng":"Kocevje, SLO",

"IsRegionalCenter":false,

"CitySize":0,

"FiasId":null,

"Longitude":14.8647563,

"Latitude":45.639196,

"CityName":"Кочевье",

"RegionName":null,

"CountryName":"Словения",

"CityNameEng":"Kocevje",

"RegionNameEng":null,

"CountryNameEng":"Slovenia",

"CountryCodeName":"SLO"

{...},

"Id2":"40331511-9812-e411-8e11-00259038ec34",

"CityId":9,

"RegionId":63,

"CountryId":1,

"FullName":"Астрахань, Астраханская область, Россия",

"ShortName":"Астрахань",

"FullNameEng":"Astrakhan, Astrakhanskaya oblast', Russia",

"ShortNameEng":"Astrakhan",

"IsRegionalCenter":true,

"CitySize":5,

"FiasId":"a101dd8b-3aee-4bda-9c61-9df106f145ff",

"Longitude":48.06234,

"Latitude":46.360552,

"CityName":"Астрахань",

"RegionName":"Астраханская область",

"CountryName":"Россия",

"CityNameEng":"Astrakhan",

"RegionNameEng":"Astrakhanskaya oblast'",

"CountryNameEng":"Russia",

"CountryCodeName":"RUS"

{...},

"Id2":"41331511-9812-e411-8e11-00259038ec34",

"CityId":10,

"RegionId":6,

"CountryId":1,

"FullName":"Архангельск, Архангельская область, Россия",

"ShortName":"Архангельск",

"FullNameEng":"Arhangelsk, Arkhangel'skaya oblast', Russia",

"ShortNameEng":"Arhangelsk",

"IsRegionalCenter":true,

"CitySize":4,

"FiasId":"06814fb6-0dc3-4bec-ba20-11f894a0faf5",

"Longitude":40.5655707,

"Latitude":64.5369264,

"CityName":"Архангельск",

"RegionName":"Архангельская область",

"CountryName":"Россия",

"CityNameEng":"Arhangelsk",

"RegionNameEng":"Arkhangel'skaya oblast'",

"CountryNameEng":"Russia",

"CountryCodeName":"RUS"

{...},

"Id2":"42331511-9812-e411-8e11-00259038ec34",

"CityId":11,

"RegionId":78,

"CountryId":1,

"FullName":"Арзамас, Нижегородская область, Россия",

"ShortName":"Арзамас, Нижегородская область",

"FullNameEng":"Arzamas, Nizhegorodskaya oblast', Russia",

"ShortNameEng":"Arzamas, Nizhegorodskaya oblast'",

"IsRegionalCenter":false,

"CitySize":1,

"FiasId":"7e42f157-87d6-4111-a406-17432e814723",

"Longitude":43.816503,

"Latitude":55.383869,

"CityName":"Арзамас",

"RegionName":"Нижегородская область",

"CountryName":"Россия",

"CityNameEng":"Arzamas",

"RegionNameEng":"Nizhegorodskaya oblast'",

"CountryNameEng":"Russia",

"CountryCodeName":"RUS"

{...},

"Id2":"43331511-9812-e411-8e11-00259038ec34",

"CityId":12,

"RegionId":77,

"CountryId":1,

"FullName":"Апатиты, Мурманская область, Россия",

"ShortName":"Апатиты, Мурманская область",

"FullNameEng":"Apatity, Murmanskaya oblast', Russia",

"ShortNameEng":"Apatity, Murmanskaya oblast'",

"IsRegionalCenter":false,

"CitySize":3,

"FiasId":"f0851e80-59d9-400b-b6d5-5f5f623bb29d",

"Longitude":33.3909799,

"Latitude":67.5796203,

"CityName":"Апатиты",

"RegionName":"Мурманская область",

"CountryName":"Россия",

"CityNameEng":"Apatity",

"RegionNameEng":"Murmanskaya oblast'",

"CountryNameEng":"Russia",

"CountryCodeName":"RUS"

{...},

"Id2":"44331511-9812-e411-8e11-00259038ec34",

"CityId":13,

"RegionId":20,

"CountryId":1,

"FullName":"Барнаул, Алтайский край, Россия",

"ShortName":"Барнаул",

"FullNameEng":"Barnaul, Altayskiy kray, Russia",

"ShortNameEng":"Barnaul",

"IsRegionalCenter":true,

"CitySize":5,

"FiasId":"d13945a8-7017-46ab-b1e6-ede1e89317ad",

"Longitude":83.7616499,

"Latitude":53.3563385,

"CityName":"Барнаул",

"RegionName":"Алтайский край",

"CountryName":"Россия",

"CityNameEng":"Barnaul",

"RegionNameEng":"Altayskiy kray",

"CountryNameEng":"Russia",

"CountryCodeName":"RUS"

{...},

"Id2":"45331511-9812-e411-8e11-00259038ec34",

"CityId":14,

"RegionId":20,

"CountryId":1,

"FullName":"Бийск, Алтайский край, Россия",

"ShortName":"Бийск, Алтайский край",

"FullNameEng":"Biysk, Altayskiy kray, Russia",

"ShortNameEng":"Biysk, Altayskiy kray",

"IsRegionalCenter":false,

"CitySize":4,

"FiasId":"52f876f6-cb1d-4f23-a22f-b692609fc1e0",

"Longitude":85.2170028,

"Latitude":52.5413018,

"CityName":"Бийск",

"RegionName":"Алтайский край",

"CountryName":"Россия",

"CityNameEng":"Biysk",

"RegionNameEng":"Altayskiy kray",

"CountryNameEng":"Russia",

"CountryCodeName":"RUS"

{...},

"Id2":"46331511-9812-e411-8e11-00259038ec34",

"CityId":15,

"RegionId":2,

"CountryId":1,

"FullName":"Бокситогорск, Ленинградская область, Россия",

"ShortName":"Бокситогорск, Ленинградская область",

"FullNameEng":"Boksitogorsk, Leningradskaya oblast', Russia",

"ShortNameEng":"Boksitogorsk, Leningradskaya oblast'",

"IsRegionalCenter":false,

"CitySize":1,

"FiasId":"1a12dc30-ca4c-480f-89dd-31452648b493",

"Longitude":33.8602219,

"Latitude":59.4693718,

"CityName":"Бокситогорск",

"RegionName":"Ленинградская область",

"CountryName":"Россия",

"CityNameEng":"Boksitogorsk",

"RegionNameEng":"Leningradskaya oblast'",

"CountryNameEng":"Russia",

"CountryCodeName":"RUS"

{...},

"Id2":"47331511-9812-e411-8e11-00259038ec34",

"CityId":16,

"RegionId":26,

"CountryId":1,

"FullName":"Богучар, Воронежская область, Россия",

"ShortName":"Богучар, Воронежская область",

"FullNameEng":"Boguchar, Voronezhskaya oblast', Russia",

"ShortNameEng":"Boguchar, Voronezhskaya oblast'",

"IsRegionalCenter":false,

"CitySize":1,

"FiasId":"33b88f52-819d-4ba5-aa70-3fe4ccfd33d6",

"Longitude":40.5592614,

"Latitude":49.9373703,

"CityName":"Богучар",

"RegionName":"Воронежская область",

"CountryName":"Россия",

"CityNameEng":"Boguchar",

"RegionNameEng":"Voronezhskaya oblast'",

"CountryNameEng":"Russia",

"CountryCodeName":"RUS"

{...},

"Id2":"48331511-9812-e411-8e11-00259038ec34",

"CityId":17,

"RegionId":7,

"CountryId":1,

"FullName":"Белая Калитва, Ростовская область, Россия",

"ShortName":"Белая Калитва, Ростовская область",

"FullNameEng":"Belaya Kalitva, Rostovskaya oblast', Russia",

"ShortNameEng":"Belaya Kalitva, Rostovskaya oblast'",

"IsRegionalCenter":false,

"CitySize":2,

"FiasId":"2d38257c-c09e-405d-af01-93fc9cd3f6cd",

"Longitude":40.773819,

"Latitude":48.19244,

"CityName":"Белая Калитва",

"RegionName":"Ростовская область",

"CountryName":"Россия",

"CityNameEng":"Belaya Kalitva",

"RegionNameEng":"Rostovskaya oblast'",

"CountryNameEng":"Russia",

"CountryCodeName":"RUS"

{...}

"Id2":"49331511-9812-e411-8e11-00259038ec34",

"CityId":18,

"RegionId":79,

"CountryId":1,

"FullName":"Боровичи, Новгородская область, Россия",

"ShortName":"Боровичи, Новгородская область",

"FullNameEng":"Borovichi, Novgorodskaya oblast', Russia",

"ShortNameEng":"Borovichi, Novgorodskaya oblast'",

"IsRegionalCenter":false,

"CitySize":3,

"FiasId":"ae2f372e-7df2-400c-95f9-4b0522567634",

"Longitude":33.9010087,

"Latitude":58.3951492,

"CityName":"Боровичи",

"RegionName":"Новгородская область",

"CountryName":"Россия",

"CityNameEng":"Borovichi",

"RegionNameEng":"Novgorodskaya oblast'",

"CountryNameEng":"Russia",

"CountryCodeName":"RUS"

}

]

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

get

/v1.0/dictionaries/cities/byfias/{fias}

fias

guid

ID города в базе ФИАС

CURL

Копировать

Пример ответа

Ответ

200 Город

Развернуть все Свернуть все

Пример

Модель

{...}

"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"

}

{...}

Id2: guid

CityId: int32

Id города

RegionId: int32 (nullable)

Id региона

CountryId: int32 (nullable)

Id страны

FullName: string

Составное название состоящее из названий города, региона и страны разделенные через запятую

ShortName: string

FullNameEng: string

Составное название состоящее из названий города, региона и страны разделенные через запятую, на английском

ShortNameEng: string

IsRegionalCenter: boolean

Является ли город региональным центром

CitySize: int32

Размер города по числу жителей

FiasId: guid (nullable)

идентификатор в базе данных ФИАС

Longitude: double (nullable)

Долгота города

Latitude: double (nullable)

Широта города

CityName: string

Название города

RegionName: string

Название региона

CountryName: string

Название страны

CityNameEng: string

Название города на английском

RegionNameEng: string

Название региона на английском

CountryNameEng: string

Название страны на английском

CountryCodeName: string

Буквенный код страны

}

404 Город не найден

Развернуть все Свернуть все

Пример

Модель

{...}

"Reason":"string",

"Error":"string"

}

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

get

/v1.0/dictionaries/cities/{cityId}

cityId

int32

ID города

CURL

Копировать

Пример ответа

Ответ

200 Город

Развернуть все Свернуть все

Пример

Модель

{...}

"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"

}

{...}

Id2: guid

CityId: int32

Id города

RegionId: int32 (nullable)

Id региона

CountryId: int32 (nullable)

Id страны

FullName: string

Составное название состоящее из названий города, региона и страны разделенные через запятую

ShortName: string

FullNameEng: string

Составное название состоящее из названий города, региона и страны разделенные через запятую, на английском

ShortNameEng: string

IsRegionalCenter: boolean

Является ли город региональным центром

CitySize: int32

Размер города по числу жителей

FiasId: guid (nullable)

идентификатор в базе данных ФИАС

Longitude: double (nullable)

Долгота города

Latitude: double (nullable)

Широта города

CityName: string

Название города

RegionName: string

Название региона

CountryName: string

Название страны

CityNameEng: string

Название города на английском

RegionNameEng: string

Название региона на английском

CountryNameEng: string

Название страны на английском

CountryCodeName: string

Буквенный код страны

}

404 Город не найден

Развернуть все Свернуть все

Пример

Модель

{...}

"Reason":"string",

"Error":"string"

}

{...}

Модель ошибки

Reason: string

Причина ошибки

Error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

get

/v1.0/dictionaries/regions

CURL

Копировать

Пример ответа

Ответ

200 Регионы

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"Id":0,

"Id2":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name":"string",

"NameEng":"string",

"RegionClearName":"string",

"RegionTypeAbbr":"string",

"CountryId":0,

"RegionCode":"string"

}

]

[{...}]

Id: int64

Id2: guid

Guid

Name: string

Название

NameEng: string

Название на английском

RegionClearName: string

Только название области или края. Напр, Московская область -> Московская

RegionTypeAbbr: string

Тип региона. Напр, Московская область -> обл.

CountryId: int32

Id страны

RegionCode: string

Код региона

}]

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

get

/v1.0/dictionaries/countries

CURL

Копировать

Пример ответа

Ответ

200 Страны

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"Id":0,

"Id2":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"Name":"string",

"NameEng":"string",

"InterShortName":"string",

"CurrencyId":0

}

]

[{...}]

Id: int64

Id2: guid

Guid

Name: string

Название

NameEng: string

Название на английском

InterShortName: string

Короткое название. Пример: Россия -> RUS

CurrencyId: int32 (nullable)

Id валюты

}]

Загрузка...

Развернуть все Свернуть все

Загрузка...