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

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

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

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

Для использования необходимо отправить 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Ограничение выборки результата. По умолчанию 1000integerда, если указан page
11pageНомер страницы выборки результата. По умолчанию 0integerнет
12langЛокализация. По умолчанию "rus"string(3)нет
13payment_limitОграничение на сумму наложенного платежа:
  • -1 - ограничения нет;
  • 0 - наложенный платеж не принимается;
  • положительное значение - сумма наложенного платежа не более данного значения.
floatнет

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

Ответ возвращается в формате 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",
        "kladr_code": "11",
        "country": "Россия",
        "region": "Коми",
        "region_code": "1",
        "kladr_region_code": "11",
        "fias_region_guid": "c20180d9-ad9c-46d1-9eff-d60bc424592a",
        "sub_region": "Княжпогостский",
        "city": "Чиньяворык",
        "longitude": 52.6702,
        "latitude": 63.2087,
        "time_zone": "Europe/Moscow",
        "payment_limit": 0.0
    },
    {
        "code": "60049",
        "country_code": "RU",
        "fias_guid": "98eb8fd9-1ea0-457b-b539-ba6396eb6e01",
        "kladr_code": "50",
        "country": "Россия",
        "region": "Московская",
        "region_code": "9",
        "kladr_region_code": "50",
        "fias_region_guid": "29251dcf-00a1-4e34-98d4-5c47484a36d4",
        "sub_region": "Можайский",
        "city": "Поченичено",
        "longitude": 35.9312,
        "latitude": 55.3636,
        "time_zone": "Europe/Moscow",
        "payment_limit": -1.0
    },
    {
        "code": "16584",
        "postal_codes": [
            "353650",
            "353651"
        ],
        "country_code": "RU",
        "fias_guid": "c51d14cc-045c-4790-83c2-56febe8f8fa9",
        "kladr_code": "23",
        "country": "Россия",
        "region": "Краснодарский",
        "region_code": "7",
        "kladr_region_code": "23",
        "fias_region_guid": "d00e1013-16bd-4c09-b3d5-3cb09fc54bd8",
        "sub_region": "Ейский",
        "city": "Камышеватская",
        "longitude": 37.9554,
        "latitude": 46.4119,
        "time_zone": "Europe/Moscow",
        "payment_limit": -1.0
    }
]


  • No labels