Module systems_api

Expand description

Version of specification: 2.0.0

Enums§

GetJumpGateError: Enum for known errors of method get_jump_gate.
GetJumpGateSuccess: Enum for successes of method get_jump_gate.
GetMarketError: Enum for known errors of method get_market.
GetMarketSuccess: Enum for successes of method get_market.
GetShipyardError: Enum for known errors of method get_shipyard.
GetShipyardSuccess: Enum for successes of method get_shipyard.
GetSystemError: Enum for known errors of method get_system.
GetSystemSuccess: Enum for successes of method get_system.
GetSystemWaypointsError: Enum for known errors of method get_system_waypoints.
GetSystemWaypointsSuccess: Enum for successes of method get_system_waypoints.
GetSystemsError: Enum for known errors of method get_systems.
GetSystemsSuccess: Enum for successes of method get_systems.
GetWaypointError: Enum for known errors of method get_waypoint.
GetWaypointSuccess: Enum for successes of method get_waypoint.

get_jump_gate: Get jump gate details for a waypoint. Requires a waypoint of type JUMP_GATE to use. The response will return all systems that are have a Jump Gate in range of this Jump Gate. Those systems can be jumped to from this Jump Gate.
get_market: Retrieve imports, exports and exchange data from a marketplace. Requires a waypoint that has the Marketplace trait to use. Send a ship to the waypoint to access trade good prices and recent transactions. Refer to the Market Overview page to gain better a understanding of the market in the game.
get_shipyard: Get the shipyard for a waypoint. Requires a waypoint that has the Shipyard trait to use. Send a ship to the waypoint to access data on ships that are currently available for purchase and recent transactions.
get_system: Get the details of a system.
get_system_waypoints: Return a paginated list of all of the waypoints for a given system. If a waypoint is uncharted, it will return the Uncharted trait instead of its actual traits.
get_systems: Return a paginated list of all systems.
get_waypoint: View the details of a waypoint. If the waypoint is uncharted, it will return the ‘Uncharted’ trait instead of its actual traits.