City Alerts API

Сервіс для пошуку територіальних одиниць з державних реєстрів. Інтеграція з повітряними тривогами, щоб повертати адміністративний код локації із загрозою

💸 Support project

Important

Caution

Доступ до API та використання його вмісту здійснюються виключно на власний ризик.
Розробник за жодних обставин не несе відповідальності перед будь-якою стороною за будь-які прямі, непрямі, випадкові, особливі чи інші збитки, що можуть виникнути внаслідок використання наданої інформації.

Також ми не гарантуємо безперервну роботу сервісу та не несемо відповідальності за його тимчасову недоступність через технічні причини.

Використовуючи API, Ви автоматично погоджуєтесь брати на себе всю відповідальність, що може виникнути під час його застосування.

ℹ️ Джерела інформації

Назва	Ресурси	Ліцензія
Кодифікатор адміністративно-територіальних одиниць та територій територіальних громад	Міністрество розвитку громад та територій України	Creative Commons Attribution 4.0 International license
-Alerts.in.ua	- Посилання на бібліотеку - Документація	MIT
Офіційні повітряні тривоги	- Отримати API ключ - Документація	Дані відсутні

⚠️ Requirements

• Python 3.9+
• Poetry
• API токен від провайдерів даних (Офіційні Повітряні Тривоги або Alerts.in.ua)

📈 Функціонал

• Пошук територіальних одиниць за назвою (області, райони, громади, міста, села та селища) [в розробці]
• Отримання інформації про поточні повітряні тривоги, з включенням коду територіальної громади
• Ієрхаїчний пошук за
• • область (1-й рівень)
  • район (2-й рівень)
  • територіальна громада (3-й рівень)
  • місто, село, селище(4-й рівень)
  • район в місті (5-й рівень) [в майбутньому]

🪛 Prerequisites

1. Отримати API ключ від провайдеру повітряних тривог

Tip

Для успішного отримання токена радимо чітко зазначати справжні цілі використання сервісу. Найкраще написати власними словами, а не згенерований мовними моделями (Gemini, DeepSeek, ChatGPT та інші).

• Офіційні повітряні тривоги:
  • Перейти на сайт → Сторінка "Для розробників (АПІ)" → заповнити форму та отримати ключ на електрону пошту
• Alerts In UA:
  • Заповнити форму на сайті → отримати ключ на електронну пошту

2. Install Python packaging and dependency manager: pip install poetry

⚙️ Setup

1. Install dependencies

   poetry install

2. Set environment variables Create ´.env´ file and set next variables:

• CORRECT_TOKEN - Ваш власний токен, щоб надавати доступ до функціоналу
• AIR_ALERT_API_TOKEN_IN_UA - токен від провайдеру даних air-alert.in.ua
• AIR_ALERT_API_TOKEN_OFFICIAL - токен від Офіційні повітряні тривоги

3. Запустити програму uvicorn main:app --host 0.0.0.0 --port 10000