2 stable releases

2023.9.30	Oct 8, 2023
2023.6.24	Jun 29, 2023
2.0.0	~~Jun 29, 2023~~

#2223 in Web programming

Apache-2.0

450KB
5.5K SLoC

Rust API client for openapi

SpaceTraders is an open-universe game and learning platform that offers a set of HTTP endpoints to control a fleet of ships and explore a multiplayer universe.

The API is documented using OpenAPI. You can send your first request right here in your browser to check the status of the game server.

{
  \"method\": \"GET\",
  \"url\": \"https://api.spacetraders.io/v2\",
}

Unlike a traditional game, SpaceTraders does not have a first-party client or app to play the game. Instead, you can use the API to build your own client, write a script to automate your ships, or try an app built by the community.

We have a Discord channel where you can share your projects, ask questions, and get help from other players.

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

API version: 2.0.0
Package version: 2.0.0
Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:

openapi = { path = "./openapi" }

Documentation for API Endpoints

All URIs are relative to https://api.spacetraders.io/v2

Class	Method	HTTP request	Description
AgentsApi	get_agent	GET /agents/{agentSymbol}	Get Public Agent
AgentsApi	get_agents	GET /agents	List Agents
AgentsApi	get_my_agent	GET /my/agent	Get Agent
ContractsApi	accept_contract	POST /my/contracts/{contractId}/accept	Accept Contract
ContractsApi	deliver_contract	POST /my/contracts/{contractId}/deliver	Deliver Cargo to Contract
ContractsApi	fulfill_contract	POST /my/contracts/{contractId}/fulfill	Fulfill Contract
ContractsApi	get_contract	GET /my/contracts/{contractId}	Get Contract
ContractsApi	get_contracts	GET /my/contracts	List Contracts
DefaultApi	get_status	GET /	Get Status
DefaultApi	register	POST /register	Register New Agent
FactionsApi	get_faction	GET /factions/{factionSymbol}	Get Faction
FactionsApi	get_factions	GET /factions	List Factions
FleetApi	create_chart	POST /my/ships/{shipSymbol}/chart	Create Chart
FleetApi	create_ship_ship_scan	POST /my/ships/{shipSymbol}/scan/ships	Scan Ships
FleetApi	create_ship_system_scan	POST /my/ships/{shipSymbol}/scan/systems	Scan Systems
FleetApi	create_ship_waypoint_scan	POST /my/ships/{shipSymbol}/scan/waypoints	Scan Waypoints
FleetApi	create_survey	POST /my/ships/{shipSymbol}/survey	Create Survey
FleetApi	dock_ship	POST /my/ships/{shipSymbol}/dock	Dock Ship
FleetApi	extract_resources	POST /my/ships/{shipSymbol}/extract	Extract Resources
FleetApi	extract_resources_with_survey	POST /my/ships/{shipSymbol}/extract/survey	Extract Resources with Survey
FleetApi	get_mounts	GET /my/ships/{shipSymbol}/mounts	Get Mounts
FleetApi	get_my_ship	GET /my/ships/{shipSymbol}	Get Ship
FleetApi	get_my_ship_cargo	GET /my/ships/{shipSymbol}/cargo	Get Ship Cargo
FleetApi	get_my_ships	GET /my/ships	List Ships
FleetApi	get_ship_cooldown	GET /my/ships/{shipSymbol}/cooldown	Get Ship Cooldown
FleetApi	get_ship_nav	GET /my/ships/{shipSymbol}/nav	Get Ship Nav
FleetApi	install_mount	POST /my/ships/{shipSymbol}/mounts/install	Install Mount
FleetApi	jettison	POST /my/ships/{shipSymbol}/jettison	Jettison Cargo
FleetApi	jump_ship	POST /my/ships/{shipSymbol}/jump	Jump Ship
FleetApi	navigate_ship	POST /my/ships/{shipSymbol}/navigate	Navigate Ship
FleetApi	negotiate_contract	POST /my/ships/{shipSymbol}/negotiate/contract	Negotiate Contract
FleetApi	orbit_ship	POST /my/ships/{shipSymbol}/orbit	Orbit Ship
FleetApi	patch_ship_nav	PATCH /my/ships/{shipSymbol}/nav	Patch Ship Nav
FleetApi	purchase_cargo	POST /my/ships/{shipSymbol}/purchase	Purchase Cargo
FleetApi	purchase_ship	POST /my/ships	Purchase Ship
FleetApi	refuel_ship	POST /my/ships/{shipSymbol}/refuel	Refuel Ship
FleetApi	remove_mount	POST /my/ships/{shipSymbol}/mounts/remove	Remove Mount
FleetApi	sell_cargo	POST /my/ships/{shipSymbol}/sell	Sell Cargo
FleetApi	ship_refine	POST /my/ships/{shipSymbol}/refine	Ship Refine
FleetApi	transfer_cargo	POST /my/ships/{shipSymbol}/transfer	Transfer Cargo
FleetApi	warp_ship	POST /my/ships/{shipSymbol}/warp	Warp Ship
SystemsApi	get_jump_gate	GET /systems/{systemSymbol}/waypoints/{waypointSymbol}/jump-gate	Get Jump Gate
SystemsApi	get_market	GET /systems/{systemSymbol}/waypoints/{waypointSymbol}/market	Get Market
SystemsApi	get_shipyard	GET /systems/{systemSymbol}/waypoints/{waypointSymbol}/shipyard	Get Shipyard
SystemsApi	get_system	GET /systems/{systemSymbol}	Get System
SystemsApi	get_system_waypoints	GET /systems/{systemSymbol}/waypoints	List Waypoints in System
SystemsApi	get_systems	GET /systems	List Systems
SystemsApi	get_waypoint	GET /systems/{systemSymbol}/waypoints/{waypointSymbol}	Get Waypoint

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

joel@spacetraders.io

Dependencies

~4–19MB
~232K SLoC