spacetraders/api-docs
1
0
Fork 0
mirror of https://github.com/SpaceTradersAPI/api-docs.git synced 2024-11-15 06:40:51 +01:00
Code Issues Packages Projects Releases Wiki Activity
e5fe235fa6
api-docs/reference/SpaceTraders.yaml

1355 lines
47 KiB
YAML
Raw Normal View History

initial commit
2022-03-10 04:16:02 +01:00
openapi: 3.1.0
info:
Modified 2 files
2022-03-10 04:38:36 +01:00
title: SpaceTraders API
Modified 2 files
2022-03-11 01:36:27 +01:00
version: 2.0.0-alpha
summary: SpaceTraders is a unique multiplayer game built on a free Web API.
initial commit
2022-03-10 04:16:02 +01:00
contact:
name: Joel Brubaker
email: joel@spacetraders.io
license:
Modified 2 files
2022-03-11 02:33:09 +01:00
identifier: 'https://choosealicense.com/no-permission/'
Modified 2 files
2022-03-11 01:36:27 +01:00
name: 'No'
Modified reference/SpaceTraders.yaml
2022-03-10 04:37:49 +01:00
description: |-
Modified 2 files
2022-03-11 01:36:27 +01:00
SpaceTraders is a unique multiplayer game built on a free Web API. You control a fleets of ships that can explore the universe, mine asteroids, automate trade routes, meet new factions, and discover hidden technology.
Modified reference/SpaceTraders.yaml
2022-03-10 04:37:49 +01:00
Modified 2 files
2022-03-11 01:36:27 +01:00
Participate in one of our regular competitive seasons or build a client to share with the community.
SpaceTraders is currently in an alpha stage of development. Join our Discord to learn more.
```json http
{
"method": "GET",
"url": "https://v2-0-0.alpha.spacetraders.io/status",
}
```
initial commit
2022-03-10 04:16:02 +01:00
servers:
Modified 2 files
2022-03-11 01:36:27 +01:00
- url: 'https://v2-0-0.alpha.spacetraders.io'
initial commit
2022-03-10 04:16:02 +01:00
description: v2.0.0-alpha
paths:
/agents:
post:
Modified 2 files
2022-03-11 02:33:09 +01:00
summary: Register a new agent
tags:
- agents
initial commit
2022-03-10 04:16:02 +01:00
responses:
'201':
Modified 2 files
2022-03-11 02:33:09 +01:00
description: OK
initial commit
2022-03-10 04:16:02 +01:00
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
token:
type: string
agent:
$ref: ../models/Agent.yaml
faction:
$ref: ../models/Faction.yaml
contract:
$ref: ../models/Contract.yaml
ship:
$ref: ../models/Ship.yaml
examples:
Success:
value:
data:
token: string
agent:
accountId: cl0hok34m0003ks0jjql5q8f2
symbol: EMBER
headquarters: X1-OE-PM
credits: 0
faction:
symbol: COMMERCE_REPUBLIC
name: Commerce Repubic
description: The Commerce Republic takes capital from top tier worlds and invests it into new systems with high potential for growth.
headquarters: X1-OE-PM
traits:
- BUREAUCRATIC
- CAPITALISTIC
- GUILD
- ESTABLISHED
contract:
id: cl0hok38t0014ks0jnoy8o5vh
faction: COMMERCE_REPUBLIC
type: PROCUREMENT
terms:
deadline: '2022-03-11T05:16:59.113Z'
payment:
onAccepted: 20000
onFulfilled: 100000
deliver:
- tradeSymbol: IRON_ORE
destination: X1-OE-PM
units: 10000
fulfilled: 0
accepted: false
fulfilled: false
expiresAt: '2022-03-09T05:16:59.112Z'
ship:
symbol: string
frame: string
reactor: string
engine: string
modules:
- string
mounts:
- string
registration:
factionSymbol: string
agentSymbol: string
fee: 0
role: string
integrity:
frame: 0
reactor: 0
engine: 0
status: string
location: string
cargo:
- tradeSymbol: string
units: 0
operationId: post-agents
Modified 2 files
2022-03-11 02:33:09 +01:00
description: |-
Creates a new agent and ties it to a temporary Account. Use `COMMERCE_REPUBLIC` as your starting faction if you don't know any other factions to choose from.
The agent symbol is a 4-8 character string that will represent your agent. This symbol will prefix the symbol of every ship you own. Agent symbols will be cast to all uppercase characters.
A new agent will be granted an authorization token, a contract with their starting faction, a command ship with a jump drive, and one hundred thousand credits.
> #### Keep your token safe and secure
>
> Save your token during the alpha phase. There is no way to regenerate this token without starting a new agent. In the future you will be able to generate and manage your tokens from the SpaceTraders website.
You can accept your contract using the `/my/contracts/{contractId}/accept` endpoint. You will want to navigate your command ship to a nearby asteroid field waypoint, and execute the `/my/ships/{shipSymbol}/accept` endpoint to mine various types of ores and minerals.
Return to the contract destination and execute the `/my/ships/{shipSymbol}/deliver` endpoint to deposit goods into the contract.
When your contract is fulfilled, you can call `/my/contracts/{contractId}/fulfill` to retrieve payment.
initial commit
2022-03-10 04:16:02 +01:00
requestBody:
content:
application/json:
schema:
type: object
properties:
symbol:
type: string
Modified 2 files
2022-03-11 02:33:09 +01:00
description: How other agents will see your ships and information.
minLength: 4
maxLength: 8
example: BADGER
initial commit
2022-03-10 04:16:02 +01:00
faction:
type: string
Modified 2 files
2022-03-11 02:33:09 +01:00
default: COMMERCE_REPUBLIC
description: The faction you choose determines your headquarters.
description: ''
initial commit
2022-03-10 04:16:02 +01:00
/my/agent:
get:
summary: Get your agent details
Modified 2 files
2022-03-11 02:33:09 +01:00
tags:
- agents
- my
initial commit
2022-03-10 04:16:02 +01:00
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
$ref: ../models/Agent.yaml
examples:
Agent:
value:
data:
accountId: cl0hok34m0003ks0jjql5q8f2
symbol: EMBER
headquarters: X1-OE-PM
credits: 0
operationId: get-my-agent
Modified 2 files
2022-03-11 01:36:27 +01:00
security:
Modified 2 files
2022-03-11 02:33:09 +01:00
- AgentToken: []
description: Fetch your agent's details.
initial commit
2022-03-10 04:16:02 +01:00
'/my/ships/{shipSymbol}/chart':
post:
summary: Submit a system or waypoint chart
Modified 2 files
2022-03-11 02:33:09 +01:00
tags:
- my
- ships
- chart
initial commit
2022-03-10 04:16:02 +01:00
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
submitted:
type: array
items:
type: string
examples:
Success:
value:
data:
submitted:
- X1-ZZ
- X1-ZZ-7-EE
operationId: 'post-my-ships-:shipSymbol-chart'
description: Chart a new system or waypoint.
Modified 2 files
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
initial commit
2022-03-10 04:16:02 +01:00
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
description: The symbol of the ship
'/my/ships/{shipSymbol}/deliver':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
description: The symbol of the ship
post:
summary: Deliver goods on a contract
Modified 2 files
2022-03-11 02:33:09 +01:00
tags:
- contracts
- my
- ships
- deliver
initial commit
2022-03-10 04:16:02 +01:00
responses:
'201':
description: Created
content:
application/json:
schema:
description: ''
type: object
x-examples:
example-1:
data:
tradeSymbol: IRON_ORE
destination: X1-OE-PM
units: 10000
fulfilled: -30000
properties:
data:
$ref: ../models/ContractDelivery.yaml
required:
- data
operationId: post-my-ships-shipSymbol-deliver
Modified 2 files
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
initial commit
2022-03-10 04:16:02 +01:00
'/my/ships/{shipSymbol}/dock':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
description: The symbol of the ship
post:
summary: Dock your ship
Modified 2 files
2022-03-11 02:33:09 +01:00
tags:
- my
- ships
- dock
initial commit
2022-03-10 04:16:02 +01:00
responses:
'201':
description: Created
content:
application/json:
schema:
description: ''
type: object
properties:
data:
type: object
properties:
status:
type: string
required:
- status
required:
- data
x-examples:
example-1:
data:
status: DOCKED
examples:
Success:
value:
data:
status: DOCKED
operationId: post-my-ships-shipSymbol-dock
Modified 2 files
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
initial commit
2022-03-10 04:16:02 +01:00
'/my/ships/{shipSymbol}/orbit':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
description: The symbol of the ship
post:
summary: Transition your ship into orbit
Modified 2 files
2022-03-11 02:33:09 +01:00
tags:
- my
- ships
- orbit
initial commit
2022-03-10 04:16:02 +01:00
responses:
'201':
description: Created
content:
application/json:
schema:
description: ''
type: object
x-examples:
example-1:
data:
status: ORBIT
properties:
data:
type: object
properties:
status:
type: string
required:
- data
examples:
Success:
value:
data:
status: ORBIT
operationId: post-my-ships-shipSymbol-orbit
Modified 2 files
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
description: Transition your ship from docked into orbit. Ships are placed into orbit by default when arriving at a destination. Consecutive calls to this endpoint will continue to return a 200 response status.
initial commit
2022-03-10 04:16:02 +01:00
'/my/ships/{shipSymbol}/jettison':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
post:
summary: Jettison cargo from your ship
Modified 2 files
2022-03-11 02:33:09 +01:00
tags:
- my
- ships
- jettison
initial commit
2022-03-10 04:16:02 +01:00
responses:
'201':
description: Created
content:
application/json:
schema:
description: ''
type: object
properties:
data:
type: object
properties:
tradeSymbol:
type: string
minLength: 1
units:
type: number
required:
- tradeSymbol
- units
required:
- data
x-examples:
example-1:
data:
tradeSymbol: ALUMINUM
units: 95
examples:
Success:
value:
data:
tradeSymbol: ALUMINUM
units: 95
operationId: post-my-ships-shipSymbol-jettison
description: Jettison cargo from your ship's cargo hold.
Modified 2 files
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
initial commit
2022-03-10 04:16:02 +01:00
'/my/ships/{shipSymbol}/extract':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
Modified 2 files
2022-03-11 02:33:09 +01:00
description: The ship symbol
initial commit
2022-03-10 04:16:02 +01:00
post:
summary: Extract resources from a waypoint
Modified 2 files
2022-03-11 02:33:09 +01:00
tags:
- extract
- mining
- my
- ships
- survey
initial commit
2022-03-10 04:16:02 +01:00
responses:
'201':
description: Created
content:
application/json:
schema:
description: ''
type: object
properties:
data:
type: object
properties:
shipSymbol:
type: string
minLength: 1
cooldown:
type: number
yield:
type: object
properties:
tradeSymbol:
type: string
minLength: 1
units:
type: number
required:
- tradeSymbol
- units
required:
- shipSymbol
- cooldown
- yield
required:
- data
x-examples:
example-1:
data:
shipSymbol: 054A8F-1
cooldown: 30
yield:
tradeSymbol: SILICON
units: 14
examples:
Success:
value:
data:
shipSymbol: 054A8F-1
cooldown: 30
yield:
tradeSymbol: IRON_ORE
units: 14
operationId: post-my-ships-shipSymbol-extract
requestBody:
content:
application/json:
schema:
type: object
properties:
survey:
$ref: ../models/Survey.yaml
description: Extract resources from the waypoint into your ship. Send a survey as the payload to target specific yields.
Modified 2 files
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
initial commit
2022-03-10 04:16:02 +01:00
'/my/ships/{shipSymbol}/jump':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
post:
summary: Jump to a new system
Modified 2 files
2022-03-11 02:33:09 +01:00
tags:
- jump
- my
- ships
- navigation
initial commit
2022-03-10 04:16:02 +01:00
responses:
'201':
description: Created
content:
application/json:
schema:
description: ''
type: object
properties:
data:
type: object
properties:
shipSymbol:
type: string
minLength: 1
destination:
type: string
minLength: 1
cooldown:
type: number
required:
- shipSymbol
- destination
- cooldown
required:
- data
x-examples:
example-1:
data:
shipSymbol: CE392B-1
destination: 0b1802ba-da4d-4308-aefb-1e5065f98a53
cooldown: 43200
examples:
Success:
value:
data:
shipSymbol: CE392B-1
destination: 0b1802ba-da4d-4308-aefb-1e5065f98a53
cooldown: 43200
operationId: post-my-ships-shipSymbol-jump
Modified 2 files
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
initial commit
2022-03-10 04:16:02 +01:00
'/my/ships/{shipSymbol}/purchase':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
post:
summary: Purchase cargo for your ship
Modified 2 files
2022-03-11 02:33:09 +01:00
tags:
- markets
- my
- purchase
- ships
- trade
initial commit
2022-03-10 04:16:02 +01:00
responses:
'201':
description: Created
content:
application/json:
schema:
description: ''
type: object
properties:
data:
type: object
properties:
waypointSymbol:
type: string
minLength: 1
tradeSymbol:
type: string
minLength: 1
credits:
type: number
units:
type: number
required:
- waypointSymbol
- tradeSymbol
- credits
- units
required:
- data
x-examples:
example-1:
data:
waypointSymbol: X1-OE-PM
tradeSymbol: MICROPROCESSORS
credits: -843
units: 1
examples:
Success:
value:
data:
waypointSymbol: X1-OE-PM
tradeSymbol: MICROPROCESSORS
credits: -843
units: 1
operationId: post-my-ships-shipSymbol-purchase
Modified 2 files
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
initial commit
2022-03-10 04:16:02 +01:00
'/my/ships/{shipSymbol}/refuel':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
post:
summary: Refuel your ship
Modified 2 files
2022-03-11 02:33:09 +01:00
tags:
- my
- ships
- refuel
initial commit
2022-03-10 04:16:02 +01:00
responses:
'201':
description: Created
content:
application/json:
schema:
description: ''
type: object
properties:
data:
type: object
properties:
credits:
type: number
fuel:
type: number
required:
- credits
- fuel
required:
- data
x-examples:
example-1:
data:
credits: 0
fuel: 0
examples:
Success:
value:
data:
credits: -1920
fuel: 800
operationId: post-my-ships-shipSymbol-refuel
Modified 2 files
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
initial commit
2022-03-10 04:16:02 +01:00
'/my/ships/{shipSymbol}/scan':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
post:
summary: Scan approaching or departing ships from your location
Modified 2 files
2022-03-11 02:33:09 +01:00
tags:
- my
- ships
- scan
initial commit
2022-03-10 04:16:02 +01:00
responses:
'201':
description: Created
content:
application/json:
schema:
description: ''
type: object
properties:
data:
type: object
properties:
ships:
type: array
uniqueItems: true
minItems: 1
items:
required:
- symbol
- frameSymbol
- reactorSymbol
- engineSymbol
- expiration
properties:
symbol:
type: string
minLength: 1
registration:
type: object
properties:
factionSymbol:
type: string
minLength: 1
role:
type: string
minLength: 1
required:
- factionSymbol
- role
frameSymbol:
type: string
minLength: 1
reactorSymbol:
type: string
minLength: 1
engineSymbol:
type: string
minLength: 1
expiration:
type: string
minLength: 1
cooldown:
type: number
required:
- ships
- cooldown
required:
- data
x-examples:
example-1:
data:
ships:
- symbol: COMMERCE_REPUBLIC-0060A0
registration:
factionSymbol: COMMERCE_REPUBLIC
role: EXCAVATOR
frameSymbol: FRAME_HEAVY_FREIGHTER
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I
expiration: '2022-03-08T05:20:14.725Z'
- symbol: ZANZIBAR_TRIKES-DF0AAF
registration:
factionSymbol: ZANZIBAR_TRIKES
role: HAULER
frameSymbol: FRAME_SHUTTLE
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II
expiration: '2022-03-08T05:20:00.725Z'
- symbol: ZANZIBAR_TRIKES-9B80BE
registration:
factionSymbol: ZANZIBAR_TRIKES
role: TRANSPORT
frameSymbol: FRAME_TRANSPORT
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I
expiration: '2022-03-08T05:20:06.725Z'
- symbol: COMMERCE_REPUBLIC-117520
registration:
factionSymbol: COMMERCE_REPUBLIC
role: HARVESTER
frameSymbol: FRAME_SHUTTLE
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II
expiration: '2022-03-08T05:19:55.725Z'
- symbol: SPACERS_GUILD-609AA5
registration:
factionSymbol: SPACERS_GUILD
role: HAULER
frameSymbol: FRAME_FRIGATE
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I
expiration: '2022-03-08T05:19:38.725Z'
- symbol: MINERS_COLLECTIVE-7AD322
registration:
factionSymbol: MINERS_COLLECTIVE
role: EXCAVATOR
frameSymbol: FRAME_SHUTTLE
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I
expiration: '2022-03-08T05:19:11.725Z'
- symbol: ZANZIBAR_TRIKES-AE6D78
registration:
factionSymbol: ZANZIBAR_TRIKES
role: HAULER
frameSymbol: FRAME_SHUTTLE
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II
expiration: '2022-03-08T05:20:44.725Z'
- symbol: SPACERS_GUILD-92828B
registration:
factionSymbol: SPACERS_GUILD
role: SURVEYOR
frameSymbol: FRAME_LIGHT_FREIGHTER
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II
expiration: '2022-03-08T05:20:49.726Z'
- symbol: ZANZIBAR_TRIKES-B5EAD1
registration:
factionSymbol: ZANZIBAR_TRIKES
role: TRANSPORT
frameSymbol: FRAME_TRANSPORT
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I
expiration: '2022-03-08T05:20:25.726Z'
- symbol: ZANZIBAR_TRIKES-6A4E0D
registration:
factionSymbol: ZANZIBAR_TRIKES
role: HAULER
frameSymbol: FRAME_EXPLORER
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II
expiration: '2022-03-08T05:19:19.726Z'
cooldown: 60
examples:
Success:
value:
data:
ships:
- symbol: COMMERCE_REPUBLIC-0060A0
registration:
factionSymbol: COMMERCE_REPUBLIC
role: EXCAVATOR
frameSymbol: FRAME_HEAVY_FREIGHTER
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I
expiration: '2022-03-08T05:20:14.725Z'
- symbol: ZANZIBAR_TRIKES-DF0AAF
registration:
factionSymbol: ZANZIBAR_TRIKES
role: HAULER
frameSymbol: FRAME_SHUTTLE
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II
expiration: '2022-03-08T05:20:00.725Z'
- symbol: ZANZIBAR_TRIKES-9B80BE
registration:
factionSymbol: ZANZIBAR_TRIKES
role: TRANSPORT
frameSymbol: FRAME_TRANSPORT
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I
expiration: '2022-03-08T05:20:06.725Z'
- symbol: COMMERCE_REPUBLIC-117520
registration:
factionSymbol: COMMERCE_REPUBLIC
role: HARVESTER
frameSymbol: FRAME_SHUTTLE
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II
expiration: '2022-03-08T05:19:55.725Z'
- symbol: SPACERS_GUILD-609AA5
registration:
factionSymbol: SPACERS_GUILD
role: HAULER
frameSymbol: FRAME_FRIGATE
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I
expiration: '2022-03-08T05:19:38.725Z'
- symbol: MINERS_COLLECTIVE-7AD322
registration:
factionSymbol: MINERS_COLLECTIVE
role: EXCAVATOR
frameSymbol: FRAME_SHUTTLE
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I
expiration: '2022-03-08T05:19:11.725Z'
- symbol: ZANZIBAR_TRIKES-AE6D78
registration:
factionSymbol: ZANZIBAR_TRIKES
role: HAULER
frameSymbol: FRAME_SHUTTLE
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II
expiration: '2022-03-08T05:20:44.725Z'
- symbol: SPACERS_GUILD-92828B
registration:
factionSymbol: SPACERS_GUILD
role: SURVEYOR
frameSymbol: FRAME_LIGHT_FREIGHTER
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II
expiration: '2022-03-08T05:20:49.726Z'
- symbol: ZANZIBAR_TRIKES-B5EAD1
registration:
factionSymbol: ZANZIBAR_TRIKES
role: TRANSPORT
frameSymbol: FRAME_TRANSPORT
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I
expiration: '2022-03-08T05:20:25.726Z'
- symbol: ZANZIBAR_TRIKES-6A4E0D
registration:
factionSymbol: ZANZIBAR_TRIKES
role: HAULER
frameSymbol: FRAME_EXPLORER
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II
expiration: '2022-03-08T05:19:19.726Z'
cooldown: 60
operationId: post-my-ships-shipSymbol-scan
Modified 2 files
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
initial commit
2022-03-10 04:16:02 +01:00
description: Scan approaching or departing ships.
requestBody:
content:
application/json:
schema:
type: object
properties:
mode:
type: string
required:
- mode
examples:
Approaching Ships:
value:
mode: APPROACHING_SHIPS
Departing Ships:
value:
mode: APPROACHING_SHIPS
description: ''
'/my/ships/{shipSymbol}/sell':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
post:
summary: Sell cargo from your ship
Modified 2 files
2022-03-11 02:33:09 +01:00
tags:
- markets
- my
- sell
- ships
- trade
initial commit
2022-03-10 04:16:02 +01:00
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
properties:
data:
type: object
properties:
waypointSymbol:
type: string
minLength: 1
tradeSymbol:
type: string
minLength: 1
credits:
type: number
units:
type: number
required:
- waypointSymbol
- tradeSymbol
- credits
- units
required:
- data
x-examples:
example-1:
data:
waypointSymbol: X1-OE-PM
tradeSymbol: SILICON
credits: 144
units: -1
examples:
Success:
value:
data:
waypointSymbol: X1-OE-PM
tradeSymbol: SILICON
credits: 144
units: -1
operationId: post-my-ships-shipSymbol-sell
description: Sell cargo from your ship's hold to the local market.
Modified 2 files
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
initial commit
2022-03-10 04:16:02 +01:00
'/my/ships/{shipSymbol}':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
get:
summary: View the details of your ship
Modified 2 files
2022-03-11 02:33:09 +01:00
tags:
- my
- ships
initial commit
2022-03-10 04:16:02 +01:00
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
x-examples:
example-1:
data:
symbol: 653298-1
crew: null
officers: null
frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION
modules:
- MODULE_CARGO_HOLD
mounts:
- MOUNT_MINING_LASER_I
registration:
factionSymbol: COMMERCE_REPUBLIC
agentSymbol: '653298'
fee: 100
role: EXCAVATOR
integrity:
frame: 1
reactor: 1
engine: 1
status: DOCKED
location: X1-OE-PM
cargo: []
properties:
data:
$ref: ../models/Ship.yaml
required:
- data
operationId: get-my-ships-shipSymbol
description: Retrieve the details of your ship.
Modified 2 files
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
initial commit
2022-03-10 04:16:02 +01:00
/my/ships:
get:
summary: View a list of all your ships
Modified 2 files
2022-03-11 02:33:09 +01:00
tags:
- my
- ships
initial commit
2022-03-10 04:16:02 +01:00
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
x-examples:
example-1:
data:
- symbol: 653298-1
crew: null
officers: null
frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION
modules:
- MODULE_CARGO_HOLD
mounts:
- MOUNT_MINING_LASER_I
registration:
factionSymbol: COMMERCE_REPUBLIC
agentSymbol: '653298'
fee: 100
role: EXCAVATOR
integrity:
frame: 1
reactor: 1
engine: 1
status: DOCKED
location: X1-OE-PM
cargo: []
- symbol: 653298-2
crew: null
officers: null
frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION
modules:
- MODULE_CARGO_HOLD
mounts:
- MOUNT_MINING_LASER_I
registration:
factionSymbol: COMMERCE_REPUBLIC
agentSymbol: '653298'
fee: 100
role: EXCAVATOR
integrity:
frame: 1
reactor: 1
engine: 1
status: DOCKED
location: X1-OE-PM
cargo: []
- symbol: 653298-3
crew: null
officers: null
frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION
modules:
- MODULE_CARGO_HOLD
mounts:
- MOUNT_MINING_LASER_I
registration:
factionSymbol: COMMERCE_REPUBLIC
agentSymbol: '653298'
fee: 100
role: EXCAVATOR
integrity:
frame: 1
reactor: 1
engine: 1
status: DOCKED
location: X1-OE-PM
cargo: []
- symbol: 653298-4
crew: null
officers: null
frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION
modules:
- MODULE_CARGO_HOLD
mounts:
- MOUNT_MINING_LASER_I
registration:
factionSymbol: COMMERCE_REPUBLIC
agentSymbol: '653298'
fee: 100
role: EXCAVATOR
integrity:
frame: 1
reactor: 1
engine: 1
status: DOCKED
location: X1-OE-PM
cargo: []
- symbol: 653298-5
crew: null
officers: null
frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION
modules:
- MODULE_CARGO_HOLD
mounts:
- MOUNT_MINING_LASER_I
registration:
factionSymbol: COMMERCE_REPUBLIC
agentSymbol: '653298'
fee: 100
role: EXCAVATOR
integrity:
frame: 1
reactor: 1
engine: 1
status: DOCKED
location: X1-OE-PM
cargo: []
- symbol: 653298-6
crew: null
officers: null
frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION
modules:
- MODULE_CARGO_HOLD
mounts:
- MOUNT_MINING_LASER_I
registration:
factionSymbol: COMMERCE_REPUBLIC
agentSymbol: '653298'
fee: 100
role: EXCAVATOR
integrity:
frame: 1
reactor: 1
engine: 1
status: DOCKED
location: X1-OE-PM
cargo: []
meta:
total: 6
page: 1
limit: 20
properties:
data:
type: array
uniqueItems: true
minItems: 1
items:
$ref: ../models/Ship.yaml
meta:
$ref: ../models/Meta.yaml
required:
- data
- meta
examples:
Success:
value:
data:
- symbol: 653298-1
crew: null
officers: null
frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION
modules:
- MODULE_CARGO_HOLD
mounts:
- MOUNT_MINING_LASER_I
registration:
factionSymbol: COMMERCE_REPUBLIC
agentSymbol: '653298'
fee: 100
role: EXCAVATOR
integrity:
frame: 1
reactor: 1
engine: 1
status: DOCKED
location: X1-OE-PM
cargo: []
- symbol: 653298-2
crew: null
officers: null
frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION
modules:
- MODULE_CARGO_HOLD
mounts:
- MOUNT_MINING_LASER_I
registration:
factionSymbol: COMMERCE_REPUBLIC
agentSymbol: '653298'
fee: 100
role: EXCAVATOR
integrity:
frame: 1
reactor: 1
engine: 1
status: DOCKED
location: X1-OE-PM
cargo: []
- symbol: 653298-3
crew: null
officers: null
frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION
modules:
- MODULE_CARGO_HOLD
mounts:
- MOUNT_MINING_LASER_I
registration:
factionSymbol: COMMERCE_REPUBLIC
agentSymbol: '653298'
fee: 100
role: EXCAVATOR
integrity:
frame: 1
reactor: 1
engine: 1
status: DOCKED
location: X1-OE-PM
cargo: []
- symbol: 653298-4
crew: null
officers: null
frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION
modules:
- MODULE_CARGO_HOLD
mounts:
- MOUNT_MINING_LASER_I
registration:
factionSymbol: COMMERCE_REPUBLIC
agentSymbol: '653298'
fee: 100
role: EXCAVATOR
integrity:
frame: 1
reactor: 1
engine: 1
status: DOCKED
location: X1-OE-PM
cargo: []
- symbol: 653298-5
crew: null
officers: null
frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION
modules:
- MODULE_CARGO_HOLD
mounts:
- MOUNT_MINING_LASER_I
registration:
factionSymbol: COMMERCE_REPUBLIC
agentSymbol: '653298'
fee: 100
role: EXCAVATOR
integrity:
frame: 1
reactor: 1
engine: 1
status: DOCKED
location: X1-OE-PM
cargo: []
- symbol: 653298-6
crew: null
officers: null
frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION
modules:
- MODULE_CARGO_HOLD
mounts:
- MOUNT_MINING_LASER_I
registration:
factionSymbol: COMMERCE_REPUBLIC
agentSymbol: '653298'
fee: 100
role: EXCAVATOR
integrity:
frame: 1
reactor: 1
engine: 1
status: DOCKED
location: X1-OE-PM
cargo: []
meta:
total: 6
page: 1
limit: 20
operationId: get-my-ships
description: Retrieve all of your ships.
Modified 2 files
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
tags:
- name: my
- name: ships
- name: markets
- name: trade
- name: sell
- name: purchase
- name: navigation
- name: agents
- name: dock
- name: orbit
- name: jettison
- name: jump
- name: refuel
- name: scan
- name: contracts
- name: chart
- name: extract
- name: mining
- name: deliver
- name: survey
initial commit
2022-03-10 04:16:02 +01:00
components:
schemas: {}
Modified reference/SpaceTraders.yaml
2022-03-10 04:37:49 +01:00
securitySchemes:
Modified 2 files
2022-03-11 02:33:09 +01:00
AgentToken:
Modified reference/SpaceTraders.yaml
2022-03-10 04:37:49 +01:00
type: http
scheme: bearer
Modified 2 files
2022-03-11 01:36:27 +01:00
description: When you register a new agent you will be granted a private bearer token which grants authorization to use the API.
Reference in New Issue Copy Permalink