Usage Notes

Just some FAQs and notes about pitfalls etc.

• Errors are always thrown then the API request fails (usually an SpaceTradersException)

• If an object attribute has a value of None (or doesn’t exist) is it likely the object hasn’t synced that part of its state from the server

• Python 3.9 or higher necessary for usage.

• Survey.model_dump(mode="json") will dump the survey into a json compatible dictionary.

However ship.extract accepts a Survey object as well.

Finding Methods

Since having documentation for methods that simply make a request to the server is excessive, I will provide a mapping from Stoplight. Things might not have a one to one correspondence however.

• Get Status -> autotraders.status.get_status()

• Register New Agent -> autotraders.register_agent()

Agents

• Get Agent -> autotraders.agent.Agent()

• List Agents -> autotraders.agent.Agent.all()

• Get Public Agent -> autotraders.agent.Agent()

Contracts

• List Contracts -> autotraders.faction.contract.Contract.all()

• Get Contract -> autotraders.faction.contract.Contract()

• Accept Contract -> autotraders.faction.contract.Contract.accept()

• Deliver Cargo to Contract -> autotraders.faction.contract.Contract.deliver()

• Fulfill Contract -> autotraders.faction.contract.Contract.fulfill()

Factions

• List Factions -> autotraders.faction.Faction.all()

• Get Faction -> autotraders.faction.Faction()

Fleet

• List Ships -> autotraders.ship.Ship.all()

• Purchase Ship -> autotraders.map.waypoint_types.shipyard.Shipyard.purchase()

• Get Ship -> autotraders.ship.Ship()

• Get Ship Cargo -> autotraders.ship.Ship.cargo()

• Orbit Ship -> autotraders.ship.Ship.orbit()

• Ship Refine -> autotraders.ship.Ship.refine()

• Create Chart -> autotraders.ship.Ship.chart()

• Get Ship Cooldown -> autotraders.ship.Ship.cooldown() (update via autotraders.ship.Ship.update_ship_cooldown())

• Dock Ship -> autotraders.ship.Ship.dock()

• Create Survey -> autotraders.ship.Ship.survey()

• Extract Resources -> autotraders.ship.Ship.extract()

• Jettison Cargo -> autotraders.ship.Ship.jettison()

• Jump Ship -> autotraders.ship.Ship.jump()

• Navigate Ship -> autotraders.ship.Ship.navigate()

• Patch Ship Nav -> autotraders.ship.Ship.patch_navigation()

• Get Ship Nav -> autotraders.ship.Ship.nav()

• Sell Cargo -> autotraders.ship.Ship.sell()

• Scan Systems -> autotraders.ship.Ship.scan_systems()

• Scan Waypoints -> autotraders.ship.Ship.scan_waypoints()

• Scan Ships -> autotraders.ship.Ship.scan_ships()

• Refuel Ship -> autotraders.ship.Ship.refuel()

• Purchase Cargo -> autotraders.ship.Ship.buy()

• Transfer Cargo -> autotraders.ship.Ship.transfer()

• Negotiate Contract -> autotraders.faction.contract.Contract.negotiate()

• Get Mounts -> autotraders.ship.Ship.mounts()

• Install Mount -> autotraders.ship.Ship.install_mount()

• Remove Mount -> autotraders.ship.Ship.remove_mount()

Systems

• List Systems -> autotraders.map.system.System.all()

• Get System -> autotraders.map.system.System()

• List Waypoints in System -> autotraders.map.waypoint.Waypoint.all()

• Get Waypoint -> autotraders.map.waypoint.Waypoint()

• Get Market -> autotraders.map.waypoint_types.marketplace.Marketplace()

• Get Shipyard -> autotraders.map.waypoint_types.shipyard.Shipyard()

• Get Jump Gate -> autotraders.map.waypoint_types.jumpgate.JumpGate()

Versioning

As the game is in alpha the versioning system is not exactly semantic.

• Major releases happen when the code structure changes or there is a breaking matter that involves the codebase

• Minor releases usually occur when major game changes happen, or a new feature has been added.

• Patch releases could be bug fixes or updates to keep up with game changes.