api-docs/reference/SpaceTraders.yaml

2162 lines
73 KiB
YAML
Raw Normal View History

2022-03-10 04:16:02 +01:00
openapi: 3.1.0
info:
2022-03-10 04:38:36 +01:00
title: SpaceTraders API
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.
2022-03-10 04:16:02 +01:00
contact:
name: Joel Brubaker
email: joel@spacetraders.io
license:
2022-03-11 01:36:27 +01:00
name: 'No'
2022-03-11 02:49:54 +01:00
url: 'https://choosealicense.com/no-permission/'
2022-03-10 04:37:49 +01:00
description: |-
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.
2022-03-10 04:37:49 +01:00
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",
2022-03-11 03:54:21 +01:00
"url": "https://v2-0-0.alpha.spacetraders.io",
2022-03-11 01:36:27 +01:00
}
```
2022-03-10 04:16:02 +01:00
servers:
2022-03-11 01:36:27 +01:00
- url: 'https://v2-0-0.alpha.spacetraders.io'
2022-03-10 04:16:02 +01:00
description: v2.0.0-alpha
paths:
/agents:
post:
2022-03-12 03:18:37 +01:00
summary: Register New Agent
2022-03-11 02:33:09 +01:00
tags:
- agents
2022-03-10 04:16:02 +01:00
responses:
'201':
2022-03-11 02:33:09 +01:00
description: OK
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
2022-03-12 03:10:41 +01:00
fuel: 0
2022-03-10 04:16:02 +01:00
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
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.
2022-03-10 04:16:02 +01:00
requestBody:
content:
application/json:
schema:
type: object
properties:
symbol:
type: string
2022-03-11 02:33:09 +01:00
description: How other agents will see your ships and information.
minLength: 4
maxLength: 8
example: BADGER
2022-03-10 04:16:02 +01:00
faction:
type: string
2022-03-11 02:33:09 +01:00
default: COMMERCE_REPUBLIC
description: The faction you choose determines your headquarters.
description: ''
2022-03-10 04:16:02 +01:00
/my/agent:
get:
2022-03-12 03:18:37 +01:00
summary: My Agent Details
2022-03-11 02:33:09 +01:00
tags:
- agents
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
2022-03-11 01:36:27 +01:00
security:
2022-03-11 02:33:09 +01:00
- AgentToken: []
description: Fetch your agent's details.
2022-03-10 04:16:02 +01:00
'/my/ships/{shipSymbol}/chart':
post:
2022-03-12 03:04:56 +01:00
summary: Chart Waypoint
2022-03-11 02:33:09 +01:00
tags:
2022-03-12 03:04:56 +01:00
- ships
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.
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
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:
2022-03-12 03:04:56 +01:00
summary: Deliver on Contract
2022-03-11 02:33:09 +01:00
tags:
- ships
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
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
2022-03-11 05:37:39 +01:00
requestBody:
content:
application/json:
schema:
type: object
properties:
contractId:
type: string
tradeSymbol:
type: string
units:
type: number
required:
- contractId
- tradeSymbol
2022-03-12 03:10:41 +01:00
description: Deliver cargo on a given contract.
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:
2022-03-12 03:04:56 +01:00
summary: Dock Ship
2022-03-11 02:33:09 +01:00
tags:
- ships
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
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
2022-03-12 03:10:41 +01:00
description: Transition your ship from orbit to docked. Consecutive calls to this endpoint will succeed.
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:
2022-03-12 03:04:56 +01:00
summary: Orbit Ship
2022-03-11 02:33:09 +01:00
tags:
- ships
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
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.
2022-03-10 04:16:02 +01:00
'/my/ships/{shipSymbol}/jettison':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
post:
2022-03-12 03:04:56 +01:00
summary: Jettison Cargo
2022-03-11 02:33:09 +01:00
tags:
- ships
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.
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
2022-03-10 04:16:02 +01:00
'/my/ships/{shipSymbol}/extract':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
2022-03-11 02:33:09 +01:00
description: The ship symbol
2022-03-10 04:16:02 +01:00
post:
2022-03-12 03:17:31 +01:00
summary: Extract Resources
2022-03-11 02:33:09 +01:00
tags:
- ships
2022-03-10 04:16:02 +01:00
responses:
'201':
description: Created
content:
application/json:
schema:
description: ''
type: object
2022-03-12 02:41:45 +01:00
x-examples:
example-1:
data:
extraction:
shipSymbol: 4B902A-1
yield:
tradeSymbol: SILICON
units: 16
cooldown:
duration: 119
expiration: '2022-03-12T00:41:29.371Z'
2022-03-10 04:16:02 +01:00
properties:
data:
type: object
required:
2022-03-12 02:41:45 +01:00
- extraction
2022-03-10 04:16:02 +01:00
- cooldown
2022-03-12 02:41:45 +01:00
properties:
extraction:
$ref: ../models/Extraction.yaml
cooldown:
$ref: ../models/Cooldown.yaml
2022-03-10 04:16:02 +01:00
required:
- data
examples:
Success:
value:
data:
2022-03-12 02:41:45 +01:00
extraction:
shipSymbol: 4B902A-1
yield:
tradeSymbol: SILICON
units: 16
cooldown:
duration: 119
expiration: '2022-03-12T00:41:29.371Z'
2022-03-10 04:16:02 +01:00
operationId: post-my-ships-shipSymbol-extract
requestBody:
content:
application/json:
schema:
2022-03-11 05:08:47 +01:00
type:
- object
- 'null'
2022-03-10 04:16:02 +01:00
properties:
survey:
$ref: ../models/Survey.yaml
2022-03-11 05:08:47 +01:00
examples:
2022-03-12 04:25:14 +01:00
No Survey:
value: {}
2022-03-11 05:08:47 +01:00
With Survey:
value:
survey:
signature: X1-OE-D2DD38
deposits:
- COPPER_ORE
expiration: '2022-03-08T05:41:55.514Z'
description: ''
2022-03-12 04:23:03 +01:00
description: Extract resources from the waypoint into your ship. Send a survey as the payload to target specific yields. The entire survey must be sent as it contains a signature that the backend verifies.
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
2022-03-11 04:03:18 +01:00
get:
2022-03-12 03:04:56 +01:00
summary: Extraction Cooldown
2022-03-11 04:03:18 +01:00
operationId: get-my-ships-shipSymbol-extract
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
2022-03-12 02:41:45 +01:00
x-examples:
example-1:
data:
cooldown:
duration: 119
expiration: '2022-03-12T00:41:29.285Z'
2022-03-11 04:03:18 +01:00
properties:
data:
type: object
required:
- cooldown
2022-03-12 02:41:45 +01:00
properties:
cooldown:
$ref: ../models/Cooldown.yaml
2022-03-11 04:03:18 +01:00
required:
- data
examples:
Success:
value:
data:
2022-03-12 02:41:45 +01:00
cooldown:
duration: 119
expiration: '2022-03-12T00:41:29.285Z'
2022-03-11 04:03:18 +01:00
description: Get the status of your last extraction.
security:
- AgentToken: []
2022-03-12 02:41:45 +01:00
tags:
- ships
2022-03-11 05:08:47 +01:00
'/my/ships/{shipSymbol}/survey':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
post:
2022-03-12 03:04:56 +01:00
summary: Survey Waypoint
2022-03-12 02:44:45 +01:00
tags:
- ships
2022-03-11 05:08:47 +01:00
responses:
'201':
description: Created
content:
application/json:
schema:
description: ''
type: object
x-examples:
example-1:
data:
- signature: X1-OE-D2DD38
deposits:
- COPPER_ORE
expiration: '2022-03-08T05:41:55.514Z'
- signature: X1-OE-B58FEB
deposits:
- ALUMINUM_ORE
- ALUMINUM_ORE
- ALUMINUM_ORE
expiration: '2022-03-08T05:39:15.519Z'
- signature: X1-OE-0E326C
deposits:
- ALUMINUM_ORE
- SILICON
expiration: '2022-03-08T05:20:27.521Z'
- signature: X1-OE-5CDFA4
deposits:
- COPPER_ORE
- COPPER_ORE
- COPPER_ORE
- IRON_ORE
expiration: '2022-03-08T05:44:34.522Z'
- signature: X1-OE-86C3A1
deposits:
- COPPER_ORE
- COPPER_ORE
- IRON_ORE
expiration: '2022-03-08T05:43:45.522Z'
- signature: X1-OE-C97BEA
deposits:
- ALUMINUM_ORE
- COPPER_ORE
- QUARTZ
- QUARTZ
expiration: '2022-03-08T05:22:39.523Z'
- signature: X1-OE-9913BD
deposits:
- QUARTZ
expiration: '2022-03-08T05:37:45.523Z'
- signature: X1-OE-8D87D2
deposits:
- COPPER_ORE
- SILICON
expiration: '2022-03-08T05:32:57.524Z'
properties:
data:
2022-03-12 02:57:49 +01:00
type: object
properties:
surveys:
2022-03-12 03:10:41 +01:00
type: array
items:
$ref: ../models/Survey.yaml
2022-03-12 02:57:49 +01:00
cooldown:
$ref: ../models/Cooldown.yaml
2022-03-11 05:08:47 +01:00
required:
- data
examples:
Success:
value:
data:
2022-03-12 02:57:49 +01:00
cooldown:
duration: 899
expiration: '2022-03-12T02:11:35.618Z'
surveys:
- signature: X1-OE-397C82
deposits:
- SILICON
expiration: '2022-03-12T02:00:19.622Z'
- signature: X1-OE-4413F6
deposits:
- ALUMINUM_ORE
- ALUMINUM_ORE
- COPPER_ORE
- IRON_ORE
expiration: '2022-03-12T02:20:08.625Z'
- signature: X1-OE-E6480F
deposits:
- ALUMINUM_ORE
- IRON_ORE
- QUARTZ
- SILICON
expiration: '2022-03-12T02:18:00.626Z'
- signature: X1-OE-660BE9
deposits:
- ALUMINUM_ORE
expiration: '2022-03-12T02:20:45.626Z'
- signature: X1-OE-D64798
deposits:
- COPPER_ORE
- QUARTZ
- SILICON
expiration: '2022-03-12T02:07:33.626Z'
- signature: X1-OE-F799F3
deposits:
- IRON_ORE
expiration: '2022-03-12T02:23:16.627Z'
2022-03-11 05:08:47 +01:00
operationId: post-my-ships-shipSymbol-survey
security:
- AgentToken: []
2022-03-12 03:24:57 +01:00
description: |-
2022-03-12 04:24:40 +01:00
If you want to target specific yields for an extraction, you can survey a waypoint, such as an asteroid field, and send the survey in the body of the extract request. Each survey may have multiple deposits, and if a symbol shows up more than once, that indicates a higher chance of extracting that resource.
2022-03-12 03:24:57 +01:00
2022-03-12 04:24:40 +01:00
Your ship will enter a cooldown between consecutive survey requests. Surveys will eventually expire after a period of time. Multiple ships can use the same survey for extraction.
2022-03-11 05:08:47 +01:00
get:
2022-03-12 03:04:56 +01:00
summary: Survey Cooldown
2022-03-12 02:41:45 +01:00
tags:
- ships
2022-03-12 02:57:49 +01:00
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
cooldown:
$ref: ../models/Cooldown.yaml
examples:
Success:
value:
data:
cooldown:
duration: 899
expiration: '2022-03-12T02:11:35.618Z'
2022-03-11 05:08:47 +01:00
operationId: get-my-ships-shipSymbol-survey
2022-03-12 03:24:57 +01:00
description: 'Executing a survey will initiate a cooldown for a number of seconds before you can call it again. This endpoint returns the details of your cooldown, or a 404 if there is no cooldown for the survey action.'
2022-03-10 04:16:02 +01:00
'/my/ships/{shipSymbol}/jump':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
post:
2022-03-12 03:04:56 +01:00
summary: Jump Ship
2022-03-11 02:33:09 +01:00
tags:
- ships
2022-03-10 04:16:02 +01:00
responses:
'201':
description: Created
content:
application/json:
schema:
description: ''
type: object
2022-03-12 02:44:45 +01:00
x-examples:
example-1:
data:
jump:
shipSymbol: 1D7FDA-1
destination: 00E0B1
cooldown:
duration: 719
expiration: '2022-03-12T00:52:56.735Z'
2022-03-10 04:16:02 +01:00
properties:
data:
type: object
required:
2022-03-12 02:44:45 +01:00
- jump
2022-03-10 04:16:02 +01:00
- cooldown
2022-03-12 02:44:45 +01:00
properties:
jump:
type: object
required:
- shipSymbol
- destination
properties:
shipSymbol:
type: string
minLength: 1
destination:
type: string
minLength: 1
cooldown:
$ref: ../models/Cooldown.yaml
2022-03-10 04:16:02 +01:00
required:
- data
examples:
Success:
value:
data:
2022-03-12 02:44:45 +01:00
jump:
shipSymbol: 1D7FDA-1
destination: 00E0B1
cooldown:
duration: 719
expiration: '2022-03-12T00:52:56.735Z'
2022-03-10 04:16:02 +01:00
operationId: post-my-ships-shipSymbol-jump
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
2022-03-12 02:44:45 +01:00
get:
2022-03-12 03:04:56 +01:00
summary: Jump Cooldown
2022-03-12 02:44:45 +01:00
operationId: get-my-ships-shipSymbol-jump
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
x-examples:
example-1:
data:
cooldown:
duration: 719
expiration: '2022-03-12T00:52:56.735Z'
properties:
data:
type: object
required:
- cooldown
properties:
cooldown:
$ref: ../models/Cooldown.yaml
required:
- data
security:
- AgentToken: []
tags:
- ships
2022-03-10 04:16:02 +01:00
'/my/ships/{shipSymbol}/purchase':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
post:
2022-03-12 03:04:56 +01:00
summary: Purchase Cargo
2022-03-11 02:33:09 +01:00
tags:
- ships
2022-03-10 04:16:02 +01:00
responses:
'201':
description: Created
content:
application/json:
schema:
description: ''
type: object
x-examples:
example-1:
data:
waypointSymbol: X1-OE-PM
tradeSymbol: MICROPROCESSORS
credits: -843
units: 1
2022-03-12 02:55:54 +01:00
properties:
data:
$ref: ../models/Trade.yaml
required:
- data
2022-03-10 04:16:02 +01:00
examples:
Success:
value:
data:
waypointSymbol: X1-OE-PM
tradeSymbol: MICROPROCESSORS
credits: -843
units: 1
operationId: post-my-ships-shipSymbol-purchase
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
2022-03-12 03:17:31 +01:00
'/my/ships/{shipSymbol}/sell':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
post:
summary: Sell Cargo
tags:
- ships
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
x-examples:
example-1:
data:
waypointSymbol: X1-OE-PM
tradeSymbol: SILICON
credits: 144
units: -1
properties:
data:
$ref: ../models/Trade.yaml
required:
- data
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.
security:
- AgentToken: []
2022-03-10 04:16:02 +01:00
'/my/ships/{shipSymbol}/refuel':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
post:
2022-03-12 03:17:31 +01:00
summary: Refuel Ship
2022-03-11 02:33:09 +01:00
tags:
- ships
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
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
2022-03-10 04:16:02 +01:00
'/my/ships/{shipSymbol}/scan':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
post:
2022-03-12 03:04:56 +01:00
summary: Scan
2022-03-11 02:33:09 +01:00
tags:
- ships
2022-03-10 04:16:02 +01:00
responses:
'201':
description: Created
content:
application/json:
schema:
description: ''
type: object
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
2022-03-12 02:55:54 +01:00
properties:
data:
type: object
required:
- ships
- cooldown
properties:
ships:
type: array
uniqueItems: true
minItems: 1
items:
$ref: ../models/ScannedShip.yaml
cooldown:
$ref: ../models/Cooldown.yaml
required:
- data
2022-03-10 04:16:02 +01:00
examples:
Success:
value:
data:
2022-03-12 03:10:41 +01:00
cooldown:
duration: 59
expiration: '2022-03-12T00:42:44.220Z'
2022-03-10 04:16:02 +01:00
ships:
2022-03-12 03:10:41 +01:00
- symbol: SPACERS_GUILD-65E1BA
2022-03-10 04:16:02 +01:00
registration:
2022-03-12 03:10:41 +01:00
factionSymbol: SPACERS_GUILD
2022-03-10 04:16:02 +01:00
role: EXCAVATOR
2022-03-12 03:10:41 +01:00
frameSymbol: FRAME_LIGHT_FREIGHTER
2022-03-10 04:16:02 +01:00
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I
2022-03-12 03:10:41 +01:00
expiration: '2022-03-12T00:44:14.222Z'
- symbol: MINERS_COLLECTIVE-C6ACCA
2022-03-10 04:16:02 +01:00
registration:
2022-03-12 03:10:41 +01:00
factionSymbol: MINERS_COLLECTIVE
role: HARVESTER
frameSymbol: FRAME_INTERCEPTOR
2022-03-10 04:16:02 +01:00
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I
2022-03-12 03:10:41 +01:00
expiration: '2022-03-12T00:44:38.222Z'
- symbol: COMMERCE_REPUBLIC-866DC7
2022-03-10 04:16:02 +01:00
registration:
factionSymbol: COMMERCE_REPUBLIC
2022-03-12 03:10:41 +01:00
role: SURVEYOR
frameSymbol: FRAME_LIGHT_FREIGHTER
2022-03-10 04:16:02 +01:00
reactorSymbol: REACTOR_FUSION_I
2022-03-12 03:10:41 +01:00
engineSymbol: ENGINE_ION_DRIVE_I
expiration: '2022-03-12T00:45:21.222Z'
- symbol: SPACERS_GUILD-2B1D01
2022-03-10 04:16:02 +01:00
registration:
factionSymbol: SPACERS_GUILD
2022-03-12 03:10:41 +01:00
role: SURVEYOR
frameSymbol: FRAME_HEAVY_FREIGHTER
2022-03-10 04:16:02 +01:00
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I
2022-03-12 03:10:41 +01:00
expiration: '2022-03-12T00:44:53.222Z'
- symbol: MINERS_COLLECTIVE-2F238C
2022-03-10 04:16:02 +01:00
registration:
factionSymbol: MINERS_COLLECTIVE
2022-03-12 03:10:41 +01:00
role: HAULER
2022-03-10 04:16:02 +01:00
frameSymbol: FRAME_SHUTTLE
reactorSymbol: REACTOR_FUSION_I
2022-03-12 03:10:41 +01:00
engineSymbol: ENGINE_ION_DRIVE_II
expiration: '2022-03-12T00:44:07.222Z'
- symbol: ZANZIBAR_TRIKES-ACF237
2022-03-10 04:16:02 +01:00
registration:
factionSymbol: ZANZIBAR_TRIKES
role: HAULER
2022-03-12 03:10:41 +01:00
frameSymbol: FRAME_INTERCEPTOR
2022-03-10 04:16:02 +01:00
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II
2022-03-12 03:10:41 +01:00
expiration: '2022-03-12T00:44:22.223Z'
- symbol: SPACERS_GUILD-94A474
2022-03-10 04:16:02 +01:00
registration:
factionSymbol: SPACERS_GUILD
2022-03-12 03:10:41 +01:00
role: EXCAVATOR
frameSymbol: FRAME_SHUTTLE
2022-03-10 04:16:02 +01:00
reactorSymbol: REACTOR_FUSION_I
2022-03-12 03:10:41 +01:00
engineSymbol: ENGINE_ION_DRIVE_I
expiration: '2022-03-12T00:43:51.223Z'
- symbol: ZANZIBAR_TRIKES-648BA8
2022-03-10 04:16:02 +01:00
registration:
factionSymbol: ZANZIBAR_TRIKES
2022-03-12 03:10:41 +01:00
role: PATROL
frameSymbol: FRAME_SHUTTLE
2022-03-10 04:16:02 +01:00
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_I
2022-03-12 03:10:41 +01:00
expiration: '2022-03-12T00:44:56.223Z'
- symbol: COMMERCE_REPUBLIC-1EED24
2022-03-10 04:16:02 +01:00
registration:
2022-03-12 03:10:41 +01:00
factionSymbol: COMMERCE_REPUBLIC
role: PATROL
2022-03-10 04:16:02 +01:00
frameSymbol: FRAME_EXPLORER
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II
2022-03-12 03:10:41 +01:00
expiration: '2022-03-12T00:45:23.223Z'
- symbol: ZANZIBAR_TRIKES-A5600D
registration:
factionSymbol: ZANZIBAR_TRIKES
role: PATROL
frameSymbol: FRAME_FRIGATE
reactorSymbol: REACTOR_FUSION_I
engineSymbol: ENGINE_ION_DRIVE_II
expiration: '2022-03-12T00:44:00.223Z'
2022-03-10 04:16:02 +01:00
operationId: post-my-ships-shipSymbol-scan
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
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
2022-03-12 02:55:54 +01:00
enum:
- APPROACHING_SHIPS
- DEPARTING_SHIPS
2022-03-10 04:16:02 +01:00
required:
- mode
examples:
Approaching Ships:
value:
mode: APPROACHING_SHIPS
Departing Ships:
value:
mode: APPROACHING_SHIPS
description: ''
2022-03-12 03:17:31 +01:00
get:
summary: Scan Cooldown
operationId: get-my-ships-shipSymbol-scan
2022-03-10 04:16:02 +01:00
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
2022-03-12 02:55:54 +01:00
properties:
data:
2022-03-12 03:17:31 +01:00
type: object
properties:
cooldown:
$ref: ../models/Cooldown.yaml
2022-03-10 04:16:02 +01:00
examples:
Success:
value:
data:
2022-03-12 03:17:31 +01:00
cooldown:
duration: 59
expiration: '2022-03-12T00:42:44.220Z'
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
2022-03-12 03:19:38 +01:00
tags:
- ships
2022-03-11 03:54:21 +01:00
'/my/ships/{shipSymbol}/navigate':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
description: The ship symbol
post:
2022-03-12 03:13:41 +01:00
summary: Navigate Ship
2022-03-12 02:44:45 +01:00
tags:
- ships
2022-03-11 03:54:21 +01:00
responses:
2022-03-11 05:08:47 +01:00
'201':
description: Created
2022-03-11 03:54:21 +01:00
content:
application/json:
schema:
description: ''
type: object
x-examples:
example-1:
data:
shipSymbol: 3AE434-1
departure: X1-OE-PM
destination: X1-OE-A005
durationRemaining: 2159
arrivedAt: null
2022-03-12 04:21:23 +01:00
properties:
data:
type: object
properties:
navigation:
$ref: ../models/ShipNavigation.yaml
fuelCost:
type: number
required:
- data
2022-03-11 03:54:21 +01:00
examples:
Success:
value:
data:
2022-03-12 04:21:23 +01:00
fuelCost: 38
navigation:
shipSymbol: BA03F2-1
departure: X1-OE-PM
destination: X1-OE-A005
durationRemaining: 2279
arrivedAt: null
2022-03-11 03:54:21 +01:00
operationId: post-my-ships-shipSymbol-navigate
requestBody:
content:
application/json:
schema:
type: object
properties:
destination:
type: string
description: The waypoint symbol to navigate to.
get:
2022-03-12 03:13:41 +01:00
summary: Navigation Status
2022-03-11 03:54:21 +01:00
operationId: get-my-ships-shipSymbol-navigate
responses:
'200':
description: OK
content:
application/json:
schema:
2022-03-12 02:55:54 +01:00
description: ''
2022-03-11 03:54:21 +01:00
type: object
2022-03-12 02:55:54 +01:00
x-examples:
example-1:
data:
shipSymbol: 3AE434-1
departure: X1-OE-PM
destination: X1-OE-A005
durationRemaining: 2159
arrivedAt: null
properties:
data:
2022-03-12 04:21:23 +01:00
type: object
properties:
navigation:
$ref: ../models/ShipNavigation.yaml
2022-03-12 02:55:54 +01:00
required:
- data
2022-03-12 04:21:23 +01:00
examples:
Success:
value:
data:
navigation:
shipSymbol: BA03F2-1
departure: X1-OE-PM
destination: X1-OE-A005
durationRemaining: 2279
arrivedAt: null
2022-03-11 03:54:21 +01:00
description: Get the status of your last navigation.
security:
- AgentToken: []
2022-03-12 02:41:45 +01:00
tags:
- ships
2022-03-10 04:16:02 +01:00
'/my/ships/{shipSymbol}':
parameters:
- schema:
type: string
name: shipSymbol
in: path
required: true
get:
2022-03-12 03:04:56 +01:00
summary: View Ship
2022-03-11 02:33:09 +01:00
tags:
- ships
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.
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
2022-03-10 04:16:02 +01:00
/my/ships:
get:
2022-03-12 03:04:56 +01:00
summary: List Ships
2022-03-11 02:33:09 +01:00
tags:
- ships
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:
2022-03-12 03:10:41 +01:00
- symbol: 55B261-1
2022-03-10 04:16:02 +01:00
crew: null
officers: null
2022-03-12 03:10:41 +01:00
fuel: 100
2022-03-10 04:16:02 +01:00
frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION
modules:
- MODULE_CARGO_HOLD
mounts:
- MOUNT_MINING_LASER_I
registration:
factionSymbol: COMMERCE_REPUBLIC
2022-03-12 03:10:41 +01:00
agentSymbol: 55B261
2022-03-10 04:16:02 +01:00
fee: 100
role: EXCAVATOR
integrity:
frame: 1
reactor: 1
engine: 1
status: DOCKED
location: X1-OE-PM
cargo: []
2022-03-12 03:10:41 +01:00
- symbol: 55B261-2
2022-03-10 04:16:02 +01:00
crew: null
officers: null
2022-03-12 03:10:41 +01:00
fuel: 100
2022-03-10 04:16:02 +01:00
frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION
modules:
- MODULE_CARGO_HOLD
mounts:
- MOUNT_MINING_LASER_I
registration:
factionSymbol: COMMERCE_REPUBLIC
2022-03-12 03:10:41 +01:00
agentSymbol: 55B261
2022-03-10 04:16:02 +01:00
fee: 100
role: EXCAVATOR
integrity:
frame: 1
reactor: 1
engine: 1
status: DOCKED
location: X1-OE-PM
cargo: []
2022-03-12 03:10:41 +01:00
- symbol: 55B261-3
2022-03-10 04:16:02 +01:00
crew: null
officers: null
2022-03-12 03:10:41 +01:00
fuel: 100
2022-03-10 04:16:02 +01:00
frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION
modules:
- MODULE_CARGO_HOLD
mounts:
- MOUNT_MINING_LASER_I
registration:
factionSymbol: COMMERCE_REPUBLIC
2022-03-12 03:10:41 +01:00
agentSymbol: 55B261
2022-03-10 04:16:02 +01:00
fee: 100
role: EXCAVATOR
integrity:
frame: 1
reactor: 1
engine: 1
status: DOCKED
location: X1-OE-PM
cargo: []
2022-03-12 03:10:41 +01:00
- symbol: 55B261-4
2022-03-10 04:16:02 +01:00
crew: null
officers: null
2022-03-12 03:10:41 +01:00
fuel: 100
2022-03-10 04:16:02 +01:00
frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION
modules:
- MODULE_CARGO_HOLD
mounts:
- MOUNT_MINING_LASER_I
registration:
factionSymbol: COMMERCE_REPUBLIC
2022-03-12 03:10:41 +01:00
agentSymbol: 55B261
2022-03-10 04:16:02 +01:00
fee: 100
role: EXCAVATOR
integrity:
frame: 1
reactor: 1
engine: 1
status: DOCKED
location: X1-OE-PM
cargo: []
2022-03-12 03:10:41 +01:00
- symbol: 55B261-5
2022-03-10 04:16:02 +01:00
crew: null
officers: null
2022-03-12 03:10:41 +01:00
fuel: 100
2022-03-10 04:16:02 +01:00
frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION
modules:
- MODULE_CARGO_HOLD
mounts:
- MOUNT_MINING_LASER_I
registration:
factionSymbol: COMMERCE_REPUBLIC
2022-03-12 03:10:41 +01:00
agentSymbol: 55B261
2022-03-10 04:16:02 +01:00
fee: 100
role: EXCAVATOR
integrity:
frame: 1
reactor: 1
engine: 1
status: DOCKED
location: X1-OE-PM
cargo: []
2022-03-12 03:10:41 +01:00
- symbol: 55B261-6
2022-03-10 04:16:02 +01:00
crew: null
officers: null
2022-03-12 03:10:41 +01:00
fuel: 100
2022-03-10 04:16:02 +01:00
frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION
modules:
- MODULE_CARGO_HOLD
mounts:
- MOUNT_MINING_LASER_I
registration:
factionSymbol: COMMERCE_REPUBLIC
2022-03-12 03:10:41 +01:00
agentSymbol: 55B261
2022-03-10 04:16:02 +01:00
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.
2022-03-11 02:33:09 +01:00
security:
- AgentToken: []
2022-03-12 04:50:09 +01:00
post:
summary: Purchase Ship
tags:
- shipyards
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
x-examples:
example-1:
data:
symbol: 4F4D44-1
crew: null
officers: null
fuel: 100
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: 4F4D44
fee: 100
role: EXCAVATOR
integrity:
frame: 1
reactor: 1
engine: 1
status: DOCKED
location: X1-OE-PM
cargo: []
properties:
data:
type: object
properties:
ship:
$ref: ../models/Ship.yaml
credits:
type: number
required:
- data
operationId: post-my-ships
security:
- AgentToken: []
description: Purchase a ship
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The id of the shipyard listing you want to purchase.
2022-03-11 05:37:39 +01:00
/my/contracts:
get:
2022-03-12 03:04:56 +01:00
summary: List Contracts
2022-03-11 05:37:39 +01:00
tags:
- contracts
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
x-examples:
example-1:
data:
- 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'
- id: cl0hok3920023kv0jflbjpltg
faction: COMMERCE_REPUBLIC
type: PROCUREMENT
terms:
deadline: '2022-03-11T05:16:59.123Z'
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.122Z'
meta:
total: 2
page: 1
limit: 20
properties:
data:
type: array
uniqueItems: true
minItems: 1
items:
$ref: ../models/Contract.yaml
meta:
$ref: ../models/Meta.yaml
required:
- data
- meta
examples:
Success:
value:
data:
- 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'
meta:
total: 10
page: 1
limit: 10
operationId: get-my-contracts
security:
- AgentToken: []
description: List all of your contracts.
2022-03-11 06:33:11 +01:00
'/my/contracts/{contractId}':
parameters:
- schema:
type: string
name: contractId
in: path
required: true
description: The contract ID
get:
2022-03-12 03:18:37 +01:00
summary: Contract Details
2022-03-11 06:33:11 +01:00
tags:
- contracts
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
$ref: ../models/Contract.yaml
examples:
Success:
value:
data:
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'
operationId: get-my-contracts-contractId
security:
- AgentToken: []
description: Get the details of a contract by ID.
'/my/contracts/{contractId}/accept':
parameters:
- schema:
type: string
name: contractId
in: path
required: true
post:
2022-03-12 03:04:56 +01:00
summary: Accept Contract
2022-03-12 02:41:45 +01:00
tags:
- contracts
2022-03-11 06:33:11 +01:00
responses:
'201':
description: Accepted
content:
application/json:
schema:
type: object
properties:
data:
$ref: ../models/Contract.yaml
operationId: post-my-contracts-contractId-accept
security:
- AgentToken: []
description: Accept a contract.
2022-03-11 03:17:28 +01:00
/systems:
get:
2022-03-12 03:04:56 +01:00
summary: List Systems
2022-03-11 03:50:22 +01:00
tags:
- systems
2022-03-11 03:17:28 +01:00
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
x-examples:
example-1:
data:
- symbol: X1-OE
sector: X1
type: RED_STAR
x: 0
'y': 0
waypoints:
- X1-OE-PM
- X1-OE-PM01
- X1-OE-A005
- X1-OE-25X
factions:
- COMMERCE_REPUBLIC
- MINERS_COLLECTIVE
- SPACERS_GUILD
charted: true
chartedBy: null
- symbol: X1-EV
sector: X1
type: ORANGE_STAR
x: 3
'y': 4
waypoints:
- X1-EV-A004
factions:
- COMMERCE_REPUBLIC
charted: true
chartedBy: null
- symbol: X1-ZZ
sector: X1
type: BLUE_STAR
x: -2
'y': 11
waypoints: []
factions: []
charted: false
chartedBy: null
meta:
total: 3
page: 1
limit: 20
properties:
data:
type: array
uniqueItems: true
minItems: 1
items:
$ref: ../models/System.yaml
meta:
2022-03-12 02:55:54 +01:00
$ref: ../models/Meta.yaml
2022-03-11 03:17:28 +01:00
required:
- data
- meta
2022-03-11 03:50:22 +01:00
examples:
Success:
value:
data:
- symbol: X1-OE
sector: X1
type: RED_STAR
x: 0
'y': 0
waypoints:
- X1-OE-PM
- X1-OE-PM01
- X1-OE-A005
- X1-OE-25X
factions:
- COMMERCE_REPUBLIC
- MINERS_COLLECTIVE
- SPACERS_GUILD
charted: true
chartedBy: null
meta:
total: 0
page: 0
limit: 0
2022-03-11 03:17:28 +01:00
operationId: get-systems
description: Return a list of all systems.
security:
- AgentToken: []
2022-03-12 03:18:37 +01:00
'/systems/{systemSymbol}':
parameters:
- schema:
type: string
default: X1-OE
name: systemSymbol
in: path
required: true
description: The system symbol
get:
summary: View System
tags:
- systems
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
x-examples:
example-1:
data:
symbol: X1-ZZ
sector: X1
type: BLUE_STAR
x: -2
'y': 9
waypoints: []
factions: []
charted: false
chartedBy: null
properties:
data:
$ref: ../models/System.yaml
required:
- data
examples:
Success:
value:
data:
symbol: X1-ZZ
sector: X1
type: BLUE_STAR
x: -2
'y': 9
waypoints: []
factions: []
charted: false
chartedBy: null
operationId: get-systems-systemSymbol
security:
- AgentToken: []
2022-03-12 04:50:09 +01:00
'/systems/{systemSymbol}/shipyards':
parameters:
- schema:
type: string
name: systemSymbol
in: path
required: true
description: the system symbol
get:
summary: List Shipyards
tags:
- shipyards
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
x-examples:
example-1:
data:
- symbol: X1-OE-PM
faction: COMMERCE_REPUBLIC
meta:
total: 1
page: 1
limit: 20
properties:
data:
type: array
uniqueItems: true
minItems: 1
items:
$ref: ../models/Shipyard.yaml
meta:
$ref: ../models/Meta.yaml
required:
- data
- meta
operationId: get-systems-systemSymbol-shipyards
security:
- AgentToken: []
description: Returns a list of all shipyards in a system.
'/systems/{systemSymbol}/shipyards/{waypointSymbol}':
parameters:
- schema:
type: string
name: systemSymbol
in: path
required: true
description: The system symbol
- schema:
type: string
name: waypointSymbol
in: path
required: true
description: The waypoint symbol
get:
summary: Shipyard Details
tags:
- shipyards
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
$ref: ../models/Shipyard.yaml
operationId: get-systems-systemSymbol-shipyards-waypointSymbol
security:
- AgentToken: []
'/systems/{systemSymbol}/shipyards/{waypointSymbol}/ships':
parameters:
- schema:
type: string
name: systemSymbol
in: path
required: true
description: The system symbol
- schema:
type: string
name: waypointSymbol
in: path
required: true
description: The waypoint symbol
get:
summary: Shipyard Listings
tags:
- shipyards
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
x-examples:
example-1:
data:
- id: cl0nahta90000aq0jonm1nprl
waypoint: X1-OE-PM
price: 58191
role: EXCAVATOR
frame: FRAME_DRONE
reactor: REACTOR_SOLAR_I
engine: ENGINE_SOLAR_PROPULSION
modules:
- MODULE_CARGO_HOLD
mounts:
- MOUNT_MINING_LASER_I
meta:
total: 1
page: 1
limit: 20
properties:
data:
type: array
uniqueItems: true
minItems: 1
items:
$ref: ../models/ShipyardListing.yaml
meta:
$ref: ../models/Meta.yaml
required:
- data
- meta
examples: {}
operationId: get-systems-systemSymbol-shipyards-waypointSymbol-ships
2022-03-11 02:33:09 +01:00
tags:
- 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
2022-03-11 03:50:22 +01:00
- name: systems
- name: waypoints
2022-03-12 04:50:09 +01:00
- name: shipyards
2022-03-10 04:16:02 +01:00
components:
schemas: {}
2022-03-10 04:37:49 +01:00
securitySchemes:
2022-03-11 02:33:09 +01:00
AgentToken:
2022-03-10 04:37:49 +01:00
type: http
scheme: bearer
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.