APIs and data end points - Revision history

yuugh: transclude current API and mark older API as such

2024-09-23T21:32:12Z

transclude current API and mark older API as such

Jechtz at 05:41, 10 November 2019

2019-11-10T05:41:18Z

Blue dwarf at 10:50, 15 June 2018

2018-06-15T10:50:21Z

Blue dwarf at 16:25, 29 June 2017

2017-06-29T16:25:23Z

Blue dwarf: Created page with "=APIs= None yet, sorry! =Data end points= ==Universe data== Data for the current structure of the universe is available in JSON format from [http://www.starsonata.com/ss_api/..."

2016-03-04T21:19:51Z

Created page with "=APIs= None yet, sorry! =Data end points= ==Universe data== Data for the current structure of the universe is available in JSON format from [http://www.starsonata.com/ss_api/..."

New page

=APIs=
None yet, sorry!

=Data end points=
==Universe data==
Data for the current structure of the universe is available in JSON format from [http://www.starsonata.com/ss_api/universe.json starsonata.com/ss_api/universe.json], note that currently the data here isn't automatically updated, and may be out of date currently (2016-03-04).

Please also attempt to limit accessing the file, the file for an entire universe is about 1MB, use some form of caching or retention to limit requests to the file (as well as spending up your use).

===Format===
The entire file is a JSON object of more objects. The keys in the root object are galaxy IDs, these are unique and persist throughout the universe.
Note that the data can be in any order, as JSON objects are unordered.

Here is an extract, for Sol:
<pre>
"2052387433":
{
"w": ["2052386983","2052386984","2052386986","2052386992","2052386993","2052386999","2052387266","2052387333","2052431813","2052645243"],
"n":"Sol",
"a":0,
"x":0,
"s":0,
"l":0,
"y":0,
"u":0,
"p":1,
"df":0,
"b":7,
"t":"Earthforce",
"o":1
}
</pre>

====n====
The is the full name of the galaxy, note that this may not be unique (but should be).

====x====
The x position of the galaxy on the star map, as a real number, 0.0 is the centre going to the right as it increase towards infinity.

====y====
The y position of the galaxy on the star map, as a real number, 0.0 is the centre going down as it increases towards infinity.

====df====
The danger factor of the galaxy, note that this value will be 100 times smaller than what you see in the game

====l====
The layer id this galaxy is on the map.

* Earthforce: 0
* Wild Space: 3
* Perilous Space: 4
* Subspace: 5
* Nexus: 10
* Colour Empires: 11
* Serengeti: 12
* Nihilite: 13
* Absolution: 15
* Enigmatic Sector: 16
* Iq' Bana: 17
* Olympus: 18
* Liberty: 19
* Subspace instances: 20
* Arctia: 21
* Vulcan: 22
* Suqq Bana: 23
* Jungle: 24
* Kidd: 35
* Holiday (Lapland, Easter Warren): 36

====w====
An array of galaxies (by id) that this galaxy has wormholes to, note that this galaxy may not exist in the root object if they've not been discovered by a player yet.

====a====
Boolean flag (0 or 1) for whether this galaxy is an anchor galaxy. Anchor galaxies have connections to other layers, like Deep Space.

====s====
Boolean flag (0 or 1) for special galaxies. In game this is signified on the map by the name being coloured in purple.

====u====
The number of user bases that are in this galaxy.

====b====
The number of space stations that are in this galaxy.

====t====
The name of the owning/protecting team, if there is one.

====o====
Boolean flag (0 or 1) for whether this galaxy is owned, note that this'll still be set regardless of p.

====p====
Boolean flag (0 or 1) for whether this galaxy is protected.

@@ Line 1: / Line 1: @@
 =APIs=
-[[WebAPI:Main]]
+{{WebAPI:Main}}
-=Data end points=
+= (Old) Data end points=
 ==Bulletin board==
 XML for the bulletin board can be accessed from [http://www.starsonata.com/ss_api/bboard.xml]. It's updated once a minute.

@@ Line 58: / Line 58: @@
 * Perilous Space: 4
 * Subspace: 5
 * Nexus: 10
 * Colour Empires: 11

@@ Line 3: / Line 3: @@
 =Data end points=
-==Universe data==
+==Bulletin board==
 Data for the current structure of the universe is available in JSON format from [http://www.starsonata.com/ss_api/universe.json starsonata.com/ss_api/universe.json], note that currently the data here isn't automatically updated, and may be out of date currently (2016-03-04).