Expand description
Data models for SpaceTraders.
Generated by: https://openapi-generator.tech
Version of specification: 2.0.0
Structs§
- Accept
Contract200 Response - Accept
Contract200 Response Data - Agent
- Agent details.
- Chart
- The chart of a system or waypoint, which makes the location visible to other agents.
- Connected
System - Contract
- Contract details.
- Contract
Deliver Good - The details of a delivery contract. Includes the type of good, units needed, and the destination.
- Contract
Payment - Payments for the contract.
- Contract
Terms - The terms to fulfill the contract.
- Cooldown
- A cooldown is a period of time in which a ship cannot perform certain actions.
- Create
Chart201 Response - Create
Chart201 Response Data - Create
Ship Ship Scan201 Response - Create
Ship Ship Scan201 Response Data - Create
Ship System Scan201 Response - Create
Ship System Scan201 Response Data - Create
Ship Waypoint Scan201 Response - Create
Ship Waypoint Scan201 Response Data - Create
Survey201 Response - Create
Survey201 Response Data - Deliver
Contract200 Response - Deliver
Contract200 Response Data - Deliver
Contract Request - Dock
Ship200 Response - Extract
Resources201 Response - Extract
Resources201 Response Data - Extract
Resources Request - Extraction
- Extraction details.
- Extraction
Yield - Yields from the extract operation.
- Faction
- Faction details.
- Faction
Trait - Fulfill
Contract200 Response - GetAgents200
Response - GetContract200
Response - GetContracts200
Response - GetFaction200
Response - GetFactions200
Response - GetJump
Gate200 Response - GetMarket200
Response - GetMounts200
Response - GetMy
Agent200 Response - GetMy
Ship200 Response - GetMy
Ship Cargo200 Response - GetMy
Ships200 Response - GetShip
Cooldown200 Response - GetShip
Nav200 Response - GetShipyard200
Response - GetStatus200
Response - GetStatus200
Response Announcements Inner - GetStatus200
Response Leaderboards - GetStatus200
Response Leaderboards Most Credits Inner - GetStatus200
Response Leaderboards Most Submitted Charts Inner - GetStatus200
Response Links Inner - GetStatus200
Response Server Resets - GetStatus200
Response Stats - GetSystem200
Response - GetSystem
Waypoints200 Response - GetSystems200
Response - GetWaypoint200
Response - Install
Mount201 Response - Install
Mount201 Response Data - Install
Mount Request - Jettison200
Response - Jettison200
Response Data - Jettison
Request - Jump
Gate - Jump
Ship200 Response - Jump
Ship200 Response Data - Jump
Ship Request - Market
- Market
Trade Good - Market
Transaction - Result of a transaction with a market.
- Meta
- Meta details for pagination.
- Navigate
Ship200 Response - Navigate
Ship200 Response Data - Navigate
Ship Request - Negotiate
Contract200 Response - Negotiate
Contract200 Response Data - Orbit
Ship200 Response - Orbit
Ship200 Response Data - Patch
Ship NavRequest - Purchase
Cargo201 Response - Purchase
Cargo Request - Purchase
Ship201 Response - Purchase
Ship201 Response Data - Purchase
Ship Request - Refuel
Ship200 Response - Refuel
Ship200 Response Data - Refuel
Ship Request - Register201
Response - Register201
Response Data - Register
Request - Remove
Mount201 Response - Remove
Mount201 Response Data - Remove
Mount Request - Scanned
Ship - The ship that was scanned. Details include information about the ship that could be detected by the scanner.
- Scanned
Ship Engine - The engine of the ship.
- Scanned
Ship Frame - The frame of the ship.
- Scanned
Ship Mounts Inner - A mount on the ship.
- Scanned
Ship Reactor - The reactor of the ship.
- Scanned
System - Details of a system was that scanned.
- Scanned
Waypoint - A waypoint that was scanned by a ship.
- Sell
Cargo201 Response - Sell
Cargo201 Response Data - Sell
Cargo Request - Ship
- Ship details.
- Ship
Cargo - Ship cargo details.
- Ship
Cargo Item - The type of cargo item and the number of units.
- Ship
Crew - The ship’s crew service and maintain the ship’s systems and equipment.
- Ship
Engine - The engine determines how quickly a ship travels between waypoints.
- Ship
Frame - The frame of the ship. The frame determines the number of modules and mounting points of the ship, as well as base fuel capacity. As the condition of the frame takes more wear, the ship will become more sluggish and less maneuverable.
- Ship
Fuel - Details of the ship’s fuel tanks including how much fuel was consumed during the last transit or action.
- Ship
Fuel Consumed - An object that only shows up when an action has consumed fuel in the process. Shows the fuel consumption data.
- Ship
Modification Transaction - Result of a transaction for a ship modification, such as installing a mount or a module.
- Ship
Module - A module can be installed in a ship and provides a set of capabilities such as storage space or quarters for crew. Module installations are permanent.
- Ship
Mount - A mount is installed on the exterier of a ship.
- ShipNav
- The navigation information of the ship.
- Ship
NavRoute - The routing information for the ship’s most recent transit or current location.
- Ship
NavRoute Waypoint - The destination or departure of a ships nav route.
- Ship
Reactor - The reactor of the ship. The reactor is responsible for powering the ship’s systems and weapons.
- Ship
Refine201 Response - Ship
Refine201 Response Data - Ship
Refine201 Response Data Produced Inner - Ship
Refine Request - Ship
Registration - The public registration information of the ship
- Ship
Requirements - The requirements for installation on a ship
- Shipyard
- Shipyard
Ship - Shipyard
Ship Types Inner - Shipyard
Transaction - Results of a transaction with a shipyard.
- Survey
- A resource survey of a waypoint, detailing a specific extraction location and the types of resources that can be found there.
- Survey
Deposit - A surveyed deposit of a mineral or resource available for extraction.
- System
- System
Faction - System
Waypoint - Trade
Good - A good that can be traded for other goods or currency.
- Transfer
Cargo200 Response - Transfer
Cargo Request - Waypoint
- A waypoint is a location that ships can travel to such as a Planet, Moon or Space Station.
- Waypoint
Faction - The faction that controls the waypoint.
- Waypoint
Orbital - An orbital is another waypoint that orbits a parent waypoint.
- Waypoint
Trait
Enums§
- Contract
Type - Type of contract.
- Faction
Symbols - The symbol of the faction.
- Faction
Trait Symbol - The unique identifier of the trait.
- Market
Trade Good Supply - A rough estimate of the total supply of this good in the marketplace.
- Market
Transaction Type - The type of transaction.
- Ship
Crew Rotation - The rotation of crew shifts. A stricter shift improves the ship’s performance. A more relaxed shift improves the crew’s morale.
- Ship
Engine Symbol - The symbol of the engine.
- Ship
Frame Symbol - Symbol of the frame.
- Ship
Module Symbol - The symbol of the module.
- Ship
Mount Deposits - Mounts that have this value denote what goods can be produced from using the mount.
- Ship
Mount Symbol - Symbo of this mount.
- Ship
NavFlight Mode - The ship’s set speed when traveling between waypoints or systems.
- Ship
NavStatus - The current status of the ship
- Ship
Reactor Symbol - Symbol of the reactor.
- Ship
Refine Request Produce - The type of good to produce out of the refining process.
- Ship
Role - The registered role of the ship
- Ship
Type - Type of ship
- Survey
Size - The size of the deposit. This value indicates how much can be extracted from the survey before it is exhausted.
- System
Type - The type of waypoint.
- Trade
Symbol - The good’s symbol.
- Waypoint
Trait Symbol - The unique identifier of the trait.
- Waypoint
Type - The type of waypoint.