Documentation

Quick Start

Get Your API Key

Request your free API key from the main page.

Install Socket.IO Client

Siren uses Socket.IO for real-time communication. Install the client for your language:

JavaScript/Node.js

bash

1npm install socket.io-client

Python

bash

1pip install python-socketio

For other languages, visit the official Socket.IO documentation

Connect and Listen

Connect to the Siren server and start receiving alerts:

javascript

1const io = require('socket.io-client');
2
3const socket = io('https://sirenapi.orielhaim.com', {
4    auth: {
5        apiKey: 'your-api-key-here'
6    }
7});
8
9// Listen to all alerts (returns array of alerts)
10socket.on('alert', (alerts) => {
11    alerts.forEach(alert => {
12        console.log(`New ${alert.type} alert:`, alert);
13        // Handle each alert
14    });
15});
16
17// Or listen to specific alert types (returns single alert object)
18socket.on('missiles', (alert) => {
19    console.log('Missile alert:', alert);
20});
21
22socket.on('endAlert', (alert) => {
23    console.log('End event:', alert);
24});