Page tree
Skip to end of metadata
Go to start of metadata

Метод предназначен для получения детальной информации о населенных пунктах. 
Список населенных пунктов может быть ограничен характеристиками, задаваемыми пользователем.

Запрос на получение списка населенных пунктов

Для использования необходимо отправить GET-запрос на URL:

Параметры запроса

Поддерживаются следующие параметры:

Название поля

Описание

Тип поля

Обяз. для заполн.

1country_codesМассив кодов стран в формате  ISO_3166-1_alpha-2string(2) [ ]нет
2region_codeКод региона СДЭКintegerнет
3kladr_region_code

Код КЛАДР региона

Устаревшее поле

string(255)нет
4fias_region_guid

Уникальный идентификатор ФИАС региона

Устаревшее поле

UUIDнет
5kladr_code

Код КЛАДР населенного пункта

Устаревшее поле

string(255)нет
6fias_guidУникальный идентификатор ФИАС населенного пунктаUUIDнет
7postal_codeПочтовый индексstring(255)нет
8codeКод населенного пункта СДЭКintegerнет
9cityНазвание населенного пункта. Должно соответствовать полностьюstring(255)нет
10sizeОграничение выборки результата. По умолчанию 500integerда, если указан page
11page

Номер страницы выборки результата. По умолчанию 0

Устаревшее поле, для постраничной загрузки рекомендуется использовать location (содержит ссылку на следующую страницу) из заголовка ответа.

integerнет
12langЛокализация. По умолчанию "rus"string(3)нет
13payment_limitОграничение на сумму наложенного платежа:
  • -1 - ограничения нет;
  • 0 - наложенный платеж не принимается;
  • положительное значение - сумма наложенного платежа не более данного значения.

Устаревшее поле

floatнет

Ответ на запрос получения списка населенных пунктов

Заголовок ответа: location - содержит ссылку на следующую страницу результатов запроса.

Тело ответа возвращается в формате JSON:

Название поля

Описание

Тип поля

Обяз. для заполн.

1codeКод населенного пункта СДЭКintegerда
2cityНазвание населенного пункта.string(255)да
3fias_guidУникальный идентификатор ФИАС населенного пунктаUUIDнет
4kladr_code

Код КЛАДР населенного пункта

Устаревшее поле

string(255)нет
5country_codeКод страны населенного пункта в формате  ISO_3166-1_alpha-2string(2)да
6countryНазвание страны населенного пунктаstring(255)да
7regionНазвание региона населенного пунктаstring(255)да
8region_codeКод региона СДЭКintegerнет
9fias_region_guid

Уникальный идентификатор ФИАС региона населенного пункта

Устаревшее поле

UUIDнет
10kladr_region_code

Код КЛАДР региона населенного пункта

Устаревшее поле

string(255)нет
11sub_regionНазвание района региона населенного пунктаstring(255)нет
12postal_codesМассив почтовых индексов

[ ]

нет
13longitudeДолгота центра населенного пунктаfloatнет
14latitudeШирота центра населенного пунктаfloatнет
15time_zoneЧасовой пояс населенного пунктаstring(255)нет
16payment_limit

Ограничение на сумму наложенного платежа в населенном пункте

Устаревшее поле

floatда
17errorsСписок ошибокerror[]нет
17.1codeКод ошибкиstring()да
17.2messageОписание ошибкиstring()да


Примеры запросов
https://api.cdek.ru/v2/location/cities/?size=3&page=0
https://api.cdek.ru/v2/location/cities/?country_codes=RU,TR
Пример ответа
[
    {
        "code": "36749",
        "postal_codes": [
            "169237"
        ],
        "country_code": "RU",
        "fias_guid": "62e29404-83cc-4dd8-a46a-7d28464b9df8"
        "country": "Россия",
        "region": "Коми",
        "region_code": "1",
        "sub_region": "Княжпогостский",
        "city": "Чиньяворык",
        "longitude": 52.6702,
        "latitude": 63.2087,
        "time_zone": "Europe/Moscow"
    },
    {
        "code": "60049",
        "country_code": "RU",
        "fias_guid": "98eb8fd9-1ea0-457b-b539-ba6396eb6e01"
        "country": "Россия",
        "region": "Московская",
        "region_code": "9",
        "sub_region": "Можайский",
        "city": "Поченичено",
        "longitude": 35.9312,
        "latitude": 55.3636,
        "time_zone": "Europe/Moscow"
    },
    {
        "code": "16584",
        "postal_codes": [
            "353650",
            "353651"
        ],
        "country_code": "RU",
        "fias_guid": "c51d14cc-045c-4790-83c2-56febe8f8fa9",
        "country": "Россия",
        "region": "Краснодарский",
        "region_code": "7",
        "sub_region": "Ейский",
        "city": "Камышеватская",
        "longitude": 37.9554,
        "latitude": 46.4119,
        "time_zone": "Europe/Moscow"
    }
]


  • No labels