Versions in this module Expand all Collapse all v1 v1.3.0 Jun 2, 2026 Changes in this version + var ErrForbidden = errors.New("forbidden") + var ErrMaintenance = errors.New("service under maintenance") v1.2.0 May 28, 2026 Changes in this version type UserProfile + Info ProfileInfo v1.1.0 May 28, 2026 Changes in this version + type CategoryInfo struct + Name string + Slug string + type CelestialObjectInfo struct + AffiliationID string + AffiliationName string + AggregatedDanger string + AggregatedSize string + ArrivalPoint int + AxialTilt float64 + Code string + Danger int + Description string + Designation string + Economy int + Fairchanceact bool + Habitable int + ID string + Latitude float64 + Longitude float64 + Name string + Population int + Raw map[string]any + SensorDanger int + SensorEconomy int + SensorPopulation int + Size string + SubType []SubType + Thumbnail Thumbnail + TimestampAdded string + TimestampModified string + Type string + type DeliverableInfo struct + Category CategoryInfo + Description string + Disciplines []DisciplineInfo + EndDate string + NumberOfDisciplines int + Raw map[string]any + Slug string + StartDate string + Thumbnail string + Title string + UUID string + UpdateDate string + type DisciplineInfo struct + EndDate string + Raw map[string]any + StartDate string + Thumbnail string + Title string + UUID string + type Position struct + X float64 + Y float64 + Z float64 + type ProgressTrackerTeam struct + Abbreviation string + Description string + EndDate string + NumberOfMembers int + Raw map[string]any + StartDate string + Thumbnail string + TimeAllocations []TimeAllocation + Title string + UUID string type ShipData + Beam float64 + Cargo float64 + ChassisID int + Classification string + Focus string + Height float64 + Length float64 + ManufacturerCode string + ManufacturerID int + ManufacturerName string + Mass float64 + MaxCrew int + MinCrew int + ProductionStatus string + Raw map[string]any + StoreURL string + type StarmapAffiliationData struct + Code string + Color string + ID string + Membership int + Name string + Raw map[string]any + TimestampAdded string + TimestampModified string + type StarmapSpeciesData struct + Code string + Description string + ID string + Name string + Raw map[string]any + TimestampAdded string + TimestampModified string + type StarmapSystem struct + AffiliationID string + AffiliationName string + AggregatedDanger string + AggregatedSize string + Celestial []CelestialObjectInfo + Code string + Description string + Frost string + ID string + Name string + Position Position + Raw map[string]any + Status string + Thumbnail Thumbnail + TimestampAdded string + TimestampModified string + Type string + type StarmapTunnel struct + Direction string + Entry TunnelPoint + Exit TunnelPoint + ID string + Name string + Raw map[string]any + Size string + Status string + TimestampAdded string + TimestampModified string + type SubType struct + ID string + Name string + Type string + type Thumbnail struct + Source string + Tags string + type TimeAllocation struct + Deliverable DeliverableInfo + EndDate string + PartialTime int + Raw map[string]any + StartDate string + TotalDays int + TotalWorkingDays int + UUID string + type TunnelPoint struct + CelestialID string + CelestialName string + StarSystemID string + StarSystemName string v1.0.0 May 28, 2026 Changes in this version + const BaseURL + const DefaultTimeout + var ErrEmptyResponse = errors.New("empty response") + var ErrInvalidResponse = errors.New("invalid response format") + var ErrNotFound = errors.New("resource not found") + var ErrThrottled = errors.New("API throttled") + var ErrUnauthorized = errors.New("unauthorized") + func ConvertVal(val any, target string) any + func HTTPFormatter(val any) string + func RangeFormatter(min, max any) string + type Client struct + func NewClient() *Client + func NewClientWithConnector(conn *Connector) *Client + func NewClientWithTimeout(timeout time.Duration) *Client + func (c *Client) GetOrganization(ctx context.Context, sid string) (*OrganizationData, error) + func (c *Client) GetOrganizationMembers(ctx context.Context, sid string, page int, options map[string]any) ([]OrganizationMember, error) + func (c *Client) GetPatchNotes(ctx context.Context) ([]PatchNote, error) + func (c *Client) GetProgressTrackerInfo(ctx context.Context, teamSlug, dateMin, dateMax string) ([]map[string]any, error) + func (c *Client) GetProgressTrackerTeams(ctx context.Context, dateMin, dateMax string) ([]map[string]any, error) + func (c *Client) GetRoadmap(ctx context.Context, board, version string) ([]RoadmapRelease, error) + func (c *Client) GetStarmapAffiliations(ctx context.Context, name string) ([]map[string]any, error) + func (c *Client) GetStarmapCelestialObject(ctx context.Context, code string) ([]map[string]any, error) + func (c *Client) GetStarmapSpecies(ctx context.Context, name string) ([]map[string]any, error) + func (c *Client) GetStarmapStarSystem(ctx context.Context, code string) ([]map[string]any, error) + func (c *Client) GetStarmapSystems(ctx context.Context, name string) ([]map[string]any, error) + func (c *Client) GetStarmapTunnels(ctx context.Context, tid string) ([]map[string]any, error) + func (c *Client) GetStats(ctx context.Context) (*StatsData, error) + func (c *Client) GetTelemetry(ctx context.Context, timetable, version string) (map[string]any, error) + func (c *Client) GetUser(ctx context.Context, handle string) (*UserProfile, error) + func (c *Client) SearchShips(ctx context.Context, options map[string]any) ([]map[string]any, error) + func (c *Client) SearchStarmap(ctx context.Context, query string) (*StarmapSearchResult, error) + func (c *Client) SearchStarmapRoute(ctx context.Context, from, to, shipSize string) (*StarmapRouteResult, error) + type Command interface + Execute func(ctx context.Context) (any, error) + type Connector struct + func NewConnector() *Connector + func NewConnectorWithClient(client *http.Client) *Connector + func (c *Connector) Client() *http.Client + func (c *Connector) ConvertPath(path string) string + func (c *Connector) Get(ctx context.Context, path string, headers map[string]string) (*http.Response, error) + func (c *Connector) Post(ctx context.Context, path string, body any, headers map[string]string) (*http.Response, error) + func (c *Connector) Request(ctx context.Context, method, path string, body any, headers map[string]string) (*http.Response, error) + type FocusInfo struct + Image string + Name string + type HTTPError struct + Status string + StatusCode int + URL string + func (e *HTTPError) Error() string + type Organization struct + func NewOrganization(sid string) *Organization + func (o *Organization) Execute(ctx context.Context) (*OrganizationData, error) + type OrganizationData struct + Archetype string + Banner string + Charter TextContent + Commitment string + Focus OrganizationFocus + Headline TextContent + History TextContent + Href string + Lang string + Logo string + Manifesto TextContent + Members int + Name string + Recruiting bool + Roleplay bool + SID string + URL string + type OrganizationFocus struct + Primary FocusInfo + Secondary FocusInfo + type OrganizationInfo struct + Image string + Name string + Rank string + SID string + Stars int + type OrganizationMember struct + Display string + Handle string + Image string + Rank string + Roles []string + Stars int + type OrganizationMembers struct + func NewOrganizationMembers(sid string, page int, options map[string]any) *OrganizationMembers + func (om *OrganizationMembers) Execute(ctx context.Context) ([]OrganizationMember, error) + type PageInfo struct + Title string + URL string + type ParseError struct + Err error + Field string + Source string + func (e *ParseError) Error() string + func (e *ParseError) Unwrap() error + type PatchNote struct + Image string + Link string + Title string + Version string + type ProfileInfo struct + Badge string + BadgeImage string + Bio string + Display string + Enlisted string + Fluency []string + Handle string + ID string + Image string + Location map[string]string + Page PageInfo + Website string + type ProgressTracker struct + func NewProgressTracker(dateMin, dateMax string) *ProgressTracker + func (p *ProgressTracker) Execute(ctx context.Context) ([]map[string]any, error) + type ProgressTrackerInfo struct + func NewProgressTrackerInfo(slug, dateMin, dateMax string) *ProgressTrackerInfo + func (p *ProgressTrackerInfo) Execute(ctx context.Context) ([]map[string]any, error) + type Roadmap struct + func NewRoadmap(board string, version string) *Roadmap + func (r *Roadmap) Execute(ctx context.Context) ([]RoadmapRelease, error) + type RoadmapCard struct + CategoryID int + CategoryName string + Description string + ID int + Name string + type RoadmapCategory struct + ID int + Name string + type RoadmapRelease struct + Cards []RoadmapCard + Description string + ID int + Name string + type Ship struct + func NewShip(options map[string]any) *Ship + func (s *Ship) Execute(ctx context.Context) ([]map[string]any, error) + type ShipData struct + ID int + Name string + Price float64 + URL string + type StarmapAffiliations struct + func NewStarmapAffiliations(name string) *StarmapAffiliations + func (a *StarmapAffiliations) Execute(ctx context.Context) ([]map[string]any, error) + type StarmapCelestialObjects struct + func NewStarmapCelestialObjects(code string) *StarmapCelestialObjects + func (c *StarmapCelestialObjects) Execute(ctx context.Context) ([]map[string]any, error) + type StarmapRouteResult struct + LeastJumps any + Shortest any + type StarmapRouteSearch struct + func NewStarmapRouteSearch(from, to, shipSize string) *StarmapRouteSearch + func (r *StarmapRouteSearch) Execute(ctx context.Context) (*StarmapRouteResult, error) + type StarmapSearch struct + func NewStarmapSearch(search string) *StarmapSearch + func (s *StarmapSearch) Execute(ctx context.Context) (*StarmapSearchResult, error) + type StarmapSearchResult struct + Objects []map[string]any + Systems []map[string]any + type StarmapSpecies struct + func NewStarmapSpecies(name string) *StarmapSpecies + func (s *StarmapSpecies) Execute(ctx context.Context) ([]map[string]any, error) + type StarmapStarSystems struct + func NewStarmapStarSystems(code string) *StarmapStarSystems + func (s *StarmapStarSystems) Execute(ctx context.Context) ([]map[string]any, error) + type StarmapSystems struct + func NewStarmapSystems(name string) *StarmapSystems + func (s *StarmapSystems) Execute(ctx context.Context) ([]map[string]any, error) + type StarmapTunnels struct + func NewStarmapTunnels(tid string) *StarmapTunnels + func (t *StarmapTunnels) Execute(ctx context.Context) ([]map[string]any, error) + type Stats struct + func NewStats() *Stats + func (s *Stats) Execute(ctx context.Context) (*StatsData, error) + type StatsData struct + CurrentETF *string + CurrentLive *string + CurrentPTU *string + Fans int + Fleet *int + Funds float64 + type Telemetry struct + func NewTelemetry(timetable, version string) *Telemetry + func (t *Telemetry) Execute(ctx context.Context) (map[string]any, error) + type TextContent struct + HTML string + Plaintext string + type User struct + func NewUser(userHandle string) *User + func (u *User) Execute(ctx context.Context) (*UserProfile, error) + type UserAffiliationInfo struct + Image string + Name string + Rank string + SID string + Stars int + type UserProfile struct + Affiliation []UserAffiliationInfo + Organization OrganizationInfo + Profile ProfileInfo + type VersionInfo struct + func NewVersionInfo() *VersionInfo + func (v *VersionInfo) Execute(ctx context.Context) ([]PatchNote, error)