API Systems v1

Last Revision: 2 mars 2017 13:15:08

All messages returned by the API are in JSON. Most queries work with GET but they should also be compatible with POST requests.

The new documentation for this API is not finished yet. You can find the old one here: API v1.

If you need to do some testing on our API, please use the http://beta.edsm.net:8080/ endpoint.
It is usually up to date with the production database, but if not, send us a message.

HTTP Request: GET https://www.edsm.net/api-v1/system

Parameter Default Description
systemName* NULL

The system name

showId 0

Set to 1 to get our internal ID for that system.

showCoordinates 0

Set to 1 to get the system coordinates.
If coordinates are unknown, the coords key will not be returned.

showPermit 0

Set to 1 to get the system permit if there is one.
If the permit is named, also return permitName.

showInformation 0

Set to 1 to get the system information like allegiance, government...
If no information are stored, an empty array will be returned.

Output:

{
    name            : "Achali",
    id              : 4532,
    coords          : {
        x               : 50.34375,
        y               : 27.4375,
        z               : 112.28125
    },
    requirePermit   : false,
    information     : {
        eddbId          : 424,
        allegiance      : "Federation",
        government      : "Confederacy",
        faction         : "Coalition of Achali",
        population      : 1020187
    }
}

Parameter Description
name

Name of the system.

id

Internal ID of the system.

coords

Array of coordinates if known.

requirePermit

true/false.

permitName

Name fo required permit, if not Unknown.

information

Array of information if known.

  • allegiance : The current allegiance of the system.
  • government : The current government of the system.
  • faction : The current faction of the system.
  • population : The current population of the system.

HTTP Request: GET https://www.edsm.net/api-v1/systems

HTTP Request: GET https://www.edsm.net/api-v1/sphere-systems

HTTP Request: GET https://www.edsm.net/api-v1/cube-systems

HTTP Request: GET https://www.edsm.net/api-v1/hidden-systems

HTTP Request: GET https://www.edsm.net/api-v1/distances

HTTP Request: GET https://www.edsm.net/api-v1/hidden-distances