spacetraders/docs/FactionsApi.md

\FactionsApi

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

Method	HTTP request	Description
GetFaction	Get /factions/{factionSymbol}	Get Faction
GetFactions	Get /factions	List Factions

GetFaction

GetFaction200Response GetFaction(ctx, factionSymbol).Execute()

Get Faction

Example

package main

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

func main() {
    factionSymbol := "factionSymbol_example" // string | The faction symbol (default to "CGR")

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
factionSymbol	string	The faction symbol	[default to "CGR"]

Other Parameters

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

Name	Type	Description	Notes

Return type

GetFaction200Response

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]

GetFactions

GetFactions200Response GetFactions(ctx).Page(page).Limit(limit).Execute()

List Factions

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.FactionsApi.GetFactions(context.Background()).Page(page).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FactionsApi.GetFactions``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetFactions`: GetFactions200Response
    fmt.Fprintf(os.Stdout, "Response from `FactionsApi.GetFactions`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetFactionsRequest 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

GetFactions200Response

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]