SpaceTraders OpenAPI (2.1.2)

Download OpenAPI specification:Download

E-mail: spacetraders.syndicate@gmail.com

A SpaceTraders.io API OpenAPI Spec from SpaceTraders Syndicate

Authentication

bearerAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"Bearer {token}"

flight plans

Create User Flight Plan

Authorizations:

bearerAuth

Request Body schema: application/json

shipId required	string
destination required	string

Responses

Request samples

Payload

Content type

application/json

{"shipId": "ckmtrlqpz0109zgopkeqs4m5s",
"destination": "OE-CR"
}

Response samples

200

Content type

application/json

{"flightPlan": {"arrivesAt": "2021-03-28T23:11:50.068Z",
"createdAt": "2021-03-28T23:05:50.068Z",
"departure": "OE-PM-TR",
"destination": "OE-CR",
"distance": 46,
"fuelConsumed": "13,",
"fuelRemaining": 67,
"id": "ckmtrssae0402zgopsy39y9z7",
"shipId": "ckmtrlqpz0109zgopkeqs4m5s",
"terminatedAt": null,
"timeRemainingInSeconds": 365
}
}

Get a User Flight Plan

Authorizations:

bearerAuth

path Parameters

flightPlanId

required

string

Example: ckmtrssae0402zgopsy39y9z7

Responses

Response samples

200

Content type

application/json

{"flightPlan": {"arrivesAt": "2021-03-28T23:11:50.068Z",
"createdAt": "2021-03-28T23:05:50.068Z",
"departure": "OE-PM-TR",
"destination": "OE-CR",
"distance": 46,
"fuelConsumed": "13,",
"fuelRemaining": 67,
"id": "ckmtrssae0402zgopsy39y9z7",
"shipId": "ckmtrlqpz0109zgopkeqs4m5s",
"terminatedAt": null,
"timeRemainingInSeconds": 365
}
}

List Flight Plans

Authorizations:

bearerAuth

path Parameters

symbol

required

string

Example: OE

Responses

Response samples

200

Content type

application/json

{"flightPlans": [{"arrivesAt": "2021-03-28T23:11:50.068Z",
"createdAt": "2021-03-28T23:05:50.068Z",
"departure": "OE-PM-TR",
"destination": "OE-CR",
"id": "ckmtrssae0402zgopsy39y9z7",
"shipId": "ckmtrlqpz0109zgopkeqs4m5s",
"username": "SomeUser"
}
]
}

game

Get Game Status

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"status": "spacetraders is currently online and available to play"
}

loans

Create a New Loan

Authorizations:

bearerAuth

Request Body schema: application/json

type

required

string

Responses

Request samples

Payload

Content type

application/json

{"type": "STARTUP"
}

Response samples

200

Content type

application/json

{"credits": 200000,
"loan": {"id": "cko0ejf4o103666215s6u4pxjvdd",
"due": "2021-04-29T19:07:58.679Z",
"repaymentAmount": 280000,
"status": "CURRENT",
"type": "STARTUP"
}
}

List User's Loans

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"loans": [{"id": "cko0ejf4o103666215s6u4pxjvdd",
"due": "2021-04-29T19:07:58.679Z",
"repaymentAmount": 280000,
"status": "CURRENT",
"type": "STARTUP"
}
]
}

Payoff a Loan

Authorizations:

bearerAuth

path Parameters

loanId

required

string

Example: cko0ejf4o103666215s6u4pxjvwg

Responses

Response samples

200

Content type

application/json

{"user": {"username": "MyUser",
"credits": 421337,
"shipCount": 10,
"structureCount": 1
}
}

locations

Get Game Location

Authorizations:

bearerAuth

path Parameters

symbol

required

string

Example: OE

Responses

Response samples

200

Content type

application/json

{"location": {"symbol": "OE-A1",
"type": "PLANET",
"name": "Alpha",
"x": 3,
"y": 7,
"allowsConstruction": true,
"ships": [{"shipId": "ckno9324k0079iiop71j5nrob",
"username": "SomeUser",
"shipType": "JW-MK-I"
}
],
"structures": [{"id": "ckno69qb105191ds69utcsztz",
"type": "MINE",
"location": "OE-UC-AD",
"status": "Production running. Required inventory is in stock.",
"active": true,
"ownedBy": {"username": "SomeUser"
},
"inventory": [{"good": "METALS",
"quantity": 10
}
],
"consumes": ["string"
],
"produces": ["string"
]
}
]
}
}

List Game Locations Ships

Authorizations:

bearerAuth

path Parameters

symbol

required

string

Example: OE

Responses

Response samples

200

Content type

application/json

{"ships": [{"shipId": "ckno9324k0079iiop71j5nrob",
"username": "SomeUser",
"shipType": "JW-MK-I"
}
]
}

List System Locations

Authorizations:

bearerAuth

path Parameters

symbol

required

string

Example: OE

query Parameters

type	string Example: type=MOON Filter locations fetched on location type
allowsConstruction	boolean Example: allowsConstruction=true

Responses

Response samples

200

Content type

application/json

{"locations": [{"symbol": "OE-A1",
"type": "PLANET",
"name": "Alpha",
"x": 3,
"y": 7,
"allowsConstruction": true,
"ships": [{"shipId": "ckno9324k0079iiop71j5nrob",
"username": "SomeUser",
"shipType": "JW-MK-I"
}
],
"structures": [{"id": "ckno69qb105191ds69utcsztz",
"type": "MINE",
"location": "OE-UC-AD",
"status": "Production running. Required inventory is in stock.",
"active": true,
"ownedBy": {"username": "SomeUser"
},
"inventory": [{"good": "METALS",
"quantity": 10
}
],
"consumes": ["string"
],
"produces": ["string"
]
}
]
}
]
}

marketplace

Get Game Locations Marketplace

Authorizations:

bearerAuth

path Parameters

symbol

required

string

Example: OE

Responses

Response samples

200

Content type

application/json

{"marketplace": [{"symbol": "MACHINERY",
"volumePerUnit": 1,
"quantityAvailable": 1539,
"pricePerUnit": 136,
"purchasePricePerUnit": 136,
"spread": 1,
"sellPricePerUnit": 135
}
]
}

purchase orders

Create a New Purchase Order

Authorizations:

bearerAuth

Request Body schema: application/json

shipId required	string
good required	string
quantity required	number

Responses

Request samples

Payload

Content type

application/json

{"shipId": "ckno92mhi0049iiopc2kmylkz",
"good": "FUEL",
"quantity": 50
}

Response samples

200

Content type

application/json

{"credits": 74300,
"ship": {"id": "ckno9324k0079iiop71j5nroa",
"cargo": [{"good": "METALS",
"quantity": 10
}
],
"class": "string",
"location": "OE-PM-TR",
"manufacturer": "Jackshaw",
"maxCargo": 50,
"plating": 5,
"spaceAvailable": 50,
"type": "JW-MK-I",
"weapons": 5,
"x": 23,
"y": -28
},
"order": {"good": "FUEL",
"quantity": 50,
"pricePerUnit": 3,
"total": 150
}
}

sell orders

Create a New Sell Order

Authorizations:

bearerAuth

Request Body schema: application/json

shipId required	string
good required	string
quantity required	number

Responses

Request samples

Payload

Content type

application/json

{"shipId": "ckno92mhi0049iiopc2kmylkz",
"good": "FUEL",
"quantity": 50
}

Response samples

200

Content type

application/json

{"credits": 74300,
"ship": {"id": "ckno9324k0079iiop71j5nroa",
"cargo": [{"good": "METALS",
"quantity": 10
}
],
"class": "string",
"location": "OE-PM-TR",
"manufacturer": "Jackshaw",
"maxCargo": 50,
"plating": 5,
"spaceAvailable": 50,
"type": "JW-MK-I",
"weapons": 5,
"x": 23,
"y": -28
},
"order": {"good": "FUEL",
"quantity": 50,
"pricePerUnit": 3,
"total": 150
}
}

ships

Buy User Ship

Authorizations:

bearerAuth

Request Body schema: application/json

type required	string
location required	string

Responses

Request samples

Payload

Content type

application/json

{"type": "string",
"location": "string"
}

Response samples

200

Content type

application/json

{"credits": 178875,
"ship": {"id": "ckno9324k0079iiop71j5nroa",
"cargo": [{"good": "METALS",
"quantity": 10
}
],
"class": "string",
"location": "OE-PM-TR",
"manufacturer": "Jackshaw",
"maxCargo": 50,
"plating": 5,
"spaceAvailable": 50,
"type": "JW-MK-I",
"weapons": 5,
"x": 23,
"y": -28
}
}

List User's Ships

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"ships": [{"id": "ckno9324k0079iiop71j5nroa",
"cargo": [{"good": "METALS",
"quantity": 10
}
],
"class": "string",
"location": "OE-PM-TR",
"manufacturer": "Jackshaw",
"maxCargo": 50,
"plating": 5,
"spaceAvailable": 50,
"type": "JW-MK-I",
"weapons": 5,
"x": 23,
"y": -28
}
]
}

Get User's Ship Info

Authorizations:

bearerAuth

path Parameters

shipId

required

string

Example: ckno9324k0079iiop71j5nrob

Responses

Response samples

200

Content type

application/json

{"ship": {"id": "ckno9324k0079iiop71j5nroa",
"cargo": [{"good": "METALS",
"quantity": 10
}
],
"class": "string",
"location": "OE-PM-TR",
"manufacturer": "Jackshaw",
"maxCargo": 50,
"plating": 5,
"spaceAvailable": 50,
"type": "JW-MK-I",
"weapons": 5,
"x": 23,
"y": -28
}
}

Scrap User's Ship

Authorizations:

bearerAuth

path Parameters

shipId

required

string

Example: ckno9324k0079iiop71j5nrob

Responses

Response samples

200

Content type

application/json

{"success": "string"
}

Jettison Ship Cargo

Authorizations:

bearerAuth

path Parameters

shipId

required

string

Example: ckno9324k0079iiop71j5nrob

Request Body schema: application/json

good required	string
quantity required	number

Responses

Request samples

Payload

Content type

application/json

{"good": "FUEL",
"quantity": 50
}

Response samples

200

Content type

application/json

{"good": "FUEL",
"quantityRemaining": 37,
"shipId": "cko1peqal178915s6t8rzdgki"
}

Transfer Ship Cargo

Authorizations:

bearerAuth

path Parameters

fromShipId

required

string

Example: ckno9324k0079iiop71j5nrob

Request Body schema: application/json

toShipId required	string
good required	string
quantity required	number

Responses

Request samples

Payload

Content type

application/json

{"toShipId": "ckn85whu00091r5opkrb5qpzh",
"good": "FUEL",
"quantity": 50
}

Response samples

200

Content type

application/json

{"fromShip": {"id": "ckno9324k0079iiop71j5nroa",
"cargo": [{"good": "METALS",
"quantity": 10
}
],
"class": "string",
"location": "OE-PM-TR",
"manufacturer": "Jackshaw",
"maxCargo": 50,
"plating": 5,
"spaceAvailable": 50,
"type": "JW-MK-I",
"weapons": 5,
"x": 23,
"y": -28
},
"toShip": {"id": "ckno9324k0079iiop71j5nroa",
"cargo": [{"good": "METALS",
"quantity": 10
}
],
"class": "string",
"location": "OE-PM-TR",
"manufacturer": "Jackshaw",
"maxCargo": 50,
"plating": 5,
"spaceAvailable": 50,
"type": "JW-MK-I",
"weapons": 5,
"x": 23,
"y": -28
}
}

List Game Ship Types

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"ships": [{"class": "string",
"manufacturer": "Jackshaw",
"maxCargo": 50,
"plating": 5,
"type": "JW-MK-I",
"weapons": 5,
"speed": 3,
"restrictedGoods": ["string"
]
}
]
}

List System Ships

Authorizations:

bearerAuth

path Parameters

symbol

required

string

Example: OE

Responses

Response samples

200

Content type

application/json

{"ships": [{"shipId": "ckno9324k0079iiop71j5nrob",
"username": "SomeUser",
"shipType": "JW-MK-I"
}
]
}

List System Ship Listings

Authorizations:

bearerAuth

path Parameters

symbol

required

string

Example: OE

Responses

Response samples

200

Content type

application/json

{"shipListings": [{"class": "string",
"manufacturer": "Jackshaw",
"maxCargo": 50,
"plating": 5,
"type": "JW-MK-I",
"weapons": 5,
"purchaseLocations": [{"system": "OE",
"location": "OE-A1",
"price": 16000
}
]
}
]
}

structures

Create User Structure

Authorizations:

bearerAuth

Request Body schema: application/json

location required	string
type required	string

Responses

Request samples

Payload

Content type

application/json

{"location": "OE",
"type": "FARM"
}

Response samples

200

Content type

application/json

{"structure": {"id": "ckno69qb105191ds69utcsztz",
"type": "MINE",
"location": "OE-UC-AD",
"status": "Production running. Required inventory is in stock.",
"active": true,
"ownedBy": {"username": "SomeUser"
},
"inventory": [{"good": "METALS",
"quantity": 10
}
],
"consumes": ["string"
],
"produces": ["string"
]
}
}

List User's Structures

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"structures": [{"id": "ckno69qb105191ds69utcsztz",
"type": "MINE",
"location": "OE-UC-AD",
"status": "Production running. Required inventory is in stock.",
"active": true,
"ownedBy": {"username": "SomeUser"
},
"inventory": [{"good": "METALS",
"quantity": 10
}
],
"consumes": ["string"
],
"produces": ["string"
]
}
]
}

Get User's Structure Info

Authorizations:

bearerAuth

path Parameters

structureId

required

string

Example: ckno69qb105191ds69utcsztz

Responses

Response samples

200

Content type

application/json

{"structure": {"id": "ckno69qb105191ds69utcsztz",
"type": "MINE",
"location": "OE-UC-AD",
"status": "Production running. Required inventory is in stock.",
"active": true,
"ownedBy": {"username": "SomeUser"
},
"inventory": [{"good": "METALS",
"quantity": 10
}
],
"consumes": ["string"
],
"produces": ["string"
]
}
}

Deposit Structure Inventory

Authorizations:

bearerAuth

path Parameters

structureId

required

string

Example: ckno69qb105191ds69utcsztz

Request Body schema: application/json

shipId required	string
good required	string
quantity required	number

Responses

Request samples

Payload

Content type

application/json

{"shipId": "ckno69qb105191ds69utcsztz",
"good": "METAL",
"quantity": 40
}

Response samples

200

Content type

application/json

{"transfer": {"good": "METALS",
"quantity": 10
},
"ship": {"cargo": [{"good": "METALS",
"quantity": 10
}
]
},
"structure": {"inventory": [{"good": "METALS",
"quantity": 10
}
]
}
}

Transfer Structure Inventory

Authorizations:

bearerAuth

path Parameters

structureId

required

string

Example: ckno69qb105191ds69utcsztz

Request Body schema: application/json

shipId required	string
good required	string
quantity required	number

Responses

Request samples

Payload

Content type

application/json

{"shipId": "ckno69qb105191ds69utcsztz",
"good": "METAL",
"quantity": 40
}

Response samples

200

Content type

application/json

{"transfer": {"good": "METALS",
"quantity": 10
},
"ship": {"cargo": [{"good": "METALS",
"quantity": 10
}
]
},
"structure": {"inventory": [{"good": "METALS",
"quantity": 10
}
]
}
}

List Game Structures

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"structures": [{"allowedLocationTypes": ["PLANET"
],
"consumes": ["string"
],
"produces": ["string"
],
"type": "FARM",
"price": 500000,
"name": "Farm"
}
]
}

List Structures

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"structures": [{"allowedLocationTypes": ["PLANET"
],
"consumes": ["string"
],
"produces": ["string"
],
"type": "FARM",
"price": 500000,
"name": "Farm"
}
]
}

systems

List Game Systems

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"systems": [{"symbol": "OE",
"name": "Omicron Eridani",
"locations": [{"symbol": "OE-A1",
"type": "PLANET",
"name": "Alpha",
"x": 3,
"y": 7,
"allowsConstruction": true,
"ships": [{"shipId": "ckno9324k0079iiop71j5nrob",
"username": "SomeUser",
"shipType": "JW-MK-I"
}
],
"structures": [{"id": "ckno69qb105191ds69utcsztz",
"type": "MINE",
"location": "OE-UC-AD",
"status": "Production running. Required inventory is in stock.",
"active": true,
"ownedBy": {"username": "SomeUser"
},
"inventory": [{"good": "METALS",
"quantity": 10
}
],
"consumes": ["string"
],
"produces": ["string"
]
}
]
}
]
}
]
}

List System Locations

Authorizations:

bearerAuth

path Parameters

symbol

required

string

Example: OE

query Parameters

type	string Example: type=MOON Filter locations fetched on location type
allowsConstruction	boolean Example: allowsConstruction=true

Responses

Response samples

200

Content type

application/json

{"locations": [{"symbol": "OE-A1",
"type": "PLANET",
"name": "Alpha",
"x": 3,
"y": 7,
"allowsConstruction": true,
"ships": [{"shipId": "ckno9324k0079iiop71j5nrob",
"username": "SomeUser",
"shipType": "JW-MK-I"
}
],
"structures": [{"id": "ckno69qb105191ds69utcsztz",
"type": "MINE",
"location": "OE-UC-AD",
"status": "Production running. Required inventory is in stock.",
"active": true,
"ownedBy": {"username": "SomeUser"
},
"inventory": [{"good": "METALS",
"quantity": 10
}
],
"consumes": ["string"
],
"produces": ["string"
]
}
]
}
]
}

List Flight Plans

Authorizations:

bearerAuth

path Parameters

symbol

required

string

Example: OE

Responses

Response samples

200

Content type

application/json

{"flightPlans": [{"arrivesAt": "2021-03-28T23:11:50.068Z",
"createdAt": "2021-03-28T23:05:50.068Z",
"departure": "OE-PM-TR",
"destination": "OE-CR",
"id": "ckmtrssae0402zgopsy39y9z7",
"shipId": "ckmtrlqpz0109zgopkeqs4m5s",
"username": "SomeUser"
}
]
}

List System Ships

Authorizations:

bearerAuth

path Parameters

symbol

required

string

Example: OE

Responses

Response samples

200

Content type

application/json

{"ships": [{"shipId": "ckno9324k0079iiop71j5nrob",
"username": "SomeUser",
"shipType": "JW-MK-I"
}
]
}

List System Ship Listings

Authorizations:

bearerAuth

path Parameters

symbol

required

string

Example: OE

Responses

Response samples

200

Content type

application/json

{"shipListings": [{"class": "string",
"manufacturer": "Jackshaw",
"maxCargo": 50,
"plating": 5,
"type": "JW-MK-I",
"weapons": 5,
"purchaseLocations": [{"system": "OE",
"location": "OE-A1",
"price": 16000
}
]
}
]
}

my

users

Claim Username and Get Token

Authorizations:

bearerAuth

path Parameters

username

required

string

Example: MyUser

Responses

Response samples

200

Content type

application/json

{"token": "096643df-72cc-40b5-95d3-514f47d3f9d9",
"user": {"username": "MyUser",
"credits": 421337,
"shipCount": 10,
"structureCount": 1
}
}

Get My Account

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"user": {"username": "MyUser",
"credits": 421337,
"shipCount": 10,
"structureCount": 1
}
}

types

List Game Structures

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"structures": [{"allowedLocationTypes": ["PLANET"
],
"consumes": ["string"
],
"produces": ["string"
],
"type": "FARM",
"price": 500000,
"name": "Farm"
}
]
}

List Game Loans

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"loans": [{"amount": 200000,
"collateralRequired": false,
"rate": 40,
"termInDays": 2,
"type": "STARTUP"
}
]
}

List Game Ship Types

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"ships": [{"class": "string",
"manufacturer": "Jackshaw",
"maxCargo": 50,
"plating": 5,
"type": "JW-MK-I",
"weapons": 5,
"speed": 3,
"restrictedGoods": ["string"
]
}
]
}

List Good Types

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"goods": [{"name": "Fuel",
"symbol": "FUEL",
"volumePerUnit": 1
}
]
}