README

The API client for alerts.in.ua is a PHP library that simplifies access to the alerts.in.ua API service. It provides real-time information about air raid alerts in Ukraine. The library supports asynchronous operations, making it easy to integrate with various applications and services.

Note

This unofficial library may not fully support the official alerts.in.ua API and is still in early development, so expect changes or instability.

Installation

To install the API Client for alerts.in.ua in PHP, run the following command in your terminal:

composer require fyennyi/alerts-in-ua-php

Usage

⚠️ Before you can use this library, you need to obtain an API token by visiting devs.alerts.in.ua.

Basic Setup

First, create a client instance with your API token:

require 'vendor/autoload.php';

use Fyennyi\AlertsInUa\Client\AlertsClient;

$client = new AlertsClient('your_token');

Getting Active Alerts

Here's how to fetch and display all currently active alerts:

$alertsResult = $client->getActiveAlerts(false);
$client->wait();

try {
    $alerts = $alertsResult->getReturn();
    echo 'Active alerts: ' . count($alerts->getAllAlerts()) . "\n";

    foreach ($alerts->getAllAlerts() as $alert) {
        echo "{$alert->getAlertType()} in {$alert->getLocationTitle()}\n";
    }
} catch (\Exception $e) {
    echo 'Error: ' . $e->getMessage() . "\n";
}

Getting Alerts History

To retrieve historical alert data for a specific region:

// Get alerts history for Kharkiv Oblast from the last day
$historyResult = $client->getAlertsHistory('Харківська область', 'day_ago', false);
$client->wait();

try {
    $history = $historyResult->getReturn();
    echo "\nAlerts history for Kharkiv Oblast: " . count($history->getAllAlerts()) . "\n";

    foreach ($history->getAllAlerts() as $alert) {
        $status = $alert->isFinished() ? 'Finished' : 'Active';
        echo "{$alert->getAlertType()} in {$alert->getLocationTitle()} - {$status}\n";
    }
} catch (\Exception $e) {
    echo 'Error: ' . $e->getMessage() . "\n";
}

Getting Air Raid Alert Statuses

To check the current status of air raid alerts across all oblasts:

$statusesResult = $client->getAirRaidAlertStatusesByOblast();
$client->wait();

try {
    $statuses = $statusesResult->getReturn();
    echo "\nAir raid alert statuses by oblast:\n";

    foreach ($statuses->getStatuses() as $status) {
        echo "{$status->getOblast()}: {$status->getStatus()}\n";
    }
} catch (\Exception $e) {
    echo 'Error: ' . $e->getMessage() . "\n";
}

Filtering Alerts

The library provides convenient methods to filter alerts by type and location:

$alertsResult = $client->getActiveAlerts(false);
$client->wait();

try {
    $alerts = $alertsResult->getReturn();

    // Get only air raid alerts
    $airRaidAlerts = $alerts->getAirRaidAlerts();
    echo "\nAir raid alerts: " . count($airRaidAlerts) . "\n";

    // Get only oblast-level alerts
    $oblastAlerts = $alerts->getOblastAlerts();
    echo "Oblast-level alerts: " . count($oblastAlerts) . "\n";

    // Get alerts for a specific oblast
    $kharkivAlerts = $alerts->getAlertsByOblast('Харківська область');
    echo "Kharkiv Oblast alerts: " . count($kharkivAlerts) . "\n";

} catch (\Exception $e) {
    echo 'Error: ' . $e->getMessage() . "\n";
}

Methods

AlertsClient

`getActiveAlerts($use_cache = true)`

Fetches a list of active alerts asynchronously.

$use_cache (bool, optional) – If true, uses cached data when available. Defaults to true.
Returns: Fiber<Alerts>

`getAlertsHistory($oblast_uid_or_location_title, $period = 'week_ago', $use_cache = true)`

Fetches the history of alerts for a specific region or location.

$oblast_uid_or_location_title (string|int) – The unique ID or location title of the oblast or location.
$period (string, optional) – The period for which to fetch the history. Defaults to 'week_ago'.
$use_cache (bool, optional) – If true, uses cached data when available. Defaults to true.
Returns: Fiber<Alerts>

`getAirRaidAlertStatus($oblast_uid_or_location_title, $oblast_level_only = false, $use_cache = true)`

Fetches the status of air raid alerts for a specific oblast.

$oblast_uid_or_location_title (string|int) – The unique ID or location title of the oblast or location.
$oblast_level_only (bool, optional) – If true, returns only oblast-level alerts. Defaults to false.
$use_cache (bool, optional) – If true, uses cached data when available. Defaults to true.
Returns: Fiber<AirRaidAlertOblastStatus>

`getAirRaidAlertStatusesByOblast($oblast_level_only = false, $use_cache = true)`

Fetches the status of air raid alerts for all oblasts.

$oblast_level_only (bool, optional) – If true, returns only oblast-level alerts. Defaults to false.
$use_cache (bool, optional) – If true, uses cached data when available. Defaults to true.
Returns: Fiber<AirRaidAlertOblastStatuses>

`wait()`

Waits for all asynchronous operations (fibers) to complete.

Returns: void

Districts and Regions (UIDs)

Open the table

UID	Name
13	Івано-Франківська область
68	Івано-Франківський район
67	Верховинський район
71	Калуський район
70	Коломийський район
69	Косівський район
72	Надвірнянський район
29	Автономна Республіка Крим
8	Волинська область
38	Володимирський район
41	Камінь-Каширський район
40	Ковельський район
39	Луцький район
4	Вінницька область
36	Вінницький район
37	Гайсинський район
35	Жмеринський район
33	Могилів-Подільський район
32	Тульчинський район
34	Хмільницький район
9	Дніпропетровська область
44	Дніпровський район
42	Кам'янський район
46	Криворізький район
47	Нікопольський район
45	Павлоградський район
43	Самарівський район
48	Синельниківський район
28	Донецька область
54	Бахмутський район
55	Волноваський район
51	Горлівський район
53	Донецький район
49	Кальміуський район
50	Краматорський район
52	Маріупольський район
56	Покровський район
10	Житомирська область
57	Бердичівський район
59	Житомирський район
60	Звягельський район
58	Коростенський район
11	Закарпатська область
61	Берегівський район
65	Мукачівський район
63	Рахівський район
64	Тячівський район
66	Ужгородський район
62	Хустський район
12	Запорізька область
564	м. Запоріжжя
147	Бердянський район
146	Василівський район
149	Запорізький район
148	Мелітопольський район
145	Пологівський район
14	Київська область
78	Бориспільський район
79	Броварський район
75	Бучанський район
73	Білоцерківський район
74	Вишгородський район
76	Обухівський район
77	Фастівський район
15	Кіровоградська область
82	Голованівський район
81	Кропивницький район
83	Новоукраїнський район
80	Олександрійський район
16	Луганська область
85	Сватівський район
86	Старобільський район
84	Сіверськодонецький район
87	Щастинський район
27	Львівська область
91	Дрогобицький район
94	Золочівський район
90	Львівський район
88	Самбірський район
89	Стрийський район
92	Шептицький район
93	Яворівський район
17	Миколаївська область
96	Баштанський район
95	Вознесенський район
98	Миколаївський район
97	Первомайський район
18	Одеська область
101	Ізмаїльський район
100	Березівський район
105	Болградський район
102	Білгород-Дністровський район
104	Одеський район
99	Подільський район
103	Роздільнянський район
19	Полтавська область
107	Кременчуцький район
106	Лубенський район
108	Миргородський район
109	Полтавський район
5	Рівненська область
110	Вараський район
111	Дубенський район
112	Рівненський район
113	Сарненський район
20	Сумська область
117	Конотопський район
118	Охтирський район
116	Роменський район
114	Сумський район
115	Шосткинський район
21	Тернопільська область
120	Кременецький район
119	Тернопільський район
121	Чортківський район
22	Харківська область
1293	м. Харків
125	Ізюмський район
127	Берестинський район
126	Богодухівський район
123	Куп'янський район
128	Лозівський район
124	Харківський район
122	Чугуївський район
23	Херсонська область
129	Бериславський район
133	Генічеський район
131	Каховський район
130	Скадовський район
132	Херсонський район
3	Хмельницька область
135	Кам'янець-Подільський район
134	Хмельницький район
136	Шепетівський район
24	Черкаська область
150	Звенигородський район
153	Золотоніський район
151	Уманський район
152	Черкаський район
26	Чернівецька область
138	Вижницький район
139	Дністровський район
137	Чернівецький район
25	Чернігівська область
144	Корюківський район
141	Новгород-Сіверський район
142	Ніжинський район
143	Прилуцький район
140	Чернігівський район
31	м. Київ
1077	Миргородська територіальна громада
1088	Кременчуцька територіальна громада
1187	Сумська територіальна громада
1284	Липецька територіальна громада
1293	Харківська територіальна громада
1313	Вовчанська територіальна громада
1396	Старокостянтинівська територіальна громада
279	Криворізька територіальна громада
332	Дніпровська територіальна громада
349	Марганецька територіальна громада
350	Мирівська територіальна громада
351	Нікопольська територіальна громада
353	Покровська територіальна громада
356	Червоногригорівська територіальна громада
5279	м. Кривий Ріг
5332	м. Дніпро
5349	м. Марганець
5351	м. Нікополь
5564	м. Запоріжжя
564	Запорізька територіальна громада
5711	м. Біла Церква
5786	м. Світловодськ
586	Оріхівська територіальна громада
5931	м. Очаків
5941	м. Вознесенськ
5950	м. Южноукраїнськ
5964	м. Одеса
6077	м. Миргород
6088	м. Кременчук
6187	м. Суми
6293	м. Харків
6396	м. Старокостянтинів
708	Макарівська територіальна громада
786	Світловодська територіальна громада
899	Арбузинська територіальна громада
903	Кривоозерська територіальна громада
932	Первомайська територіальна громада
941	Вознесенська територіальна громада
950	Южноукраїнська територіальна громада
964	Одеська територіальна громада

Contributing

Contributions are welcome and appreciated! Here's how you can contribute:

Fork the project
Create your feature branch (git checkout -b feature/AmazingFeature)
Commit your changes (git commit -m 'Add some AmazingFeature')
Push to the branch (git push origin feature/AmazingFeature)
Open a Pull Request

Please make sure to update tests as appropriate and adhere to the existing coding style.

License

This project is licensed under the CSSM Unlimited License v2 (CSSM-ULv2). See the LICENSE file for details.

fyennyi / alerts-in-ua-php

Maintainers

Details