Network

This documentation describes working with a real-time data transfer service. Please read this documentation carefully to understand how to work with our network.

The first connection:

First, you need to determine the server's IP address and port. Since there may be more than one server and some servers may be disconnected and connected by us, use the API v2 getListSpotServers method. This method will return a list of IP addresses and server ports to connect to.

You can connect using the TCP Logger of a third-party software, or by running a command in the terminal.:

telnt {ip} {port}

After connecting, you will start receiving messages in json format, then we will talk about these messages as events. Below is an example of spot events, which events exist and how to handle them, read on.

Events:

At the moment, there are only 3 events, these are: spot, message, sun. All events that are broadcast to the servers from the getListSpotServers method are identical. This is done in order to ensure the delivery of messages, spots and any other data to all users of the system. Regardless of which specific server the user is connected to, they will receive a complete and identical set of events. This ensures data uniformity and synchronicity of all clients in a distributed environment.

{
    "event": "name_event", // ENUM can have values: spot, message, sun
    "data": {...}, // Given the events, read the description of the events.
    "event_at": "Y-m-d H:i:s" // Date and time of the event: 2025-08-29 19:07:43
}

Event: message

This event informs you about sending a message in the chat. An API request to the sendMessage method is used for this purpose. For more information about working with sending messages, see the API v2 documentation.

You can get a list of chats using the getChats method.

{
    "chat_id": 1,
    "sender": "R4CAT/P",
    "text_color": "#1E3A5F",
    "background_color": "#E6F0FA",
    "text": "Hi! I'm in the field right now, send someone with tea, it's cold in here."
}

Result:

Event: sun

It sends an up-to-date index of solar activity. It is useful to track it so that you do not access the service's API.

{
    "value": 4 // Small geomagnetic storm.
}

1. 1 — There are no noticeable disturbances.
2. 2 — Small disturbances.
3. 3 — A weak geomagnetic storm.
4. 4 — Small geomagnetic storm.
5. 5 — Moderate geomagnetic storm.
6. 6 — Strong geomagnetic storm.
7. 7 — A severe geomagnetic storm.
8. 8 — An extreme storm.