46 KiB

Raw Blame History

\FleetApi

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
GetMyShip	Get /my/ships/{shipSymbol}	Get Ship
GetMyShipCargo	Get /my/ships/{shipSymbol}/cargo	Get Ship Cargo
GetMyShips	Get /my/ships	List Ships
GetShipCooldown	Get /my/ships/{shipSymbol}/cooldown	Get Ship Cooldown
GetShipNav	Get /my/ships/{shipSymbol}/nav	Get Ship Nav
Jettison	Post /my/ships/{shipSymbol}/jettison	Jettison Cargo
JumpShip	Post /my/ships/{shipSymbol}/jump	Jump Ship
NavigateShip	Post /my/ships/{shipSymbol}/navigate	Navigate Ship
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
SellCargo	Post /my/ships/{shipSymbol}/sell	Sell Cargo
ShipRefine	Post /my/ships/{shipSymbol}/refine	Ship Refine
TransferCargo	Post /my/ships/{shipSymbol}/transfer	Transfer Cargo
WarpShip	Post /my/ships/{shipSymbol}/warp	Warp Ship

CreateChart

CreateChart201Response CreateChart(ctx, shipSymbol).Execute()

Create Chart

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | The symbol of the ship

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.CreateChart(context.Background(), shipSymbol).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.CreateChart``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateChart`: CreateChart201Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.CreateChart`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string	The symbol of the ship

Other Parameters

Other parameters are passed through a pointer to a apiCreateChartRequest struct via the builder pattern

Name	Type	Description	Notes

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(ctx, shipSymbol).Execute()

Scan Ships

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.CreateShipShipScan(context.Background(), shipSymbol).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.CreateShipShipScan``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateShipShipScan`: CreateShipShipScan201Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.CreateShipShipScan`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string

Other Parameters

Other parameters are passed through a pointer to a apiCreateShipShipScanRequest struct via the builder pattern

Name	Type	Description	Notes

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(ctx, shipSymbol).Execute()

Scan Systems

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.CreateShipSystemScan(context.Background(), shipSymbol).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.CreateShipSystemScan``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateShipSystemScan`: CreateShipSystemScan201Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.CreateShipSystemScan`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string

Other Parameters

Other parameters are passed through a pointer to a apiCreateShipSystemScanRequest struct via the builder pattern

Name	Type	Description	Notes

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(ctx, shipSymbol).Execute()

Scan Waypoints

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.CreateShipWaypointScan(context.Background(), shipSymbol).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.CreateShipWaypointScan``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateShipWaypointScan`: CreateShipWaypointScan201Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.CreateShipWaypointScan`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string

Other Parameters

Other parameters are passed through a pointer to a apiCreateShipWaypointScanRequest struct via the builder pattern

Name	Type	Description	Notes

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(ctx, shipSymbol).Execute()

Create Survey

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | The symbol of the ship

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.CreateSurvey(context.Background(), shipSymbol).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.CreateSurvey``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateSurvey`: CreateSurvey201Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.CreateSurvey`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string	The symbol of the ship

Other Parameters

Other parameters are passed through a pointer to a apiCreateSurveyRequest struct via the builder pattern

Name	Type	Description	Notes

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(ctx, shipSymbol).Execute()

Dock Ship

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | The symbol of the ship

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.DockShip(context.Background(), shipSymbol).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.DockShip``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DockShip`: DockShip200Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.DockShip`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string	The symbol of the ship

Other Parameters

Other parameters are passed through a pointer to a apiDockShipRequest struct via the builder pattern

Name	Type	Description	Notes

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(ctx, shipSymbol).ExtractResourcesRequest(extractResourcesRequest).Execute()

Extract Resources

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | The ship symbol
    extractResourcesRequest := *openapiclient.NewExtractResourcesRequest() // ExtractResourcesRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.ExtractResources(context.Background(), shipSymbol).ExtractResourcesRequest(extractResourcesRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.ExtractResources``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ExtractResources`: ExtractResources201Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.ExtractResources`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string	The ship symbol

Other Parameters

Other parameters are passed through a pointer to a apiExtractResourcesRequest struct via the builder pattern

Name	Type	Description	Notes

extractResourcesRequest | ExtractResourcesRequest | |

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]

GetMyShip

GetMyShip200Response GetMyShip(ctx, shipSymbol).Execute()

Get Ship

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.GetMyShip(context.Background(), shipSymbol).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.GetMyShip``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetMyShip`: GetMyShip200Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.GetMyShip`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string

Other Parameters

Other parameters are passed through a pointer to a apiGetMyShipRequest struct via the builder pattern

Name	Type	Description	Notes

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(ctx, shipSymbol).Execute()

Get Ship Cargo

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | The symbol of the ship

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.GetMyShipCargo(context.Background(), shipSymbol).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.GetMyShipCargo``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetMyShipCargo`: GetMyShipCargo200Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.GetMyShipCargo`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string	The symbol of the ship

Other Parameters

Other parameters are passed through a pointer to a apiGetMyShipCargoRequest struct via the builder pattern

Name	Type	Description	Notes

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(ctx).Page(page).Limit(limit).Execute()

List Ships

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    page := int32(56) // int32 | What entry offset to request (optional)
    limit := int32(56) // int32 | How many entries to return per page (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.GetMyShips(context.Background()).Page(page).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.GetMyShips``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetMyShips`: GetMyShips200Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.GetMyShips`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetMyShipsRequest struct via the builder pattern

Name	Type	Description	Notes
page	int32	What entry offset to request
limit	int32	How many entries to return per page

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]

GetShipCooldown

GetShipCooldown200Response GetShipCooldown(ctx, shipSymbol).Execute()

Get Ship Cooldown

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.GetShipCooldown(context.Background(), shipSymbol).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.GetShipCooldown``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetShipCooldown`: GetShipCooldown200Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.GetShipCooldown`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string

Other Parameters

Other parameters are passed through a pointer to a apiGetShipCooldownRequest struct via the builder pattern

Name	Type	Description	Notes

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(ctx, shipSymbol).Execute()

Get Ship Nav

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | The ship symbol

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.GetShipNav(context.Background(), shipSymbol).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.GetShipNav``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetShipNav`: GetShipNav200Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.GetShipNav`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string	The ship symbol

Other Parameters

Other parameters are passed through a pointer to a apiGetShipNavRequest struct via the builder pattern

Name	Type	Description	Notes

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]

Jettison

Jettison200Response Jettison(ctx, shipSymbol).JettisonRequest(jettisonRequest).Execute()

Jettison Cargo

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | 
    jettisonRequest := *openapiclient.NewJettisonRequest("Symbol_example", int32(123)) // JettisonRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.Jettison(context.Background(), shipSymbol).JettisonRequest(jettisonRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.Jettison``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `Jettison`: Jettison200Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.Jettison`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string

Other Parameters

Other parameters are passed through a pointer to a apiJettisonRequest struct via the builder pattern

Name	Type	Description	Notes

jettisonRequest | JettisonRequest | |

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(ctx, shipSymbol).JumpShipRequest(jumpShipRequest).Execute()

Jump Ship

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | 
    jumpShipRequest := *openapiclient.NewJumpShipRequest("SystemSymbol_example") // JumpShipRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.JumpShip(context.Background(), shipSymbol).JumpShipRequest(jumpShipRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.JumpShip``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `JumpShip`: JumpShip200Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.JumpShip`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string

Other Parameters

Other parameters are passed through a pointer to a apiJumpShipRequest struct via the builder pattern

Name	Type	Description	Notes

jumpShipRequest | JumpShipRequest | |

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(ctx, shipSymbol).NavigateShipRequest(navigateShipRequest).Execute()

Navigate Ship

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | The ship symbol
    navigateShipRequest := *openapiclient.NewNavigateShipRequest("WaypointSymbol_example") // NavigateShipRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.NavigateShip(context.Background(), shipSymbol).NavigateShipRequest(navigateShipRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.NavigateShip``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `NavigateShip`: NavigateShip200Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.NavigateShip`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string	The ship symbol

Other Parameters

Other parameters are passed through a pointer to a apiNavigateShipRequest struct via the builder pattern

Name	Type	Description	Notes

navigateShipRequest | NavigateShipRequest | |

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]

OrbitShip

OrbitShip200Response OrbitShip(ctx, shipSymbol).Execute()

Orbit Ship

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | The symbol of the ship

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.OrbitShip(context.Background(), shipSymbol).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.OrbitShip``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `OrbitShip`: OrbitShip200Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.OrbitShip`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string	The symbol of the ship

Other Parameters

Other parameters are passed through a pointer to a apiOrbitShipRequest struct via the builder pattern

Name	Type	Description	Notes

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(ctx, shipSymbol).PatchShipNavRequest(patchShipNavRequest).Execute()

Patch Ship Nav

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | The ship symbol
    patchShipNavRequest := *openapiclient.NewPatchShipNavRequest() // PatchShipNavRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.PatchShipNav(context.Background(), shipSymbol).PatchShipNavRequest(patchShipNavRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.PatchShipNav``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PatchShipNav`: GetShipNav200Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.PatchShipNav`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string	The ship symbol

Other Parameters

Other parameters are passed through a pointer to a apiPatchShipNavRequest struct via the builder pattern

Name	Type	Description	Notes

patchShipNavRequest | PatchShipNavRequest | |

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(ctx, shipSymbol).PurchaseCargoRequest(purchaseCargoRequest).Execute()

Purchase Cargo

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | 
    purchaseCargoRequest := *openapiclient.NewPurchaseCargoRequest("Symbol_example", int32(123)) // PurchaseCargoRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.PurchaseCargo(context.Background(), shipSymbol).PurchaseCargoRequest(purchaseCargoRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.PurchaseCargo``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PurchaseCargo`: PurchaseCargo201Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.PurchaseCargo`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string

Other Parameters

Other parameters are passed through a pointer to a apiPurchaseCargoRequest struct via the builder pattern

Name	Type	Description	Notes

purchaseCargoRequest | PurchaseCargoRequest | |

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(ctx).PurchaseShipRequest(purchaseShipRequest).Execute()

Purchase Ship

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    purchaseShipRequest := *openapiclient.NewPurchaseShipRequest(openapiclient.ShipType("SHIP_PROBE"), "WaypointSymbol_example") // PurchaseShipRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.PurchaseShip(context.Background()).PurchaseShipRequest(purchaseShipRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.PurchaseShip``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PurchaseShip`: PurchaseShip201Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.PurchaseShip`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPurchaseShipRequest struct via the builder pattern

Name	Type	Description	Notes
purchaseShipRequest	PurchaseShipRequest

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(ctx, shipSymbol).Execute()

Refuel Ship

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.RefuelShip(context.Background(), shipSymbol).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.RefuelShip``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RefuelShip`: RefuelShip200Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.RefuelShip`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string

Other Parameters

Other parameters are passed through a pointer to a apiRefuelShipRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

RefuelShip200Response

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(ctx, shipSymbol).SellCargoRequest(sellCargoRequest).Execute()

Sell Cargo

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | 
    sellCargoRequest := *openapiclient.NewSellCargoRequest("Symbol_example", int32(123)) // SellCargoRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.SellCargo(context.Background(), shipSymbol).SellCargoRequest(sellCargoRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.SellCargo``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SellCargo`: SellCargo201Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.SellCargo`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string

Other Parameters

Other parameters are passed through a pointer to a apiSellCargoRequest struct via the builder pattern

Name	Type	Description	Notes

sellCargoRequest | SellCargoRequest | |

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

ShipRefine200Response ShipRefine(ctx, shipSymbol).ShipRefineRequest(shipRefineRequest).Execute()

Ship Refine

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | The symbol of the ship
    shipRefineRequest := *openapiclient.NewShipRefineRequest("Produce_example") // ShipRefineRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.ShipRefine(context.Background(), shipSymbol).ShipRefineRequest(shipRefineRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.ShipRefine``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ShipRefine`: ShipRefine200Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.ShipRefine`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string	The symbol of the ship

Other Parameters

Other parameters are passed through a pointer to a apiShipRefineRequest struct via the builder pattern

Name	Type	Description	Notes

shipRefineRequest | ShipRefineRequest | |

Return type

ShipRefine200Response

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]

TransferCargo

TransferCargo200Response TransferCargo(ctx, shipSymbol).TransferCargoRequest(transferCargoRequest).Execute()

Transfer Cargo

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | 
    transferCargoRequest := *openapiclient.NewTransferCargoRequest("TradeSymbol_example", int32(123), "ShipSymbol_example") // TransferCargoRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.TransferCargo(context.Background(), shipSymbol).TransferCargoRequest(transferCargoRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.TransferCargo``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `TransferCargo`: TransferCargo200Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.TransferCargo`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string

Other Parameters

Other parameters are passed through a pointer to a apiTransferCargoRequest struct via the builder pattern

Name	Type	Description	Notes

transferCargoRequest | TransferCargoRequest | |

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

NavigateShip200Response WarpShip(ctx, shipSymbol).NavigateShipRequest(navigateShipRequest).Execute()

Warp Ship

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    shipSymbol := "shipSymbol_example" // string | 
    navigateShipRequest := *openapiclient.NewNavigateShipRequest("WaypointSymbol_example") // NavigateShipRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FleetApi.WarpShip(context.Background(), shipSymbol).NavigateShipRequest(navigateShipRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FleetApi.WarpShip``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `WarpShip`: NavigateShip200Response
    fmt.Fprintf(os.Stdout, "Response from `FleetApi.WarpShip`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
shipSymbol	string

Other Parameters

Other parameters are passed through a pointer to a apiWarpShipRequest struct via the builder pattern

Name	Type	Description	Notes

navigateShipRequest | NavigateShipRequest | |

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]

46 KiB Raw Blame History

\FleetApi

CreateChart

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateShipShipScan

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateShipSystemScan

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateShipWaypointScan

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateSurvey

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DockShip

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ExtractResources

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetMyShip

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetMyShipCargo

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetMyShips

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetShipCooldown

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetShipNav

46 KiB

Raw Blame History