API Адреса

Работа с адресами

Справочник географических областей Украины

Метод «getAreas», работает в модели «Address», этот метод необходим для скачивания справочника географических областей Украины, компании «Новая Почта».
Рекомендуется проводить обновление справочников раз в месяц.

URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]/
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/


Доступность: Требует использования API-ключа.

Try it

URL-адрес запроса

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

string

Форматы JSON, XML

Заголовки запросов

(дополнительный)
string
Тип формата текста, отправляемого в API.

Текст запроса

Параметр Тип данных Описание
apiKey* string[36] Ваш ключ API 2.0
modelName* string Имя модели
calledMethod* string Имя вызываемого метода
methodProperties   Свойства метода
* Обозначение обязательного параметра

{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "Address",
"calledMethod": "getAreas",
"methodProperties": {}
}
<?xml version="1.0" encoding="utf-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>Address</modelName>
<calledMethod>getAreas</calledMethod>
</file>

Ответ 200

Всегда возвращает код 200 даже при логических ошибках.


Тело ответа на запрос

Параметр Тип данных Описание
Ref string[36] Идентификатор Области
Description string[50] Описание на украинском языке
Description string[50] Описание на русском языке
AreasCenter string[36] Идентификатор города, который является областным центром

{
    "success": true,
    "data": [
        {
            "Ref": "71508128-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88b7-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "АРК",
            "Description": "АРК"
        },
        {
            "Ref": "71508129-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88de-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Винницкая",
            "Description": "Вінницька"
        },
        {
            "Ref": "7150812a-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c893b-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Волынская",
            "Description": "Волинська"
        },
        {
            "Ref": "7150812b-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88f0-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Днепропетровская",
            "Description": "Дніпропетровська"
        },
        {
            "Ref": "7150812c-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88bf-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Донецкая",
            "Description": "Донецька"
        },
        {
            "Ref": "7150812d-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88c4-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Житомирская",
            "Description": "Житомирська"
        },
        {
            "Ref": "7150812e-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "e221d627-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Закарпатская",
            "Description": "Закарпатська"
        },
        {
            "Ref": "7150812f-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88c6-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Запорожская",
            "Description": "Запорізька"
        },
        {
            "Ref": "71508130-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c8904-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Ивано-Франковская",
            "Description": "Івано-Франківська"
        },
        {
            "Ref": "71508131-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "8d5a980d-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Киевская",
            "Description": "Київська"
        },
        {
            "Ref": "71508132-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c891b-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Кировоградская",
            "Description": "Кіровоградська"
        },
        {
            "Ref": "71508133-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88ba-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Луганская",
            "Description": "Луганська"
        },
        {
            "Ref": "71508134-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88f5-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Львовская",
            "Description": "Львівська"
        },
        {
            "Ref": "71508135-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c888c-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Николаевская",
            "Description": "Миколаївська"
        },
        {
            "Ref": "71508136-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88d0-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Одесская",
            "Description": "Одеська"
        },
        {
            "Ref": "71508137-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c8892-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Полтавская",
            "Description": "Полтавська"
        },
        {
            "Ref": "71508138-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c896a-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Ровенская",
            "Description": "Рівненська"
        },
        {
            "Ref": "71508139-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88e5-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Сумская",
            "Description": "Сумська"
        },
        {
            "Ref": "7150813a-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c8900-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Тернопольская",
            "Description": "Тернопільська"
        },
        {
            "Ref": "7150813b-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88e0-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Харьковская",
            "Description": "Харківська"
        },
        {
            "Ref": "7150813c-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88cc-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Херсонская",
            "Description": "Херсонська"
        },
        {
            "Ref": "7150813d-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88ac-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Хмельницкая",
            "Description": "Хмельницька"
        },
        {
            "Ref": "7150813e-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c8902-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Черкасская",
            "Description": "Черкаська"
        },
        {
            "Ref": "7150813f-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "e221d642-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Черновицкая",
            "Description": "Чернівецька"
        },
        {
            "Ref": "71508140-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c897c-391c-11dd-90d9-001a92567626",
            "DescriptionRu": "Черниговская",
            "Description": "Чернігівська"
        }
    ],
    "errors": [],
    "warnings": [],
    "info": [],
    "messageCodes": [],
    "errorCodes": [],
    "warningCodes": [],
    "infoCodes": []
}
<root>
    <success>true</success>
    <data>
        <item>
            <Ref>71508128-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c88b7-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>АРК</DescriptionRu>
            <Description>АРК</Description>
        </item>
        <item>
            <Ref>71508129-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c88de-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Винницкая</DescriptionRu>
            <Description>Вінницька</Description>
        </item>
        <item>
            <Ref>7150812a-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c893b-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Волынская</DescriptionRu>
            <Description>Волинська</Description>
        </item>
        <item>
            <Ref>7150812b-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c88f0-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Днепропетровская</DescriptionRu>
            <Description>Дніпропетровська</Description>
        </item>
        <item>
            <Ref>7150812c-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c88bf-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Донецкая</DescriptionRu>
            <Description>Донецька</Description>
        </item>
        <item>
            <Ref>7150812d-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c88c4-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Житомирская</DescriptionRu>
            <Description>Житомирська</Description>
        </item>
        <item>
            <Ref>7150812e-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>e221d627-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Закарпатская</DescriptionRu>
            <Description>Закарпатська</Description>
        </item>
        <item>
            <Ref>7150812f-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c88c6-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Запорожская</DescriptionRu>
            <Description>Запорізька</Description>
        </item>
        <item>
            <Ref>71508130-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c8904-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Ивано-Франковская</DescriptionRu>
            <Description>Івано-Франківська</Description>
        </item>
        <item>
            <Ref>71508131-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>8d5a980d-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Киевская</DescriptionRu>
            <Description>Київська</Description>
        </item>
        <item>
            <Ref>71508132-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c891b-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Кировоградская</DescriptionRu>
            <Description>Кіровоградська</Description>
        </item>
        <item>
            <Ref>71508133-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c88ba-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Луганская</DescriptionRu>
            <Description>Луганська</Description>
        </item>
        <item>
            <Ref>71508134-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c88f5-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Львовская</DescriptionRu>
            <Description>Львівська</Description>
        </item>
        <item>
            <Ref>71508135-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c888c-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Николаевская</DescriptionRu>
            <Description>Миколаївська</Description>
        </item>
        <item>
            <Ref>71508136-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c88d0-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Одесская</DescriptionRu>
          <Description>Одеська</Description>
        </item>
        <item>
            <Ref>71508137-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c8892-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Полтавская</DescriptionRu>
            <Description>Полтавська</Description>
        </item>
        <item>
            <Ref>71508138-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c896a-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Ровенская</DescriptionRu>
            <Description>Рівненська</Description>
        </item>
        <item>
            <Ref>71508139-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c88e5-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Сумская</DescriptionRu>
            <Description>Сумська</Description>
        </item>
        <item>
            <Ref>7150813a-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c8900-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Тернопольская</DescriptionRu>
            <Description>Тернопільська</Description>
        </item>
        <item>
            <Ref>7150813b-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c88e0-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Харьковская</DescriptionRu>
            <Description>Харківська</Description>
        </item>
        <item>
            <Ref>7150813c-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c88cc-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Херсонская</DescriptionRu>
            <Description>Херсонська</Description>
        </item>
        <item>
            <Ref>7150813d-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c88ac-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Хмельницкая</DescriptionRu>
            <Description>Хмельницька</Description>
        </item>
        <item>
            <Ref>7150813e-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c8902-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Черкасская</DescriptionRu>
            <Description>Черкаська</Description>
        </item>
        <item>
            <Ref>7150813f-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>e221d642-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Черновицкая</DescriptionRu>
            <Description>Чернівецька</Description>
        </item>
        <item>
            <Ref>71508140-9b87-11de-822f-000c2965ae0e</Ref>
            <AreasCenter>db5c897c-391c-11dd-90d9-001a92567626</AreasCenter>
            <DescriptionRu>Черниговская</DescriptionRu>
            <Description>Чернігівська</Description>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>