API Адреса

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

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

Метод «searchSettlementStreets», работает в модели «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*   Свойства метода
StreetName* string[36] Название улицы
SettlementRef* string[36] REF населенного пункта из справочника населенных пунктов Украины
Limit* int[36] Количество ответов

* Обозначение обязательного параметра

{
"apiKey": "[ВАШ КЛЮЧ]",
 "modelName": "Address",
    "calledMethod": "searchSettlementStreets",
    "methodProperties": {
        "StreetName": "Незалежност",
        "SettlementRef": "e715719e-4b33-11e4-ab6d-005056801329",
        "Limit": 5
    }
}
<?xml version="1.0" encoding="UTF-8"?>
<file>
   <apiKey>[ВАШ КЛЮЧ]</apiKey>
   <modelName>Address</modelName>
   <calledMethod>searchSettlementStreets</calledMethod>
   <methodProperties>
      <StreetName>Незалежност</StreetName>
      <SettlementRef>e715719e-4b33-11e4-ab6d-005056801329</SettlementRef>
      <Limit>13</Limit>
   </methodProperties>
</file>

Ответ 200

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


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

Параметр Тип данных Описание
SettlementRef string[50] REF населенного пункта
SettlementStreetRef string[50] REF улицы
SettlementStreetDescription string[50] Описание улицы
Present string[50] Полное описание улицы
StreetsType string[50] REF типа улицы
StreetsTypeDescription string[50] Описание типа улицы

{
  "success": true,
  "data": [
    {
      "TotalCount": 1,
      "Addresses": [
        {
          "SettlementRef": "e715719e-4b33-11e4-ab6d-005056801329",
          "SettlementStreetRef": "ff76dd33-684c-11e6-8304-00505688561d",
          "SettlementStreetDescription": "Незалежності",
          "Present": "бул. Незалежності",
          "StreetsType": "0f1d7f4b-4bba-11e4-ab6d-005056801329",
          "StreetsTypeDescription": "бул.",
          "Location": ""
        }
      ]
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <TotalCount>1</TotalCount>
            <Addresses>
                <item>
                    <SettlementRef>e715719e-4b33-11e4-ab6d-005056801329</SettlementRef>
                    <SettlementStreetRef>ff76dd33-684c-11e6-8304-00505688561d</SettlementStreetRef>
                    <SettlementStreetDescription>Незалежності</SettlementStreetDescription>
                    <Present>бул. Незалежності</Present>
                    <StreetsType>0f1d7f4b-4bba-11e4-ab6d-005056801329</StreetsType>
                    <StreetsTypeDescription>бул.</StreetsTypeDescription>
                    <Location></Location>
                </item>
            </Addresses>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>