API System v1

Last Revision: Jul 5, 2017, 11:46:41 AM

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

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-system-v1/bodies

Parameter Default Description
systemName* NULL

The system name

systemId NULL

The system ID if you seek for a duplicate system and want to force a specific ID.

Output:

{
    id      : 85920,
    name    : "HD 43193",
    bodies  : [
        {
            id                              : 219074,
            name                            : "HD 43193 A",
            type                            : "Star",
            subType                         : "B (Blue-White) Star",
            distanceToArrival               : 0,
            isMainStar                      : true,
            isScoopable                     : true,
            age                             : 760,
            absoluteMagnitude               : 0.443283,
            solarMasses                     : 14.5625,
            solarRadius                     : 5.3612057397555715,
            surfaceTemperature              : 30995,
            orbitalPeriod                   : 277.5355324074074,
            semiMajorAxis                   : 0.4615586345240675,
            orbitalEccentricity             : 0.275417,
            orbitalInclination              : 73.390816,
            argOfPeriapsis                  : 23.460678,
            rotationalPeriod                : 2.2797341579861112,
            rotationalPeriodTidallyLocked   : false
        },
        {
            id                              : 311417,
            name                            : "HD 43193 CD 7 a",
            type                            : "Planet",
            subType                         : "Class IV gas giant",
            distanceToArrival               : 17518,
            isLandable                      : false,
            gravity                         : 11.175634423255477,
            earthMasses                     : 1574.405762,
            radius                          : 75701.896,
            surfaceTemperature              : 1021,
            volcanismType                   : "No volcanism",
            atmosphereType                  : "No atmosphere",
            terraformingState               : "Not terraformable",
            orbitalPeriod                   : 55.31602430555556,
            semiMajorAxis                   : 0.11103302421536405,
            orbitalEccentricity             : null,
            orbitalInclination              : 28.739708,
            argOfPeriapsis                  : 248.851364,
            rotationalPeriod                : 57.64743634259259,
            rotationalPeriodTidallyLocked   : true,
            rings: [
                {
                    name            : "HD 43193 CD 7 a A Ring",
                    type            : "Rocky",
                    mass            : 355470000000,
                    innerRadius     : 124910,
                    outerRadius     : 169800
                },
                {
                    name            : "HD 43193 CD 7 a B Ring",
                    type            : "Rocky",
                    mass            : 4354700000000,
                    innerRadius     : 169900,
                    outerRadius     : 423250
                }
            ]
        }
    ]
}

Parameter Description
type

Main type of the celestial body. Can be Star or Planet

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

Parameter Default Description
systemName* NULL

The system name

systemId NULL

The system ID if you seek for a duplicate system and want to force a specific ID.

Output:

{
    id          : 4532,
    name        : "Achali",
    stations    : [
        {
            id                  : 7821,
            name                : "Garratt Ring",
            type                : "Coriolis Starport",
            distanceToArrival   : 977,
            allegiance          : "Federation",
            government          : "Confederacy",
            economy             : "Industrial",
            haveMarket          : true,
            haveShipyard        : true,
            controllingFaction  : {
                id                  : 5185,
                name                : "Coalition of Achali"
            }
        },
        {
            id                  : 42508,
            name                : "Vinge Silo",
            type                : "Planetary settlement",
            distanceToArrival   : 978,
            allegiance          : "Federation",
            government          : "Confederacy",
            economy             : "Military",
            haveMarket          : true,
            haveShipyard        : false,
            controllingFaction  : {
                id                  : 13276,
                name                : "Tuvan Coalition"
            }
        }
    ]
}

Parameter Description
type

Main type of the station.

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

Parameter Default Description
systemName* NULL

The system name

systemId NULL

The system ID if you seek for a duplicate system and want to force a specific ID.

Output:

{
    id                  : 4532,
    name                : "Achali",
    controllingFaction  : {
        id                  : 5185,
        name                : "Coalition of Achali"
    },
    factions            : [
        {
            id              : 5185,
            name            : "Coalition of Achali",
            influence       : 0.638,
            state           : "None",
            isPlayer        : false
        },
        {
            id              : 13276,
            name            : "Tuvan Coalition",
            influence       : 0.183,
            state           : "None",
            isPlayer        : false
        }
    ]
}

Parameter Description
isPlayer

true/false, depending if the current factions is a player controller faction.