spacetraders/api-docs
1
0
Fork 0
mirror of https://github.com/SpaceTradersAPI/api-docs.git synced 2024-12-25 22:28:06 +01:00
Code Issues Packages Projects Releases Wiki Activity
c9c9352bb5
api-docs/reference/SpaceTraders.json
SpaceAdmiral 3ff410cbfe fix: add events to extract/survey endpoint
2024-03-10 12:19:24 -07:00

3848 lines
117 KiB
JSON
Raw Blame History

{
"openapi": "3.0.0",
"info": {
"contact": {
"email": "joel@spacetraders.io",
"name": "Joel Brubaker"
},
"description": "SpaceTraders is an open-universe game and learning platform that offers a set of HTTP endpoints to control a fleet of ships and explore a multiplayer universe.\n\nThe API is documented using [OpenAPI](https://github.com/SpaceTradersAPI/api-docs). You can send your first request right here in your browser to check the status of the game server.\n\n```json http\n{\n \"method\": \"GET\",\n \"url\": \"https://api.spacetraders.io/v2\",\n}\n```\n\nUnlike a traditional game, SpaceTraders does not have a first-party client or app to play the game. Instead, you can use the API to build your own client, write a script to automate your ships, or try an app built by the community.\n\nWe have a [Discord channel](https://discord.com/invite/jh6zurdWk5) where you can share your projects, ask questions, and get help from other players.\n\n\n",
"license": {
"name": "No Permission",
"url": "https://choosealicense.com/no-permission/"
},
"title": "SpaceTraders API",
"version": "2.0.0"
},
"security": [
{
"AgentToken": []
}
],
"servers": [
{
"description": "v2",
"url": "https://api.spacetraders.io/v2"
}
],
"tags": [
{
"description": "Agents",
"name": "Agents"
},
{
"description": "Contracts",
"name": "Contracts"
},
{
"description": "Factions",
"name": "Factions"
},
{
"description": "Fleet",
"name": "Fleet"
},
{
"description": "Systems",
"name": "Systems"
}
],
"components": {
"requestBodies": {},
"schemas": {},
"securitySchemes": {
"AgentToken": {
"description": "When you register a new agent you will be granted a private bearer token which grants authorization to use the API.",
"scheme": "bearer",
"type": "http"
}
}
},
"paths": {
"/": {
"get": {
"description": "Return the status of the game server.\nThis also includes a few global elements, such as announcements, server reset dates and leaderboards.",
"operationId": "get-status",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The current status of the game server."
},
"version": {
"type": "string",
"description": "The current version of the API."
},
"resetDate": {
"type": "string",
"description": "The date when the game server was last reset."
},
"description": {
"type": "string"
},
"stats": {
"type": "object",
"required": [
"agents",
"ships",
"systems",
"waypoints"
],
"properties": {
"agents": {
"type": "integer",
"description": "Number of registered agents in the game."
},
"ships": {
"type": "integer",
"description": "Total number of ships in the game."
},
"systems": {
"type": "integer",
"description": "Total number of systems in the game."
},
"waypoints": {
"type": "integer",
"description": "Total number of waypoints in the game."
}
}
},
"leaderboards": {
"type": "object",
"required": [
"mostCredits",
"mostSubmittedCharts"
],
"properties": {
"mostCredits": {
"type": "array",
"description": "Top agents with the most credits.",
"items": {
"type": "object",
"properties": {
"agentSymbol": {
"type": "string",
"description": "Symbol of the agent."
},
"credits": {
"type": "integer",
"format": "int64",
"description": "Amount of credits."
}
},
"required": [
"agentSymbol",
"credits"
]
}
},
"mostSubmittedCharts": {
"type": "array",
"description": "Top agents with the most charted submitted.",
"items": {
"type": "object",
"properties": {
"agentSymbol": {
"type": "string",
"description": "Symbol of the agent."
},
"chartCount": {
"type": "integer",
"description": "Amount of charts done by the agent."
}
},
"required": [
"agentSymbol",
"chartCount"
]
}
}
}
},
"serverResets": {
"type": "object",
"required": [
"next",
"frequency"
],
"properties": {
"next": {
"type": "string",
"description": "The date and time when the game server will reset."
},
"frequency": {
"type": "string",
"description": "How often we intend to reset the game server."
}
}
},
"announcements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": [
"title",
"body"
]
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"name",
"url"
]
}
}
},
"required": [
"status",
"version",
"resetDate",
"description",
"stats",
"leaderboards",
"serverResets",
"announcements",
"links"
]
}
}
},
"description": "Fetched status successfully."
}
},
"summary": "Get Status",
"tags": [],
"security": [
{},
{
"AgentToken": []
}
]
}
},
"/register": {
"post": {
"description": "Creates a new agent and ties it to an account. \nThe agent symbol must consist of a 3-14 character string, and will be used to represent your agent. This symbol will prefix the symbol of every ship you own. Agent symbols will be cast to all uppercase characters.\n\nThis new agent will be tied to a starting faction of your choice, which determines your starting location, and will be granted an authorization token, a contract with their starting faction, a command ship that can fly across space with advanced capabilities, a small probe ship that can be used for reconnaissance, and 150,000 credits.\n\n> #### Keep your token safe and secure\n>\n> 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.\n\nIf you are new to SpaceTraders, It is recommended to register with the COSMIC faction, a faction that is well connected to the rest of the universe. After registering, you should try our interactive [quickstart guide](https://docs.spacetraders.io/quickstart/new-game) which will walk you through basic API requests in just a few minutes.",
"operationId": "register",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"faction": {
"$ref": "../models/FactionSymbol.json"
},
"symbol": {
"description": "Your desired agent symbol. This will be a unique name used to represent your agent, and will be the prefix for your ships.",
"example": "BADGER",
"maxLength": 14,
"minLength": 3,
"type": "string"
},
"email": {
"type": "string",
"description": "Your email address. This is used if you reserved your call sign between resets."
}
},
"required": [
"symbol",
"faction"
],
"type": "object"
}
}
},
"description": ""
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"agent": {
"$ref": "../models/Agent.json"
},
"contract": {
"$ref": "../models/Contract.json"
},
"faction": {
"$ref": "../models/Faction.json"
},
"ship": {
"$ref": "../models/Ship.json"
},
"token": {
"description": "A Bearer token for accessing secured API endpoints.",
"type": "string"
}
},
"required": [
"token",
"agent",
"faction",
"contract",
"ship"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Succesfully registered."
}
},
"summary": "Register New Agent",
"tags": [],
"security": []
}
},
"/systems": {
"get": {
"description": "Return a paginated list of all systems.",
"operationId": "get-systems",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"items": {
"$ref": "../models/System.json"
},
"type": "array"
},
"meta": {
"$ref": "../models/Meta.json"
}
},
"required": [
"data",
"meta"
],
"type": "object"
}
}
},
"description": "Successfully listed systems."
}
},
"summary": "List Systems",
"tags": [
"Systems"
],
"parameters": [
{
"schema": {
"type": "integer",
"minimum": 1,
"default": 1
},
"in": "query",
"name": "page",
"description": "What entry offset to request"
},
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 20,
"default": 10
},
"in": "query",
"name": "limit",
"description": "How many entries to return per page"
}
],
"security": [
{},
{
"AgentToken": []
}
]
}
},
"/systems/{systemSymbol}": {
"get": {
"description": "Get the details of a system.",
"operationId": "get-system",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"$ref": "../models/System.json"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Successfully fetched the system."
}
},
"summary": "Get System",
"tags": [
"Systems"
],
"security": [
{},
{
"AgentToken": []
}
]
},
"parameters": [
{
"description": "The system symbol",
"in": "path",
"name": "systemSymbol",
"required": true,
"schema": {
"default": "X1-OE",
"type": "string"
}
}
]
},
"/systems/{systemSymbol}/waypoints": {
"get": {
"description": "Return a paginated list of all of the waypoints for a given system.\n\nIf a waypoint is uncharted, it will return the `Uncharted` trait instead of its actual traits.",
"operationId": "get-system-waypoints",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"items": {
"$ref": "../models/Waypoint.json"
},
"type": "array"
},
"meta": {
"$ref": "../models/Meta.json"
}
},
"required": [
"data",
"meta"
],
"type": "object"
}
}
},
"description": "Successfully fetched all waypoints in the system."
}
},
"summary": "List Waypoints in System",
"tags": [
"Systems"
],
"parameters": [
{
"schema": {
"type": "integer",
"minimum": 1,
"default": 1
},
"in": "query",
"name": "page",
"description": "What entry offset to request"
},
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 20,
"default": 10
},
"in": "query",
"name": "limit",
"description": "How many entries to return per page"
},
{
"description": "Filter waypoints by type.",
"in": "query",
"name": "type",
"schema": {
"$ref": "../models/WaypointType.json"
}
},
{
"description": "Filter waypoints by one or more traits.",
"in": "query",
"name": "traits",
"schema": {
"oneOf": [
{
"$ref": "../models/WaypointTraitSymbol.json"
},
{
"type": "array",
"items": {
"$ref": "../models/WaypointTraitSymbol.json"
}
}
]
}
}
],
"security": [
{},
{
"AgentToken": []
}
]
},
"parameters": [
{
"description": "The system symbol",
"in": "path",
"name": "systemSymbol",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"/systems/{systemSymbol}/waypoints/{waypointSymbol}": {
"get": {
"description": "View the details of a waypoint.\n\nIf the waypoint is uncharted, it will return the 'Uncharted' trait instead of its actual traits.",
"operationId": "get-waypoint",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"$ref": "../models/Waypoint.json"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Successfully fetched waypoint."
}
},
"summary": "Get Waypoint",
"tags": [
"Systems"
],
"security": [
{},
{
"AgentToken": []
}
]
},
"parameters": [
{
"description": "The system symbol",
"in": "path",
"name": "systemSymbol",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The waypoint symbol",
"in": "path",
"name": "waypointSymbol",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"/systems/{systemSymbol}/waypoints/{waypointSymbol}/market": {
"get": {
"description": "Retrieve imports, exports and exchange data from a marketplace. Requires a waypoint that has the `Marketplace` trait to use.\n\nSend a ship to the waypoint to access trade good prices and recent transactions. Refer to the [Market Overview page](https://docs.spacetraders.io/game-concepts/markets) to gain better a understanding of the market in the game.",
"operationId": "get-market",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "../models/Market.json"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Successfully fetched the market."
}
},
"security": [
{},
{
"AgentToken": []
}
],
"summary": "Get Market",
"tags": [
"Systems"
]
},
"parameters": [
{
"description": "The system symbol",
"in": "path",
"name": "systemSymbol",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The waypoint symbol",
"in": "path",
"name": "waypointSymbol",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"/systems/{systemSymbol}/waypoints/{waypointSymbol}/shipyard": {
"get": {
"description": "Get the shipyard for a waypoint. Requires a waypoint that has the `Shipyard` trait to use. Send a ship to the waypoint to access data on ships that are currently available for purchase and recent transactions.",
"operationId": "get-shipyard",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"$ref": "../models/Shipyard.json"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Successfully fetched the shipyard."
}
},
"security": [
{},
{
"AgentToken": []
}
],
"summary": "Get Shipyard",
"tags": [
"Systems"
]
},
"parameters": [
{
"description": "The system symbol",
"in": "path",
"name": "systemSymbol",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The waypoint symbol",
"in": "path",
"name": "waypointSymbol",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"/systems/{systemSymbol}/waypoints/{waypointSymbol}/jump-gate": {
"get": {
"description": "Get jump gate details for a waypoint. Requires a waypoint of type `JUMP_GATE` to use.\n\nWaypoints connected to this jump gate can be ",
"operationId": "get-jump-gate",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"$ref": "../models/JumpGate.json"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Successfully fetched jump gate."
}
},
"security": [
{},
{
"AgentToken": []
}
],
"summary": "Get Jump Gate",
"tags": [
"Systems"
]
},
"parameters": [
{
"description": "The system symbol",
"in": "path",
"name": "systemSymbol",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The waypoint symbol",
"in": "path",
"name": "waypointSymbol",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"/systems/{systemSymbol}/waypoints/{waypointSymbol}/construction": {
"get": {
"description": "Get construction details for a waypoint. Requires a waypoint with a property of `isUnderConstruction` to be true.",
"operationId": "get-construction",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"$ref": "../models/Construction.json"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Successfully fetched construction site."
}
},
"security": [
{},
{
"AgentToken": []
}
],
"summary": "Get Construction Site",
"tags": [
"Systems"
]
},
"parameters": [
{
"description": "The system symbol",
"in": "path",
"name": "systemSymbol",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The waypoint symbol",
"in": "path",
"name": "waypointSymbol",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"/systems/{systemSymbol}/waypoints/{waypointSymbol}/construction/supply": {
"post": {
"description": "Supply a construction site with the specified good. Requires a waypoint with a property of `isUnderConstruction` to be true.\n\nThe good must be in your ship's cargo. The good will be removed from your ship's cargo and added to the construction site's materials.",
"operationId": "supply-construction",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"shipSymbol": {
"type": "string",
"description": "Symbol of the ship to use."
},
"tradeSymbol": {
"type": "string",
"description": "The symbol of the good to supply."
},
"units": {
"type": "integer",
"description": "Amount of units to supply."
}
},
"required": [
"shipSymbol",
"tradeSymbol",
"units"
],
"type": "object"
}
}
},
"description": ""
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"properties": {
"construction": {
"$ref": "../models/Construction.json"
},
"cargo": {
"$ref": "../models/ShipCargo.json"
}
},
"required": [
"construction",
"cargo"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Successfully supplied construction site."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Supply Construction Site",
"tags": [
"Systems"
]
},
"parameters": [
{
"description": "The system symbol",
"in": "path",
"name": "systemSymbol",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The waypoint symbol",
"in": "path",
"name": "waypointSymbol",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"/factions": {
"get": {
"description": "Return a paginated list of all the factions in the game.",
"operationId": "get-factions",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"items": {
"$ref": "../models/Faction.json"
},
"type": "array"
},
"meta": {
"$ref": "../models/Meta.json"
}
},
"required": [
"data",
"meta"
],
"type": "object"
}
}
},
"description": "Succesfully fetched factions."
}
},
"summary": "List Factions",
"tags": [
"Factions"
],
"parameters": [
{
"schema": {
"type": "integer",
"minimum": 1,
"default": 1
},
"in": "query",
"name": "page",
"description": "What entry offset to request"
},
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 20,
"default": 10
},
"in": "query",
"name": "limit",
"description": "How many entries to return per page"
}
],
"security": [
{},
{
"AgentToken": []
}
]
}
},
"/factions/{factionSymbol}": {
"get": {
"description": "View the details of a faction.",
"operationId": "get-faction",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "../models/Faction.json"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Successfully fetched a faction."
}
},
"summary": "Get Faction",
"tags": [
"Factions"
]
},
"parameters": [
{
"description": "The faction symbol",
"in": "path",
"name": "factionSymbol",
"required": true,
"schema": {
"type": "string",
"example": "COSMIC"
}
}
]
},
"/my/agent": {
"get": {
"description": "Fetch your agent's details.",
"operationId": "get-my-agent",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "../models/Agent.json"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Successfully fetched agent details."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Get Agent",
"tags": [
"Agents"
]
}
},
"/agents": {
"get": {
"description": "Fetch agents details.",
"operationId": "get-agents",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"items": {
"$ref": "../models/Agent.json"
},
"type": "array"
},
"meta": {
"$ref": "../models/Meta.json"
}
},
"required": [
"data",
"meta"
],
"type": "object"
}
}
},
"description": "Successfully fetched agents details."
}
},
"summary": "List Agents",
"tags": [
"Agents"
],
"parameters": [
{
"schema": {
"type": "integer",
"minimum": 1,
"default": 1
},
"in": "query",
"name": "page",
"description": "What entry offset to request"
},
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 20,
"default": 10
},
"in": "query",
"name": "limit",
"description": "How many entries to return per page"
}
],
"security": [
{},
{
"AgentToken": []
}
]
}
},
"/agents/{agentSymbol}": {
"get": {
"description": "Fetch agent details.",
"operationId": "get-agent",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "../models/Agent.json"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Successfully fetched agent details."
}
},
"summary": "Get Public Agent",
"tags": [
"Agents"
],
"parameters": [
{
"description": "The agent symbol",
"in": "path",
"name": "agentSymbol",
"required": true,
"schema": {
"default": "FEBA66",
"type": "string"
}
}
],
"security": [
{},
{
"AgentToken": []
}
]
}
},
"/my/contracts": {
"get": {
"description": "Return a paginated list of all your contracts.",
"operationId": "get-contracts",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"items": {
"$ref": "../models/Contract.json"
},
"type": "array"
},
"meta": {
"$ref": "../models/Meta.json"
}
},
"required": [
"data",
"meta"
],
"type": "object"
}
}
},
"description": "Succesfully listed contracts."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "List Contracts",
"tags": [
"Contracts"
],
"parameters": [
{
"schema": {
"type": "integer",
"minimum": 1,
"default": 1
},
"in": "query",
"name": "page",
"description": "What entry offset to request"
},
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 20,
"default": 10
},
"in": "query",
"name": "limit",
"description": "How many entries to return per page"
}
]
}
},
"/my/contracts/{contractId}": {
"get": {
"description": "Get the details of a contract by ID.",
"operationId": "get-contract",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "../models/Contract.json"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Successfully fetched contract."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Get Contract",
"tags": [
"Contracts"
]
},
"parameters": [
{
"description": "The contract ID",
"in": "path",
"name": "contractId",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"/my/contracts/{contractId}/accept": {
"parameters": [
{
"description": "The contract ID to accept.",
"in": "path",
"name": "contractId",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Accept a contract by ID. \n\nYou can only accept contracts that were offered to you, were not accepted yet, and whose deadlines has not passed yet.",
"operationId": "accept-contract",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"agent": {
"$ref": "../models/Agent.json"
},
"contract": {
"$ref": "../models/Contract.json"
}
},
"required": [
"contract",
"agent"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Succesfully accepted contract."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Accept Contract",
"tags": [
"Contracts"
]
}
},
"/my/contracts/{contractId}/deliver": {
"parameters": [
{
"schema": {
"type": "string"
},
"name": "contractId",
"in": "path",
"required": true,
"description": "The ID of the contract."
}
],
"post": {
"description": "Deliver cargo to a contract.\n\nIn order to use this API, a ship must be at the delivery location (denoted in the delivery terms as `destinationSymbol` of a contract) and must have a number of units of a good required by this contract in its cargo.\n\nCargo that was delivered will be removed from the ship's cargo.",
"operationId": "deliver-contract",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"shipSymbol": {
"type": "string",
"description": "Symbol of a ship located in the destination to deliver a contract and that has a good to deliver in its cargo."
},
"tradeSymbol": {
"type": "string",
"description": "The symbol of the good to deliver."
},
"units": {
"type": "integer",
"description": "Amount of units to deliver."
}
},
"required": [
"shipSymbol",
"tradeSymbol",
"units"
],
"type": "object"
}
}
},
"description": ""
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"properties": {
"contract": {
"$ref": "../models/Contract.json"
},
"cargo": {
"$ref": "../models/ShipCargo.json"
}
},
"required": [
"contract",
"cargo"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Successfully delivered cargo to contract."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Deliver Cargo to Contract",
"tags": [
"Contracts"
]
}
},
"/my/contracts/{contractId}/fulfill": {
"parameters": [
{
"description": "The ID of the contract to fulfill.",
"in": "path",
"name": "contractId",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Fulfill a contract. Can only be used on contracts that have all of their delivery terms fulfilled.",
"operationId": "fulfill-contract",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"properties": {
"agent": {
"$ref": "../models/Agent.json"
},
"contract": {
"$ref": "../models/Contract.json"
}
},
"required": [
"contract",
"agent"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Successfully fulfilled a contract."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Fulfill Contract",
"tags": [
"Contracts"
]
}
},
"/my/ships": {
"get": {
"description": "Return a paginated list of all of ships under your agent's ownership.",
"operationId": "get-my-ships",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"items": {
"$ref": "../models/Ship.json"
},
"type": "array"
},
"meta": {
"$ref": "../models/Meta.json"
}
},
"required": [
"data",
"meta"
],
"type": "object"
}
}
},
"description": "Succesfully listed ships."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "List Ships",
"tags": [
"Fleet"
],
"parameters": [
{
"schema": {
"type": "integer",
"minimum": 1,
"default": 1
},
"in": "query",
"name": "page",
"description": "What entry offset to request"
},
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 20,
"default": 10
},
"in": "query",
"name": "limit",
"description": "How many entries to return per page"
}
]
},
"post": {
"description": "Purchase a ship from a Shipyard. In order to use this function, a ship under your agent's ownership must be in a waypoint that has the `Shipyard` trait, and the Shipyard must sell the type of the desired ship.\n\nShipyards typically offer ship types, which are predefined templates of ships that have dedicated roles. A template comes with a preset of an engine, a reactor, and a frame. It may also include a few modules and mounts.",
"operationId": "purchase-ship",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"shipType": {
"$ref": "../models/ShipType.json"
},
"waypointSymbol": {
"description": "The symbol of the waypoint you want to purchase the ship at.",
"type": "string"
}
},
"required": [
"shipType",
"waypointSymbol"
],
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"properties": {
"agent": {
"$ref": "../models/Agent.json"
},
"ship": {
"$ref": "../models/Ship.json"
},
"transaction": {
"$ref": "../models/ShipyardTransaction.json"
}
},
"required": [
"ship",
"agent",
"transaction"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Purchased ship successfully."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Purchase Ship",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}": {
"get": {
"description": "Retrieve the details of a ship under your agent's ownership.",
"operationId": "get-my-ship",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"$ref": "../models/Ship.json"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Successfully fetched ship."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Get Ship",
"tags": [
"Fleet"
]
},
"parameters": [
{
"description": "The symbol of the ship.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"/my/ships/{shipSymbol}/cargo": {
"parameters": [
{
"description": "The symbol of the ship.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"description": "Retrieve the cargo of a ship under your agent's ownership.",
"operationId": "get-my-ship-cargo",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"$ref": "../models/ShipCargo.json"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Successfully fetched ship's cargo."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Get Ship Cargo",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/orbit": {
"parameters": [
{
"description": "The symbol of the ship.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Attempt to move your ship into orbit at its current location. The request will only succeed if your ship is capable of moving into orbit at the time of the request.\n\nOrbiting ships are able to do actions that require the ship to be above surface such as navigating or extracting, but cannot access elements in their current waypoint, such as the market or a shipyard.\n\nThe endpoint is idempotent - successive calls will succeed even if the ship is already in orbit.",
"operationId": "orbit-ship",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"title": "Orbit Ship 200 Response",
"description": "",
"properties": {
"data": {
"properties": {
"nav": {
"$ref": "../models/ShipNav.json"
}
},
"type": "object",
"required": [
"nav"
]
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "The ship has successfully moved into orbit at its current location."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Orbit Ship",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/refine": {
"parameters": [
{
"description": "The symbol of the ship.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Attempt to refine the raw materials on your ship. The request will only succeed if your ship is capable of refining at the time of the request. In order to be able to refine, a ship must have goods that can be refined and have installed a `Refinery` module that can refine it.\n\nWhen refining, 30 basic goods will be converted into 10 processed goods.",
"operationId": "ship-refine",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"produce": {
"description": "The type of good to produce out of the refining process.",
"type": "string",
"enum": [
"IRON",
"COPPER",
"SILVER",
"GOLD",
"ALUMINUM",
"PLATINUM",
"URANITE",
"MERITIUM",
"FUEL"
]
}
},
"required": [
"produce"
]
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"title": "Ship Refine 201 Response",
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"cargo",
"cooldown",
"produced",
"consumed"
],
"properties": {
"cargo": {
"$ref": "../models/ShipCargo.json"
},
"cooldown": {
"$ref": "../models/Cooldown.json"
},
"produced": {
"type": "array",
"description": "Goods that were produced by this refining process.",
"items": {
"type": "object",
"properties": {
"tradeSymbol": {
"type": "string",
"description": "Symbol of the good."
},
"units": {
"type": "integer",
"description": "Amount of units of the good."
}
},
"required": [
"tradeSymbol",
"units"
]
}
},
"consumed": {
"type": "array",
"description": "Goods that were consumed during this refining process.",
"items": {
"type": "object",
"properties": {
"tradeSymbol": {
"type": "string",
"description": "Symbol of the good."
},
"units": {
"type": "integer",
"description": "Amount of units of the good."
}
},
"required": [
"tradeSymbol",
"units"
]
}
}
}
}
},
"required": [
"data"
]
}
}
},
"description": "The ship has successfully refined goods."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Ship Refine",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/chart": {
"parameters": [
{
"description": "The symbol of the ship.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Command a ship to chart the waypoint at its current location.\n\nMost waypoints in the universe are uncharted by default. These waypoints have their traits hidden until they have been charted by a ship.\n\nCharting a waypoint will record your agent as the one who created the chart, and all other agents would also be able to see the waypoint's traits.",
"operationId": "create-chart",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"chart": {
"$ref": "../models/Chart.json"
},
"waypoint": {
"$ref": "../models/Waypoint.json"
}
},
"required": [
"chart",
"waypoint"
],
"type": "object"
}
},
"type": "object",
"required": [
"data"
]
}
}
},
"description": "Created"
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Create Chart",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/cooldown": {
"get": {
"description": "Retrieve the details of your ship's reactor cooldown. Some actions such as activating your jump drive, scanning, or extracting resources taxes your reactor and results in a cooldown.\n\nYour ship cannot perform additional actions until your cooldown has expired. The duration of your cooldown is relative to the power consumption of the related modules or mounts for the action taken.\n\nResponse returns a 204 status code (no-content) when the ship has no cooldown.",
"operationId": "get-ship-cooldown",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"$ref": "../models/Cooldown.json"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Succesfully fetched ship's cooldown."
},
"204": {
"description": "No cooldown."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Get Ship Cooldown",
"tags": [
"Fleet"
]
},
"parameters": [
{
"description": "The symbol of the ship.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"/my/ships/{shipSymbol}/dock": {
"parameters": [
{
"description": "The symbol of the ship.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Attempt to dock your ship at its current location. Docking will only succeed if your ship is capable of docking at the time of the request.\n\nDocked ships can access elements in their current location, such as the market or a shipyard, but cannot do actions that require the ship to be above surface such as navigating or extracting.\n\nThe endpoint is idempotent - successive calls will succeed even if the ship is already docked.",
"operationId": "dock-ship",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"title": "Dock Ship 200 Response",
"description": "",
"properties": {
"data": {
"properties": {
"nav": {
"$ref": "../models/ShipNav.json"
}
},
"required": [
"nav"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "The ship has successfully docked at its current location."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Dock Ship",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/survey": {
"parameters": [
{
"description": "The symbol of the ship.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Create surveys on a waypoint that can be extracted such as asteroid fields. A survey focuses on specific types of deposits from the extracted location. When ships extract using this survey, they are guaranteed to procure a high amount of one of the goods in the survey.\n\nIn order to use a survey, send the entire survey details in the body of the extract request.\n\nEach survey may have multiple deposits, and if a symbol shows up more than once, that indicates a higher chance of extracting that resource.\n\nYour ship will enter a cooldown after surveying in which it is unable to perform certain actions. Surveys will eventually expire after a period of time or will be exhausted after being extracted several times based on the survey's size. Multiple ships can use the same survey for extraction.\n\nA ship must have the `Surveyor` mount installed in order to use this function.",
"operationId": "create-survey",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"cooldown",
"surveys"
],
"properties": {
"cooldown": {
"$ref": "../models/Cooldown.json"
},
"surveys": {
"type": "array",
"description": "Surveys created by this action.",
"items": {
"$ref": "../models/Survey.json"
}
}
}
}
},
"required": [
"data"
]
}
}
},
"description": "Surveys has been created."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Create Survey",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/extract": {
"parameters": [
{
"description": "The ship symbol.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Extract resources from a waypoint that can be extracted, such as asteroid fields, into your ship. Send an optional survey as the payload to target specific yields.\n\nThe ship must be in orbit to be able to extract and must have mining equipments installed that can extract goods, such as the `Gas Siphon` mount for gas-based goods or `Mining Laser` mount for ore-based goods.\n\nThe survey property is now deprecated. See the `extract/survey` endpoint for more details.",
"operationId": "extract-resources",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"survey": {
"deprecated": true,
"$ref": "../models/Survey.json"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"properties": {
"cooldown": {
"$ref": "../models/Cooldown.json"
},
"extraction": {
"$ref": "../models/Extraction.json"
},
"cargo": {
"$ref": "../models/ShipCargo.json"
},
"events": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "../models/ShipConditionEvent.json"
}
]
}
}
},
"required": [
"extraction",
"cooldown",
"cargo",
"events"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Extracted successfully."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Extract Resources",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/siphon": {
"parameters": [
{
"description": "The ship symbol.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Siphon gases, such as hydrocarbon, from gas giants.\n\nThe ship must be in orbit to be able to siphon and must have siphon mounts and a gas processor installed.",
"operationId": "siphon-resources",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"properties": {
"cooldown": {
"$ref": "../models/Cooldown.json"
},
"siphon": {
"$ref": "../models/Siphon.json"
},
"cargo": {
"$ref": "../models/ShipCargo.json"
},
"events": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "../models/ShipConditionEvent.json"
}
]
}
}
},
"required": [
"siphon",
"cooldown",
"cargo",
"events"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Siphon successful."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Siphon Resources",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/extract/survey": {
"parameters": [
{
"description": "The ship symbol.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Use a survey when extracting resources from a waypoint. This endpoint requires a survey as the payload, which allows your ship to extract specific yields.\n\nSend the full survey object as the payload which will be validated according to the signature. If the signature is invalid, or any properties of the survey are changed, the request will fail.",
"operationId": "extract-resources-with-survey",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "../models/Survey.json"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"properties": {
"cooldown": {
"$ref": "../models/Cooldown.json"
},
"extraction": {
"$ref": "../models/Extraction.json"
},
"cargo": {
"$ref": "../models/ShipCargo.json"
},
"events": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "../models/ShipConditionEvent.json"
}
]
}
}
},
"required": [
"extraction",
"cooldown",
"cargo",
"events"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Extracted successfully."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Extract Resources with Survey",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/jettison": {
"parameters": [
{
"description": "The ship symbol.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Jettison cargo from your ship's cargo hold.",
"operationId": "jettison",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"symbol": {
"$ref": "../models/TradeSymbol.json"
},
"units": {
"minimum": 1,
"type": "integer",
"description": "Amount of units to jettison of this good."
}
},
"required": [
"symbol",
"units"
]
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"properties": {
"cargo": {
"$ref": "../models/ShipCargo.json"
}
},
"required": [
"cargo"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Jettison successful."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Jettison Cargo",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/jump": {
"parameters": [
{
"description": "The ship symbol.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Jump your ship instantly to a target connected waypoint. The ship must be in orbit to execute a jump.\n\nA unit of antimatter is purchased and consumed from the market when jumping. The price of antimatter is determined by the market and is subject to change. A ship can only jump to connected waypoints",
"operationId": "jump-ship",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"waypointSymbol": {
"description": "The symbol of the waypoint to jump to. The destination must be a connected waypoint.",
"type": "string"
}
},
"required": [
"waypointSymbol"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"properties": {
"nav": {
"$ref": "../models/ShipNav.json"
},
"cooldown": {
"$ref": "../models/Cooldown.json"
},
"transaction": {
"$ref": "../models/MarketTransaction.json"
},
"agent": {
"$ref": "../models/Agent.json"
}
},
"required": [
"nav",
"cooldown",
"transaction",
"agent"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Jump successful."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Jump Ship",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/navigate": {
"parameters": [
{
"description": "The ship symbol.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Navigate to a target destination. The ship must be in orbit to use this function. The destination waypoint must be within the same system as the ship's current location. Navigating will consume the necessary fuel from the ship's manifest based on the distance to the target waypoint.\n\nThe returned response will detail the route information including the expected time of arrival. Most ship actions are unavailable until the ship has arrived at it's destination.\n\nTo travel between systems, see the ship's Warp or Jump actions.",
"operationId": "navigate-ship",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"waypointSymbol": {
"description": "The target destination.",
"type": "string"
}
},
"required": [
"waypointSymbol"
],
"type": "object"
}
}
},
"description": ""
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"properties": {
"fuel": {
"$ref": "../models/ShipFuel.json"
},
"nav": {
"$ref": "../models/ShipNav.json"
},
"events": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "../models/ShipConditionEvent.json"
}
]
}
}
},
"required": [
"nav",
"fuel",
"events"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "The successful transit information including the route details and changes to ship fuel. The route includes the expected time of arrival."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Navigate Ship",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/nav": {
"parameters": [
{
"description": "The ship symbol.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"patch": {
"description": "Update the nav configuration of a ship.\n\nCurrently only supports configuring the Flight Mode of the ship, which affects its speed and fuel consumption.",
"operationId": "patch-ship-nav",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"flightMode": {
"$ref": "../models/ShipNavFlightMode.json"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"$ref": "../models/ShipNav.json"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "The updated nav data of the ship."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Patch Ship Nav",
"tags": [
"Fleet"
]
},
"get": {
"description": "Get the current nav status of a ship.",
"operationId": "get-ship-nav",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"$ref": "../models/ShipNav.json"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "The current nav status of the ship."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Get Ship Nav",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/warp": {
"parameters": [
{
"description": "The ship symbol.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Warp your ship to a target destination in another system. The ship must be in orbit to use this function and must have the `Warp Drive` module installed. Warping will consume the necessary fuel from the ship's manifest.\n\nThe returned response will detail the route information including the expected time of arrival. Most ship actions are unavailable until the ship has arrived at its destination.",
"operationId": "warp-ship",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"waypointSymbol": {
"description": "The target destination.",
"type": "string"
}
},
"required": [
"waypointSymbol"
],
"type": "object"
}
}
},
"description": ""
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"properties": {
"fuel": {
"$ref": "../models/ShipFuel.json"
},
"nav": {
"$ref": "../models/ShipNav.json"
}
},
"required": [
"nav",
"fuel"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "The successful transit information including the route details and changes to ship fuel. The route includes the expected time of arrival."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Warp Ship",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/sell": {
"parameters": [
{
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
},
"description": "Symbol of a ship."
}
],
"post": {
"description": "Sell cargo in your ship to a market that trades this cargo. The ship must be docked in a waypoint that has the `Marketplace` trait in order to use this function.",
"operationId": "sell-cargo",
"requestBody": {
"content": {
"application/json": {
"schema": {
"title": "SellCargoRequest",
"type": "object",
"properties": {
"symbol": {
"$ref": "../models/TradeSymbol.json"
},
"units": {
"type": "integer",
"description": "Amounts of units to sell of the selected good."
}
},
"required": [
"symbol",
"units"
]
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"title": "Sell Cargo 201 Response",
"description": "",
"properties": {
"data": {
"properties": {
"agent": {
"$ref": "../models/Agent.json"
},
"cargo": {
"$ref": "../models/ShipCargo.json"
},
"transaction": {
"$ref": "../models/MarketTransaction.json"
}
},
"required": [
"cargo",
"transaction",
"agent"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Cargo was successfully sold."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Sell Cargo",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/scan/systems": {
"parameters": [
{
"description": "The ship symbol.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Scan for nearby systems, retrieving information on the systems' distance from the ship and their waypoints. Requires a ship to have the `Sensor Array` mount installed to use.\n\nThe ship will enter a cooldown after using this function, during which it cannot execute certain actions.",
"operationId": "create-ship-system-scan",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"cooldown",
"systems"
],
"properties": {
"cooldown": {
"$ref": "../models/Cooldown.json"
},
"systems": {
"type": "array",
"description": "List of scanned systems.",
"items": {
"$ref": "../models/ScannedSystem.json"
}
}
}
}
},
"required": [
"data"
]
}
}
},
"description": "Successfully scanned for nearby systems."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Scan Systems",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/scan/waypoints": {
"parameters": [
{
"description": "The ship symbol.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Scan for nearby waypoints, retrieving detailed information on each waypoint in range. Scanning uncharted waypoints will allow you to ignore their uncharted state and will list the waypoints' traits.\n\nRequires a ship to have the `Sensor Array` mount installed to use.\n\nThe ship will enter a cooldown after using this function, during which it cannot execute certain actions.",
"operationId": "create-ship-waypoint-scan",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"cooldown",
"waypoints"
],
"properties": {
"cooldown": {
"$ref": "../models/Cooldown.json"
},
"waypoints": {
"type": "array",
"description": "List of scanned waypoints.",
"items": {
"$ref": "../models/ScannedWaypoint.json"
}
}
}
}
},
"required": [
"data"
]
}
}
},
"description": "Successfully scanned for nearby waypoints."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Scan Waypoints",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/scan/ships": {
"parameters": [
{
"description": "The ship symbol.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Scan for nearby ships, retrieving information for all ships in range.\n\nRequires a ship to have the `Sensor Array` mount installed to use.\n\nThe ship will enter a cooldown after using this function, during which it cannot execute certain actions.",
"operationId": "create-ship-ship-scan",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"cooldown",
"ships"
],
"properties": {
"cooldown": {
"$ref": "../models/Cooldown.json"
},
"ships": {
"type": "array",
"description": "List of scanned ships.",
"items": {
"$ref": "../models/ScannedShip.json"
}
}
}
}
},
"required": [
"data"
]
}
}
},
"description": "Successfully scanned for nearby ships."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Scan Ships",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/refuel": {
"parameters": [
{
"description": "The ship symbol.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Refuel your ship by buying fuel from the local market.\n\nRequires the ship to be docked in a waypoint that has the `Marketplace` trait, and the market must be selling fuel in order to refuel.\n\nEach fuel bought from the market replenishes 100 units in your ship's fuel.\n\nShips will always be refuel to their frame's maximum fuel capacity when using this action.",
"operationId": "refuel-ship",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"units": {
"type": "integer",
"description": "The amount of fuel to fill in the ship's tanks. When not specified, the ship will be refueled to its maximum fuel capacity. If the amount specified is greater than the ship's remaining capacity, the ship will only be refueled to its maximum fuel capacity. The amount specified is not in market units but in ship fuel units.",
"example": "100",
"minimum": 1
},
"fromCargo": {
"type": "boolean",
"description": "Wether to use the FUEL thats in your cargo or not. Default: false",
"example": false
}
}
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"properties": {
"agent": {
"$ref": "../models/Agent.json"
},
"fuel": {
"$ref": "../models/ShipFuel.json"
},
"transaction": {
"$ref": "../models/MarketTransaction.json"
}
},
"required": [
"agent",
"fuel",
"transaction"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Refueled successfully."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Refuel Ship",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/purchase": {
"parameters": [
{
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
},
"description": "The ship's symbol."
}
],
"post": {
"description": "Purchase cargo from a market.\n\nThe ship must be docked in a waypoint that has `Marketplace` trait, and the market must be selling a good to be able to purchase it.\n\nThe maximum amount of units of a good that can be purchased in each transaction are denoted by the `tradeVolume` value of the good, which can be viewed by using the Get Market action.\n\nPurchased goods are added to the ship's cargo hold.",
"operationId": "purchase-cargo",
"requestBody": {
"content": {
"application/json": {
"schema": {
"title": "Purchase Cargo Request",
"type": "object",
"properties": {
"symbol": {
"$ref": "../models/TradeSymbol.json"
},
"units": {
"type": "integer",
"description": "Amounts of units to purchase."
}
},
"required": [
"symbol",
"units"
]
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"title": "Purchase Cargo 201 Response",
"description": "",
"properties": {
"data": {
"properties": {
"agent": {
"$ref": "../models/Agent.json"
},
"cargo": {
"$ref": "../models/ShipCargo.json"
},
"transaction": {
"$ref": "../models/MarketTransaction.json"
}
},
"required": [
"cargo",
"transaction",
"agent"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Purchased goods successfully."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Purchase Cargo",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/transfer": {
"parameters": [
{
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
},
"description": "The transferring ship's symbol."
}
],
"post": {
"description": "Transfer cargo between ships.\n\nThe receiving ship must be in the same waypoint as the transferring ship, and it must able to hold the additional cargo after the transfer is complete. Both ships also must be in the same state, either both are docked or both are orbiting.\n\nThe response body's cargo shows the cargo of the transferring ship after the transfer is complete.",
"operationId": "transfer-cargo",
"requestBody": {
"content": {
"application/json": {
"schema": {
"title": "Transfer Cargo Request",
"type": "object",
"properties": {
"tradeSymbol": {
"$ref": "../models/TradeSymbol.json"
},
"units": {
"type": "integer",
"description": "Amount of units to transfer."
},
"shipSymbol": {
"type": "string",
"description": "The symbol of the ship to transfer to."
}
},
"required": [
"tradeSymbol",
"units",
"shipSymbol"
]
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"title": "Transfer Cargo 200 Response",
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"cargo"
],
"properties": {
"cargo": {
"$ref": "../models/ShipCargo.json"
}
}
}
},
"required": [
"data"
]
}
}
},
"description": "Transfer successful."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Transfer Cargo",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/negotiate/contract": {
"parameters": [
{
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
},
"description": "The ship's symbol."
}
],
"post": {
"description": "Negotiate a new contract with the HQ.\n\nIn order to negotiate a new contract, an agent must not have ongoing or offered contracts over the allowed maximum amount. Currently the maximum contracts an agent can have at a time is 1.\n\nOnce a contract is negotiated, it is added to the list of contracts offered to the agent, which the agent can then accept. \n\nThe ship must be present at any waypoint with a faction present to negotiate a contract with that faction.",
"operationId": "negotiateContract",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"title": "Negotiate Contract 200 Response",
"description": "",
"properties": {
"data": {
"properties": {
"contract": {
"$ref": "../models/Contract.json"
}
},
"required": [
"contract"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Successfully negotiated a new contract."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Negotiate Contract",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/mounts": {
"parameters": [
{
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
},
"description": "The ship's symbol."
}
],
"get": {
"description": "Get the mounts installed on a ship.",
"operationId": "get-mounts",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"title": "Get Mounts 200 Response",
"description": "",
"properties": {
"data": {
"items": {
"$ref": "../models/ShipMount.json"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Got installed mounts."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Get Mounts",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/mounts/install": {
"parameters": [
{
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
},
"description": "The ship's symbol."
}
],
"post": {
"description": "Install a mount on a ship.\n\nIn order to install a mount, the ship must be docked and located in a waypoint that has a `Shipyard` trait. The ship also must have the mount to install in its cargo hold.\n\nAn installation fee will be deduced by the Shipyard for installing the mount on the ship. ",
"operationId": "install-mount",
"requestBody": {
"content": {
"application/json": {
"schema": {
"title": "Install Mount Request",
"properties": {
"symbol": {
"type": "string"
}
},
"required": [
"symbol"
],
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"title": "Install Mount 201 Response",
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"agent",
"mounts",
"cargo",
"transaction"
],
"properties": {
"agent": {
"$ref": "../models/Agent.json"
},
"mounts": {
"type": "array",
"description": "List of installed mounts after the installation of the new mount.",
"items": {
"$ref": "../models/ShipMount.json"
}
},
"cargo": {
"$ref": "../models/ShipCargo.json"
},
"transaction": {
"$ref": "../models/ShipModificationTransaction.json"
}
}
}
},
"required": [
"data"
]
}
}
},
"description": "Successfully installed the mount."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Install Mount",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/mounts/remove": {
"parameters": [
{
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
},
"description": "The ship's symbol."
}
],
"post": {
"description": "Remove a mount from a ship.\n\nThe ship must be docked in a waypoint that has the `Shipyard` trait, and must have the desired mount that it wish to remove installed.\n\nA removal fee will be deduced from the agent by the Shipyard.",
"operationId": "remove-mount",
"requestBody": {
"content": {
"application/json": {
"schema": {
"title": "Remove Mount Request",
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The symbol of the mount to remove."
}
},
"required": [
"symbol"
]
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"title": "Remove Mount 201 Response",
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"agent",
"mounts",
"cargo",
"transaction"
],
"properties": {
"agent": {
"$ref": "../models/Agent.json"
},
"mounts": {
"type": "array",
"description": "List of installed mounts after the removal of the selected mount.",
"items": {
"$ref": "../models/ShipMount.json"
}
},
"cargo": {
"$ref": "../models/ShipCargo.json"
},
"transaction": {
"$ref": "../models/ShipModificationTransaction.json"
}
}
}
},
"required": [
"data"
]
}
}
},
"description": "Successfully removed the mount."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Remove Mount",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/scrap": {
"parameters": [
{
"description": "The ship symbol.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"x-preview-feature": true,
"description": "Get the amount of value that will be returned when scrapping a ship.",
"operationId": "get-scrap-ship",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"properties": {
"transaction": {
"$ref": "../models/ScrapTransaction.json"
}
},
"required": [
"transaction"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Successfully retrieved the amount of value that will be returned when scrapping a ship."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Get Scrap Ship",
"tags": [
"Fleet"
]
},
"post": {
"x-preview-feature": true,
"description": "Scrap a ship, removing it from the game and returning a portion of the ship's value to the agent. The ship must be docked in a waypoint that has the `Shipyard` trait in order to use this function. To preview the amount of value that will be returned, use the Get Ship action.",
"operationId": "scrap-ship",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"properties": {
"agent": {
"$ref": "../models/Agent.json"
},
"transaction": {
"$ref": "../models/ScrapTransaction.json"
}
},
"required": [
"agent",
"transaction"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Ship scrapped successfully."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Scrap Ship",
"tags": [
"Fleet"
]
}
},
"/my/ships/{shipSymbol}/repair": {
"parameters": [
{
"description": "The ship symbol.",
"in": "path",
"name": "shipSymbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"x-preview-feature": true,
"description": "Get the cost of repairing a ship.",
"operationId": "get-repair-ship",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"properties": {
"transaction": {
"$ref": "../models/RepairTransaction.json"
}
},
"required": [
"transaction"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Successfully retrieved the cost of repairing a ship."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Get Repair Ship",
"tags": [
"Fleet"
]
},
"post": {
"x-preview-feature": true,
"description": "Repair a ship, restoring the ship to maximum condition. The ship must be docked at a waypoint that has the `Shipyard` trait in order to use this function. To preview the cost of repairing the ship, use the Get action.",
"operationId": "repair-ship",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"description": "",
"properties": {
"data": {
"properties": {
"agent": {
"$ref": "../models/Agent.json"
},
"ship": {
"$ref": "../models/Ship.json"
},
"transaction": {
"$ref": "../models/RepairTransaction.json"
}
},
"required": [
"agent",
"ship",
"transaction"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Ship repaired successfully."
}
},
"security": [
{
"AgentToken": []
}
],
"summary": "Repair Ship",
"tags": [
"Fleet"
]
}
}
}
}
Reference in New Issue View Git Blame Copy Permalink