Словари адресов

Каждому населенному пункту, а также региону и стране, присвоен свой уникальный идентификатор в базе данных АТИ. Чтобы найти нужные id, воспользуйтесь словарями из списка ниже.

Идентификатор адреса из базы данных ФИАС вы найдете в словаре городов в поле FiasId.

Получение списка всех городов с возможностью поиска по префиксу имени, по 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/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

Ключ ошибки

}

Загрузка...

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

Загрузка...

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

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 валюты

}]

Загрузка...

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

Загрузка...

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

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

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

}]

Загрузка...

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

Загрузка...

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

Если у Вас есть название города или его ФИАС - используйте соответствующие методы, указанные выше. В остальных случаях для поиска идентификатора города Вы можете воспользоваться методом геокодирования.

За один запрос можно передать не более 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

Улица/район

}

Загрузка...

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

Загрузка...