Eve Swagger JS

Class: Planet

Planet

An api adapter that provides functions for accessing various details for a planet specified by id, via functions in the universe ESI endpoints. You should not usually instantiate this directly as its constructor requires an internal api instance.

new Planet(agent, planetId)

Create a new Planet for the given agent provider and specific planetId.

Parameters:
Name Type Description
agent ESIAgent

The agent used to generate web requests
planetId Number

The planet id that is used for all requests

Methods

info()

Get information on a planet. This route expires daily at 11:05.

This makes an HTTP GET request to /universe/planets/{planet_id}/. The route version is v1.

On success, this resolves to information about a planet. An example result is:

{
  "name": "Akpivem III",
  "planet_id": 40000046,
  "position": {
    "x": -189226344497,
    "y": 9901605317,
    "z": -254852632979
  },
  "system_id": 30000003,
  "type_id": 13
}
Returns:

A Promise that resolves to the parsed JSON of the response.

Type
Promise.<Object>