Skip to content

Latest commit

 

History

History
1743 lines (1228 loc) · 62.2 KB

FleetApi.md

File metadata and controls

1743 lines (1228 loc) · 62.2 KB

openapi.api.FleetApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to https://api.spacetraders.io/v2

Method HTTP request Description
createChart POST /my/ships/{shipSymbol}/chart Create Chart
createShipShipScan POST /my/ships/{shipSymbol}/scan/ships Scan Ships
createShipSystemScan POST /my/ships/{shipSymbol}/scan/systems Scan Systems
createShipWaypointScan POST /my/ships/{shipSymbol}/scan/waypoints Scan Waypoints
createSurvey POST /my/ships/{shipSymbol}/survey Create Survey
dockShip POST /my/ships/{shipSymbol}/dock Dock Ship
extractResources POST /my/ships/{shipSymbol}/extract Extract Resources
extractResourcesWithSurvey POST /my/ships/{shipSymbol}/extract/survey Extract Resources with Survey
getMounts GET /my/ships/{shipSymbol}/mounts Get Mounts
getMyShip GET /my/ships/{shipSymbol} Get Ship
getMyShipCargo GET /my/ships/{shipSymbol}/cargo Get Ship Cargo
getMyShips GET /my/ships List Ships
getRepairShip GET /my/ships/{shipSymbol}/repair Get Repair Ship
getScrapShip GET /my/ships/{shipSymbol}/scrap Get Scrap Ship
getShipCooldown GET /my/ships/{shipSymbol}/cooldown Get Ship Cooldown
getShipNav GET /my/ships/{shipSymbol}/nav Get Ship Nav
installMount POST /my/ships/{shipSymbol}/mounts/install Install Mount
jettison POST /my/ships/{shipSymbol}/jettison Jettison Cargo
jumpShip POST /my/ships/{shipSymbol}/jump Jump Ship
navigateShip POST /my/ships/{shipSymbol}/navigate Navigate Ship
negotiateContract POST /my/ships/{shipSymbol}/negotiate/contract Negotiate Contract
orbitShip POST /my/ships/{shipSymbol}/orbit Orbit Ship
patchShipNav PATCH /my/ships/{shipSymbol}/nav Patch Ship Nav
purchaseCargo POST /my/ships/{shipSymbol}/purchase Purchase Cargo
purchaseShip POST /my/ships Purchase Ship
refuelShip POST /my/ships/{shipSymbol}/refuel Refuel Ship
removeMount POST /my/ships/{shipSymbol}/mounts/remove Remove Mount
repairShip POST /my/ships/{shipSymbol}/repair Repair Ship
scrapShip POST /my/ships/{shipSymbol}/scrap Scrap Ship
sellCargo POST /my/ships/{shipSymbol}/sell Sell Cargo
shipRefine POST /my/ships/{shipSymbol}/refine Ship Refine
siphonResources POST /my/ships/{shipSymbol}/siphon Siphon Resources
transferCargo POST /my/ships/{shipSymbol}/transfer Transfer Cargo
warpShip POST /my/ships/{shipSymbol}/warp Warp Ship

createChart

CreateChart201Response createChart(shipSymbol)

Create Chart

Command a ship to chart the waypoint at its current location. Most waypoints in the universe are uncharted by default. These waypoints have their traits hidden until they have been charted by a ship. Charting 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.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The symbol of the ship.

try {
    final result = api_instance.createChart(shipSymbol);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->createChart: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The symbol of the ship.

Return type

CreateChart201Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createShipShipScan

CreateShipShipScan201Response createShipShipScan(shipSymbol)

Scan Ships

Scan for nearby ships, retrieving information for all ships in range. Requires a ship to have the Sensor Array mount installed to use. The ship will enter a cooldown after using this function, during which it cannot execute certain actions.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship symbol.

try {
    final result = api_instance.createShipShipScan(shipSymbol);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->createShipShipScan: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship symbol.

Return type

CreateShipShipScan201Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createShipSystemScan

CreateShipSystemScan201Response createShipSystemScan(shipSymbol)

Scan Systems

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. The ship will enter a cooldown after using this function, during which it cannot execute certain actions.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship symbol.

try {
    final result = api_instance.createShipSystemScan(shipSymbol);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->createShipSystemScan: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship symbol.

Return type

CreateShipSystemScan201Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createShipWaypointScan

CreateShipWaypointScan201Response createShipWaypointScan(shipSymbol)

Scan Waypoints

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. Requires a ship to have the Sensor Array mount installed to use. The ship will enter a cooldown after using this function, during which it cannot execute certain actions.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship symbol.

try {
    final result = api_instance.createShipWaypointScan(shipSymbol);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->createShipWaypointScan: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship symbol.

Return type

CreateShipWaypointScan201Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createSurvey

CreateSurvey201Response createSurvey(shipSymbol)

Create Survey

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. In order to use a survey, send the entire survey details 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. Your 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. A ship must have the Surveyor mount installed in order to use this function.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The symbol of the ship.

try {
    final result = api_instance.createSurvey(shipSymbol);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->createSurvey: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The symbol of the ship.

Return type

CreateSurvey201Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dockShip

DockShip200Response dockShip(shipSymbol)

Dock Ship

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. Docked 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. The endpoint is idempotent - successive calls will succeed even if the ship is already docked.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The symbol of the ship.

try {
    final result = api_instance.dockShip(shipSymbol);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->dockShip: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The symbol of the ship.

Return type

DockShip200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extractResources

ExtractResources201Response extractResources(shipSymbol, extractResourcesRequest)

Extract Resources

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. The 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. The survey property is now deprecated. See the extract/survey endpoint for more details.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship symbol.
final extractResourcesRequest = ExtractResourcesRequest(); // ExtractResourcesRequest | 

try {
    final result = api_instance.extractResources(shipSymbol, extractResourcesRequest);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->extractResources: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship symbol.
extractResourcesRequest ExtractResourcesRequest [optional]

Return type

ExtractResources201Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

extractResourcesWithSurvey

ExtractResources201Response extractResourcesWithSurvey(shipSymbol, survey)

Extract Resources with Survey

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. Send 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.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship symbol.
final survey = Survey(); // Survey | 

try {
    final result = api_instance.extractResourcesWithSurvey(shipSymbol, survey);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->extractResourcesWithSurvey: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship symbol.
survey Survey [optional]

Return type

ExtractResources201Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMounts

GetMounts200Response getMounts(shipSymbol)

Get Mounts

Get the mounts installed on a ship.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship's symbol.

try {
    final result = api_instance.getMounts(shipSymbol);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->getMounts: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship's symbol.

Return type

GetMounts200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMyShip

GetMyShip200Response getMyShip(shipSymbol)

Get Ship

Retrieve the details of a ship under your agent's ownership.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The symbol of the ship.

try {
    final result = api_instance.getMyShip(shipSymbol);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->getMyShip: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The symbol of the ship.

Return type

GetMyShip200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMyShipCargo

GetMyShipCargo200Response getMyShipCargo(shipSymbol)

Get Ship Cargo

Retrieve the cargo of a ship under your agent's ownership.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The symbol of the ship.

try {
    final result = api_instance.getMyShipCargo(shipSymbol);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->getMyShipCargo: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The symbol of the ship.

Return type

GetMyShipCargo200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMyShips

GetMyShips200Response getMyShips(page, limit)

List Ships

Return a paginated list of all of ships under your agent's ownership.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final page = 56; // int | What entry offset to request
final limit = 56; // int | How many entries to return per page

try {
    final result = api_instance.getMyShips(page, limit);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->getMyShips: $e\n');
}

Parameters

Name Type Description Notes
page int What entry offset to request [optional] [default to 1]
limit int How many entries to return per page [optional] [default to 10]

Return type

GetMyShips200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getRepairShip

GetRepairShip200Response getRepairShip(shipSymbol)

Get Repair Ship

Get the cost of repairing a ship.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship symbol.

try {
    final result = api_instance.getRepairShip(shipSymbol);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->getRepairShip: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship symbol.

Return type

GetRepairShip200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getScrapShip

GetScrapShip200Response getScrapShip(shipSymbol)

Get Scrap Ship

Get the amount of value that will be returned when scrapping a ship.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship symbol.

try {
    final result = api_instance.getScrapShip(shipSymbol);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->getScrapShip: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship symbol.

Return type

GetScrapShip200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getShipCooldown

GetShipCooldown200Response getShipCooldown(shipSymbol)

Get Ship Cooldown

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. Your 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. Response returns a 204 status code (no-content) when the ship has no cooldown.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The symbol of the ship.

try {
    final result = api_instance.getShipCooldown(shipSymbol);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->getShipCooldown: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The symbol of the ship.

Return type

GetShipCooldown200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getShipNav

GetShipNav200Response getShipNav(shipSymbol)

Get Ship Nav

Get the current nav status of a ship.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship symbol.

try {
    final result = api_instance.getShipNav(shipSymbol);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->getShipNav: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship symbol.

Return type

GetShipNav200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

installMount

InstallMount201Response installMount(shipSymbol, installMountRequest)

Install Mount

Install a mount on a ship. In 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. An installation fee will be deduced by the Shipyard for installing the mount on the ship.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship's symbol.
final installMountRequest = InstallMountRequest(); // InstallMountRequest | 

try {
    final result = api_instance.installMount(shipSymbol, installMountRequest);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->installMount: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship's symbol.
installMountRequest InstallMountRequest [optional]

Return type

InstallMount201Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jettison

Jettison200Response jettison(shipSymbol, jettisonRequest)

Jettison Cargo

Jettison cargo from your ship's cargo hold.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship symbol.
final jettisonRequest = JettisonRequest(); // JettisonRequest | 

try {
    final result = api_instance.jettison(shipSymbol, jettisonRequest);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->jettison: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship symbol.
jettisonRequest JettisonRequest [optional]

Return type

Jettison200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jumpShip

JumpShip200Response jumpShip(shipSymbol, jumpShipRequest)

Jump Ship

Jump your ship instantly to a target connected waypoint. The ship must be in orbit to execute a jump. A 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

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship symbol.
final jumpShipRequest = JumpShipRequest(); // JumpShipRequest | 

try {
    final result = api_instance.jumpShip(shipSymbol, jumpShipRequest);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->jumpShip: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship symbol.
jumpShipRequest JumpShipRequest [optional]

Return type

JumpShip200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

navigateShip

NavigateShip200Response navigateShip(shipSymbol, navigateShipRequest)

Navigate Ship

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. The 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. To travel between systems, see the ship's Warp or Jump actions.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship symbol.
final navigateShipRequest = NavigateShipRequest(); // NavigateShipRequest | 

try {
    final result = api_instance.navigateShip(shipSymbol, navigateShipRequest);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->navigateShip: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship symbol.
navigateShipRequest NavigateShipRequest [optional]

Return type

NavigateShip200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

negotiateContract

NegotiateContract200Response negotiateContract(shipSymbol)

Negotiate Contract

Negotiate a new contract with the HQ. In 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. Once a contract is negotiated, it is added to the list of contracts offered to the agent, which the agent can then accept. The ship must be present at any waypoint with a faction present to negotiate a contract with that faction.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship's symbol.

try {
    final result = api_instance.negotiateContract(shipSymbol);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->negotiateContract: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship's symbol.

Return type

NegotiateContract200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orbitShip

OrbitShip200Response orbitShip(shipSymbol)

Orbit Ship

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. Orbiting 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. The endpoint is idempotent - successive calls will succeed even if the ship is already in orbit.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The symbol of the ship.

try {
    final result = api_instance.orbitShip(shipSymbol);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->orbitShip: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The symbol of the ship.

Return type

OrbitShip200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchShipNav

GetShipNav200Response patchShipNav(shipSymbol, patchShipNavRequest)

Patch Ship Nav

Update the nav configuration of a ship. Currently only supports configuring the Flight Mode of the ship, which affects its speed and fuel consumption.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship symbol.
final patchShipNavRequest = PatchShipNavRequest(); // PatchShipNavRequest | 

try {
    final result = api_instance.patchShipNav(shipSymbol, patchShipNavRequest);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->patchShipNav: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship symbol.
patchShipNavRequest PatchShipNavRequest [optional]

Return type

GetShipNav200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

purchaseCargo

PurchaseCargo201Response purchaseCargo(shipSymbol, purchaseCargoRequest)

Purchase Cargo

Purchase cargo from a market. The 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. The 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. Purchased goods are added to the ship's cargo hold.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship's symbol.
final purchaseCargoRequest = PurchaseCargoRequest(); // PurchaseCargoRequest | 

try {
    final result = api_instance.purchaseCargo(shipSymbol, purchaseCargoRequest);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->purchaseCargo: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship's symbol.
purchaseCargoRequest PurchaseCargoRequest [optional]

Return type

PurchaseCargo201Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

purchaseShip

PurchaseShip201Response purchaseShip(purchaseShipRequest)

Purchase Ship

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. Shipyards 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.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final purchaseShipRequest = PurchaseShipRequest(); // PurchaseShipRequest | 

try {
    final result = api_instance.purchaseShip(purchaseShipRequest);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->purchaseShip: $e\n');
}

Parameters

Name Type Description Notes
purchaseShipRequest PurchaseShipRequest [optional]

Return type

PurchaseShip201Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

refuelShip

RefuelShip200Response refuelShip(shipSymbol, refuelShipRequest)

Refuel Ship

Refuel your ship by buying fuel from the local market. Requires the ship to be docked in a waypoint that has the Marketplace trait, and the market must be selling fuel in order to refuel. Each fuel bought from the market replenishes 100 units in your ship's fuel. Ships will always be refuel to their frame's maximum fuel capacity when using this action.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship symbol.
final refuelShipRequest = RefuelShipRequest(); // RefuelShipRequest | 

try {
    final result = api_instance.refuelShip(shipSymbol, refuelShipRequest);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->refuelShip: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship symbol.
refuelShipRequest RefuelShipRequest [optional]

Return type

RefuelShip200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

removeMount

RemoveMount201Response removeMount(shipSymbol, removeMountRequest)

Remove Mount

Remove a mount from a ship. The ship must be docked in a waypoint that has the Shipyard trait, and must have the desired mount that it wish to remove installed. A removal fee will be deduced from the agent by the Shipyard.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship's symbol.
final removeMountRequest = RemoveMountRequest(); // RemoveMountRequest | 

try {
    final result = api_instance.removeMount(shipSymbol, removeMountRequest);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->removeMount: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship's symbol.
removeMountRequest RemoveMountRequest [optional]

Return type

RemoveMount201Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repairShip

RepairShip200Response repairShip(shipSymbol)

Repair Ship

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.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship symbol.

try {
    final result = api_instance.repairShip(shipSymbol);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->repairShip: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship symbol.

Return type

RepairShip200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

scrapShip

ScrapShip200Response scrapShip(shipSymbol)

Scrap Ship

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.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship symbol.

try {
    final result = api_instance.scrapShip(shipSymbol);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->scrapShip: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship symbol.

Return type

ScrapShip200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sellCargo

SellCargo201Response sellCargo(shipSymbol, sellCargoRequest)

Sell Cargo

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.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | Symbol of a ship.
final sellCargoRequest = SellCargoRequest(); // SellCargoRequest | 

try {
    final result = api_instance.sellCargo(shipSymbol, sellCargoRequest);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->sellCargo: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String Symbol of a ship.
sellCargoRequest SellCargoRequest [optional]

Return type

SellCargo201Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

shipRefine

ShipRefine201Response shipRefine(shipSymbol, shipRefineRequest)

Ship Refine

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. When refining, 30 basic goods will be converted into 10 processed goods.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The symbol of the ship.
final shipRefineRequest = ShipRefineRequest(); // ShipRefineRequest | 

try {
    final result = api_instance.shipRefine(shipSymbol, shipRefineRequest);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->shipRefine: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The symbol of the ship.
shipRefineRequest ShipRefineRequest [optional]

Return type

ShipRefine201Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

siphonResources

SiphonResources201Response siphonResources(shipSymbol)

Siphon Resources

Siphon gases, such as hydrocarbon, from gas giants. The ship must be in orbit to be able to siphon and must have siphon mounts and a gas processor installed.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship symbol.

try {
    final result = api_instance.siphonResources(shipSymbol);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->siphonResources: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship symbol.

Return type

SiphonResources201Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

transferCargo

TransferCargo200Response transferCargo(shipSymbol, transferCargoRequest)

Transfer Cargo

Transfer cargo between ships. The 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. The response body's cargo shows the cargo of the transferring ship after the transfer is complete.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The transferring ship's symbol.
final transferCargoRequest = TransferCargoRequest(); // TransferCargoRequest | 

try {
    final result = api_instance.transferCargo(shipSymbol, transferCargoRequest);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->transferCargo: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The transferring ship's symbol.
transferCargoRequest TransferCargoRequest [optional]

Return type

TransferCargo200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

warpShip

WarpShip200Response warpShip(shipSymbol, navigateShipRequest)

Warp Ship

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. The 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.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: AgentToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('AgentToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FleetApi();
final shipSymbol = shipSymbol_example; // String | The ship symbol.
final navigateShipRequest = NavigateShipRequest(); // NavigateShipRequest | 

try {
    final result = api_instance.warpShip(shipSymbol, navigateShipRequest);
    print(result);
} catch (e) {
    print('Exception when calling FleetApi->warpShip: $e\n');
}

Parameters

Name Type Description Notes
shipSymbol String The ship symbol.
navigateShipRequest NavigateShipRequest [optional]

Return type

WarpShip200Response

Authorization

AgentToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]