DefaultAPI.md

\DefaultAPI

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

Method	HTTP request	Description
GetStatus	Get /	Get Status
Register	Post /register	Register New Agent

GetStatus

GetStatus200Response GetStatus(ctx).Execute()

Get Status

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/UnseenBook/spacetraders-go-sdk"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

GetStatus200Response

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]

Register

Register201Response Register(ctx).RegisterRequest(registerRequest).Execute()

Register New Agent

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/UnseenBook/spacetraders-go-sdk"
)

func main() {
	registerRequest := *openapiclient.NewRegisterRequest(openapiclient.FactionSymbol("COSMIC"), "BADGER") // RegisterRequest |  (optional)

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
registerRequest	RegisterRequest

Return type

Register201Response

Authorization

No authorization required

HTTP request headers

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

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