Difference between revisions of "WebAPI:Galaxies"

From Starsonata Wiki
Jump to: navigation, search
Line 3: Line 3:
 
==Response==
 
==Response==
 
Returns an array '''galaxies''' with members keyed by their galaxy ID. Each galaxy has the following attributes.
 
Returns an array '''galaxies''' with members keyed by their galaxy ID. Each galaxy has the following attributes.
* <code>ID</code> - The galaxy ID
+
* <code>ID</code> - The galaxy ID. This is unique per galaxy in a universe.
 +
* <code>name</code> - The galaxy name.
 +
* <code>lastUpdate</code> - The last time the galaxy was updated in the api.
 +
* <code>x</code> - The x coordinate for the map.
 +
* <code>y</code> - The y coordinate for the map.
 +
* <code>links</code> - An array of galaxy IDs that this galaxy has wormholes leading to.
 +
* <code>layer</code> - The layer of the map that this galaxy resides in.
  
 
==Example==
 
==Example==

Revision as of 18:37, 14 June 2018

This returns a list of all galaxies in the game that have been discovered or otherwise marked as public knowledge.

Response

Returns an array galaxies with members keyed by their galaxy ID. Each galaxy has the following attributes.

  • ID - The galaxy ID. This is unique per galaxy in a universe.
  • name - The galaxy name.
  • lastUpdate - The last time the galaxy was updated in the api.
  • x - The x coordinate for the map.
  • y - The y coordinate for the map.
  • links - An array of galaxy IDs that this galaxy has wormholes leading to.
  • layer - The layer of the map that this galaxy resides in.

Example