Адреси та черги

Пошук вулиці

Ознайомтеся з параметрами запиту та форматом відповіді методу.

GET/api/v1/address-directory/street-search

API-ключ - спільна квота облікового запису

Параметри URL та запиту

katottgstring - queryОбов'язковий: Код населеного пункту.
qstring - queryОбов'язковий: Назва вулиці, 2-80 символів.

Запит і відповідь

Обовʼязкові katottg населеного пункту та q довжиною від 2 до 80 символів. Відповідь обмежена 20 збігами.

Передайте API-ключ у заголовку Authorization. При 401 перевірте ключ; при 403 - підписку та доступність методу; при 429 враховуйте Retry-After.

Атрибути відповіді

Атрибути елемента масиву

valuestring: Ідентифікатор вулиці для запитів будинків і черг.
labelstring: Назва вулиці для відображення.

Приклад запиту

curl --fail-with-body --max-time 10 \
  'https://alerts.energy/api/v1/address-directory/street-search?katottg=UA80000000000093317&q=%D0%A5%D1%80%D0%B5%D1%89%D0%B0%D1%82%D0%B8%D0%BA' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Приклад відповіді

Умовний скорочений приклад формату. Він не описує поточну ситуацію.

[
  {
    "value": "000000000000000000000000",
    "label": "вул. Прикладна"
  }
]