Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

client

package

Go to main page

Versions in this module

v1

v1.1.0

Nov 19, 2025

v1.0.1

Oct 30, 2024

v1.0.0

Jun 12, 2024

Changes in this version

+ var ErrTooManyOptions = errors.New("too many options")

+ type APIClient struct

+ Activities ActivitiesAPI

+ Athletes AthletesAPI

+ Clubs ClubsAPI

+ Gears GearsAPI

+ Routes RoutesAPI

+ SegmentEfforts SegmentEffortsAPI

+ Segments SegmentsAPI

+ Streams StreamsAPI

+ Uploads UploadsAPI

+ func NewAPIClient(token string) (*APIClient, error)

+ type ActivitiesAPI interface

+ CreateActivity func(ctx context.Context, name string, activityType string, sportType string, ...) (models.DetailedActivity, error)

+ GetActivityById func(ctx context.Context, id int64, opts ...GetActivityByIdOpts) (models.DetailedActivity, error)

+ GetCommentsByActivityId func(ctx context.Context, id int64, opts ...GetCommentsByActivityIdOpts) ([]models.Comment, error)

+ GetKudoersByActivityId func(ctx context.Context, id int64, opts ...GetKudoersByActivityIdOpts) ([]models.SummaryAthlete, error)

+ GetLapsByActivityId func(ctx context.Context, id int64) ([]models.Lap, error)

+ GetLoggedInAthleteActivities func(ctx context.Context, opts ...GetLoggedInAthleteActivitiesOpts) ([]models.SummaryActivity, error)

+ GetZonesByActivityId func(ctx context.Context, id int64) ([]models.ActivityZone, error)

+ UpdateActivityById func(ctx context.Context, id int64, opts ...UpdateActivityByIdOpts) (models.DetailedActivity, error)

+ type AthletesAPI interface

+ GetLoggedInAthlete func(ctx context.Context) (models.DetailedAthlete, error)

+ GetLoggedInAthleteZones func(ctx context.Context) (models.Zones, error)

+ GetStats func(ctx context.Context, id int64) (models.ActivityStats, error)

+ UpdateLoggedInAthlete func(ctx context.Context, weight float32) (models.DetailedAthlete, error)

+ type ClubsAPI interface

+ GetClubActivitiesById func(ctx context.Context, id int64, opts ...GetClubActivitiesByIdOpts) ([]models.ClubActivity, error)

+ GetClubAdminsById func(ctx context.Context, id int64, opts ...GetClubAdminsByIdOpts) ([]models.SummaryAthlete, error)

+ GetClubById func(ctx context.Context, id int64) (models.DetailedClub, error)

+ GetClubMembersById func(ctx context.Context, id int64, opts ...GetClubMembersByIdOpts) ([]models.ClubAthlete, error)

+ GetLoggedInAthleteClubs func(ctx context.Context, opts ...GetLoggedInAthleteClubsOpts) ([]models.SummaryClub, error)

+ type CreateUploadParams struct

+ Commute *string

+ DataType *string

+ Description *string

+ ExternalId *string

+ File io.Reader

+ Name *string

+ Trainer *string

+ type ExploreSegmentsOpts struct

+ ActivityType *string

+ MaxCat *int32

+ MinCat *int32

+ type GearsAPI interface

+ GetGearById func(ctx context.Context, id string) (models.DetailedGear, error)

+ type GetActivityByIdOpts struct

+ IncludeAllEfforts *bool

+ type GetClubActivitiesByIdOpts struct

+ Page *int32

+ PerPage *int32

+ type GetClubAdminsByIdOpts struct

+ Page *int32

+ PerPage *int32

+ type GetClubMembersByIdOpts struct

+ Page *int32

+ PerPage *int32

+ type GetCommentsByActivityIdOpts struct

+ AfterCursor *string

+ Page *int32

+ PageSize *int32

+ PerPage *int32

+ type GetEffortsBySegmentIdOpts struct

+ EndDateLocal *time.Time

+ PerPage *int32

+ StartDateLocal *time.Time

+ type GetKudoersByActivityIdOpts struct

+ Page *int32

+ PerPage *int32

+ type GetLoggedInAthleteActivitiesOpts struct

+ After *int64

+ Before *int64

+ Page *int32

+ PerPage *int32

+ type GetLoggedInAthleteClubsOpts struct

+ Page *int32

+ PerPage *int32

+ type GetLoggedInAthleteStarredSegmentsOpts struct

+ Page *int32

+ PerPage *int32

+ type GetRoutesByAthleteIdOpts struct

+ Page *int32

+ PerPage *int32

+ type RoutesAPI interface

+ GetRouteAsGPX func(ctx context.Context, id int64) error

+ GetRouteAsTCX func(ctx context.Context, id int64) error

+ GetRouteById func(ctx context.Context, id int64) (models.Route, error)

+ GetRoutesByAthleteId func(ctx context.Context, opts ...GetRoutesByAthleteIdOpts) ([]models.Route, error)

+ type SegmentEffortsAPI interface

+ GetEffortsBySegmentId func(ctx context.Context, segmentId int32, opts ...GetEffortsBySegmentIdOpts) ([]models.DetailedSegmentEffort, error)

+ GetSegmentEffortById func(ctx context.Context, id int64) (models.DetailedSegmentEffort, error)

+ type SegmentsAPI interface

+ ExploreSegments func(ctx context.Context, bounds []float32, opts ...ExploreSegmentsOpts) (models.ExplorerResponse, error)

+ GetLoggedInAthleteStarredSegments func(ctx context.Context, opts ...GetLoggedInAthleteStarredSegmentsOpts) ([]models.SummarySegment, error)

+ GetSegmentById func(ctx context.Context, id int64) (models.DetailedSegment, error)

+ StarSegment func(ctx context.Context, starred bool, id int64) (models.DetailedSegment, error)

+ type StreamsAPI interface

+ GetActivityStreams func(ctx context.Context, id int64, keys []string, keyByType bool) (models.StreamSet, error)

+ GetRouteStreams func(ctx context.Context, id int64) (models.StreamSet, error)

+ GetSegmentEffortStreams func(ctx context.Context, id int64, keys []string, keyByType bool) (models.StreamSet, error)

+ GetSegmentStreams func(ctx context.Context, id int64, keys []string, keyByType bool) (models.StreamSet, error)

+ type UpdateActivityByIdOpts struct

+ Body *models.UpdatableActivity

+ type UploadsAPI interface

+ CreateUpload func(ctx context.Context, opts ...CreateUploadParams) (models.Upload, error)

+ GetUploadById func(ctx context.Context, uploadId int64) (models.Upload, error)