¶ Public API of game
This article will tell you about the official game API available, how to use it, and what data can be obtained.
API can be divided into three types:
- Information on incoming attacks on the game account.
- Information on planets and players in a specific galaxy
- Information on resource processing at Space Stations
The last item is available only to corporation owners and only for those Space Stations that are on this account (the owner).
¶ Available to any player
¶ Information on attacks
To get this information, you will need to generate an API key. This can be done on the settings page
At the very bottom, click on the "view" button. In the window that appears, click on the "other" button. The site will generate a new API key. Copy it.
This must be done for each of your game accounts.
At the moment, this key has only one use: to receive information about attacks on this account.
The key does not provide any access to your account. You cannot manage account with it.
If any community asks you to provide this key to track attacks, then it is completely safe.
Now let's move on to the API itself.
Request link is:
https://galaxyonline.io/api/galaxy-multi-users/get-full-warnings
You need to add a JSON object with a list of keys to the request:
{"apikeys": ["apikey1","apikey2", ..., "apikeyN"]}
Request type GET.
Request frequency: no more than once every five seconds. That is, there should be a pause of at least 5 seconds between them.
Example of use in the Python programming language with the requests module:
import requests
url = "https://galaxyonline.io/api/galaxy-multi-users/get-full-warnings"
data = {"apikeys": ["apikey1", "apikey2"]}
response = requests.get(url, json = data)
attacks = response.json()
print(attacks)
¶ Responses from the server
Let's list the possible responses from the game server
-
If you do not transmit any keys, the response will be:
{"error":"no worked keys"} -
If you pass at least one non-working (incorrect) key, for example "abracadabra", then the answer will be:
{'error': 'error key abracadabra'} -
If you make two requests in a row without a pause, the answer for the second request will be:
{'msg': 'Не чаще 1 действя в 5сек.'} -
If everything is in order with the keys, then you can expect two possible answers.
If none of the listed accounts are under attack, the response will be:
[] -
If at least one of the listed accounts is under attack, the response will be:
{"apikey1":
[
{
"id": "17544416", // ID of movement
"sender_user_id": "1000", // ID player-sender
"target_user_id": "2000", // ID player-target
"planet_from":"11-Tashio", // Name of the planet of player-sender
"planet_to":"Fasria", // Name of the planet of player-target
"remaining": 26895, // Time in seconds until fleet arrive
"units": // List of ships (visible if in the area of the Detection Station on the Planet), without this false
{"1": // "1" и "unit_id" - ID of spaceship
{"unit_id":"1","quantity":"1"} // "quantity" - of spaceships
}
}
]
}
Each account has its own key.
The response will contain a JSON object (dictionary), where each key will correspond to an array (list) of dictionaries.
The array will list all attacks.
The example contains comments on the fields.
More about "units".
If there is a Detection Station building on the Planet and if at the time of the request the attack is within the radius of the building, then for the value "units" the types of ships and their number will be listed.
Otherwise the value will be false.
Ship IDs:
- 1 - Hercules
- 2 - Loki
- 3 - Raptor
- 4 - Hornet
- 5 - Javelin
- 6 - Excalibur
- 7 - Valkyrie
- 8 - Titan
- 9 - Abaddon
¶ Information on Galaxy
Ссылка для запроса:
https://galaxyonline.io/api/galaxy-users-map?galaxy_id=N
Request link is:
Request type GET.
Request frequency: no more than once every five seconds. That is, there should be a pause of at least 5 seconds between them.
Let's list the galaxy IDs:
- 1 - Alpha
- 2 - Beta
- 3 - Gamma
- 4 - Delta
- 5 - Epsilon
- 6 - Zeta
- 55 - Omega
These are the main galaxies.
You can also get information on corporate galaxies:
- 7 - Monster's Inc
- 8 - Health Corporation
- 9 - PWNZ
- 10 - CWAR
- 11 - BF Galaxy
- 12 - Healthy
- 13 - Great Glory Hole
- 14 - White Sharks
- 15 - Expansion
- 16 - ONLY1
- 25 - Fantom Reapers
- 40 - Blomag
- 61 - LUXURY
And we still have free corporate galaxies, their IDs range from 17 to 63, excluding those already listed.
Example of use in the Python programming language with the requests module:
import requests
url = "https://galaxyonline.io/api/galaxy-users-map?galaxy_id=4"
response = requests.get(url)
data = response.json()
planets = data.get("planets")
users = data.get("users")
print(f"Delta Galaxy.\nTotal planets: {len(planets)}\nTotal players: {len(users)}")
¶ Server Responses
-
If you do not specify the galaxy ID, the response will be:
{"error":"need set galaxy_id"} -
If you make two requests in a row without a pause, the answer for the second request will be:
{'msg': 'Не чаще 1 действя в 5сек.'} -
If the request is correct, the answer will be:
{
"planets": [
{
"id": "4659777",
"x": "1324745",
"y": "624581",
"name": "Brisium",
"custom_name": "Mago10",
"resource_id": "1",
"size": "2",
"user_id": "4106"
},
{...},
{...},
...
],
"users": {
"4106": {
"id": "4106",
"username": "mirkomago",
"cord_id": null,
"corp_title": null
},
"3745": {
"id": "3745",
"username": "Sabzero SP",
"cord_id": "16",
"corp_title": "Space Peppers"
},
"456": {...},
...
}
}
¶ Planets
- id - ID of the planet
- x, y - planet's coordinates
- name - the default name of the planet
- custom_name - the name of the planet given by the player. Can be null
- resource_id - ID of the planet's type
- size - ID size of the planet
- user_id - ID of the planet owner. Can be null if the planet is free.
Planet type IDs:
- 1 - Torium
- 2 - Vanadium
- 3 - Otarium
- 4 - Chromium
- 5 - Cladium
- 6 - Neodium
- 7 - Minterium
- 9 - Refining Type Space Station
- 12 - Production Type Space Station
- 11 - Quest or Pirate Station
Planet size IDs:
- 0 - 3 mines
- 1 - 4 mines
- 2 - 5 mines
All Space and Pirate Stations are size 2.
¶ Users
- id - ID of the player
- username - name of the player
- corp_id - ID of the clan or corporation the player is a member of, otherwise null
- corp_title - the name of the clan or corporation the player is a member of, otherwise null
¶ Available to corporate owners
¶ Resource processing on SS
Request link is:
https://galaxyonline.io/api/galaxy-corporations/stations-convertations?key=apikey&date_from=2024-11-01&date_to=2024-11-02
Where
apikey is the key to the API of the account of the corporation owner (the account itself is in the main galaxy, not the corporate "clone")
date_from=2024-11-01 is the start date of the information slice, year-month-day
date_to=2024-11-02 is the end date of the information slice, year-month-day
Request type GET.
It is recommended to make a request for a specific day in order to avoid possible errors. In this case, you must specify the start date for this day, and the end date for the next day.
Example of use in the Python programming language with the requests module:
import requests
apikey = "abracadabra"
url = f"https://galaxyonline.io/api/galaxy-corporations/stations-convertations?key={apikey}&date_from=2024-11-01&date_to=2024-11-02"
response = requests.get(url)
data = response.json()
print(data)
¶ Responses from the server
-
If you do not specify the key, the response will be:
{"error":"no key"} -
If you specify an incorrect key, the answer will be:
{"error":"error key"} -
If everything is correct, but there is no information for the selected dates, then the answer will be:
{"data":[]} -
If there is too much information, the response will not be a JSON object. Its type will be
'Content-Type': 'text/html'
And the response itself will contain an Nginx server error.
An error occurred. Sorry, the page you are looking for is currently unavailable. Please try again later. If you are the system administrator of this resource then you should check the error log for details. Faithfully yours, nginx.
- If everything is correct and there is information for a specific date, then the answer will be:
{"data":
[
{
"id":"86792354",
"username":"Solomon Reed",
"user_id":"123",
"planet_id":"46000000",
"planet_custom_name":"Phantom Liberty",
"planet_name":"Voblium",
"resource_id":"6",
"resource_count":"17863",
"energy_reward":"428712",
"energy_to_cs_owner":"142904",
"created_at":"2024-11-02 02:59:26"
}
]
}
Where
- id - ID of the operation
- username - player's name, that had sent resources
- user_id - ID of the player, that had sent resources
- planet_id - ID of the Space Station
- planet_custom_name - custom name of the Space Station
- planet_name - default name of the Space Station
- resource_id - ID of the mineral (it is also a type of the planet, look above) for processing
- resource_count - amount of resources
- energy_reward - the amount of energy that the sender received
- energy_to_cs_owner - the amount of energy that the owner of the Space Station received
- created_at - time of operation