Strive

A Haskell client for the Strava V3 API.

• Installation
• Usage
  • Authentication
    • Request access
    • Token exchange
    • Deauthorization
  • Athletes
    • Retrieve current athlete
    • Retrieve another athlete
    • Update current athlete
    • List athlete K/QOMs/CRs
  • Friends and followers
    • List athlete friends
    • List athlete followers
    • List both following
  • Activities
    • Create an activity
    • Retrieve an activity
    • Update an activity
    • Delete an activity
    • List athlete activities
    • List friends' activities
    • List activity zones
    • List activity laps
  • Comments
    • List activity comments
  • Kudos
    • List activity kudoers
  • Photos
    • List activity photos
  • Clubs
    • Retrieve a club
    • List athlete clubs
    • List club members
    • List club activities
  • Gear
    • Retrieve gear
  • Segments
    • Retrieve a segment
    • List starred segments
    • List efforts
    • Segment leaderboard
    • Segment explorer
  • Segment efforts
    • Retrieve a segment effort
  • Streams
    • Retrieve activity streams
    • Retrieve effort streams
    • Retrieve segment streams
  • Uploads
    • Upload an activity
    • Check upload status

Installation

Add it to your Cabal file:

library
  build-depends:
    strive ==0.6.*

Or install it manually:

$ cabal update
$ cabal install strive

This package uses Semantic Versioning.

Usage

To use the API, you'll need an access token. Once you have that, create a new client using the default HTTP manager.

import Strive
let token = "a token"
client <- buildClient token

Most types implement lenses for their fields. Lenses are preferred over directly accessing the fields. For instance, instead of doing this:

client_accessToken (client { client_accessToken = "record token" })
-- "record token"

Do this:

get accessToken (set accessToken "lens token" client)
-- "lens token"

Authentication

Request access

  let authorizeUrl = buildAuthorizeUrl 1790 "http://localhost" $ with
        [ set approvalPrompt False
        , set privateScope True
        , set writeScope True
        , set state "..."
        ]
  print (authorizeUrl :: String)

Token exchange

  tokenExchangeResponse <- exchangeToken 1790 "secret" "code"
  print (tokenExchangeResponse :: Either String TokenExchangeResponse)

Deauthorization

  deauthorizationResponse <- deauthorize client
  print (deauthorizationResponse :: Either String DeauthorizationResponse)

Athletes

Retrieve current athlete

  currentAthlete <- getCurrentAthlete client
  print (currentAthlete :: Either String AthleteDetailed)

Retrieve another athlete

  anotherAthlete <- getAthlete client 65516
  print (anotherAthlete :: Either String AthleteSummary)

Update current athlete

  updatedAthlete <- updateCurrentAthlete client $ with
    [ set city (Just "Dallas")
    , set state (Just "Texas")
    , set country (Just "United States")
    , set sex (Just Male)
    , set weight (Just 72.57)
    ]
  print (updatedAthlete :: Either String AthleteDetailed)

List athlete K/QOMs/CRs

  athleteCrs <- getAthleteCrs client 65516 $ with
    [ set page 1
    , set perPage 2
    ]
  print (athleteCrs :: Either String [EffortDetailed])

Friends and followers

List athlete friends

  currentFriends <- getCurrentFriends client $ with
    [ set page 1
    , set perPage 2
    ]
  print (currentFriends :: Either String [AthleteSummary])

  friends <- getFriends client 65516 $ with
    [ set page 1
    , set perPage 2
    ]
  print (friends :: Either String [AthleteSummary])

List athlete followers

  currentFollowers <- getCurrentFollowers client $ with
    [ set page 1
    , set perPage 2
    ]
  print (currentFollowers :: Either String [AthleteSummary])

  followers <- getFollowers client 65516 $ with
    [ set page 1
    , set perPage 2
    ]
  print (followers :: Either String [AthleteSummary])

List both following

  commonFriends <- getCommonFriends client 65516 $ with
    [ set page 1
    , set perPage 2
    ]
  print (commonFriends :: Either String [AthleteSummary])

Activities

Create an activity

  createdActivity <- createActivity client "An Example" "run" (UTCTime (fromGregorian 1970 0 0) 0) 10 $ with
    [ set description (Just "...")
    , set distance (Just 100.0)
    ]
  print (createdActivity :: Either String ActivityDetailed)

Retrieve an activity

  activity <- getActivity client 141273622 $ with
    [ set allEfforts True
    ]
  print (activity :: Either String ActivitySummary)

Update an activity

  updatedActivity <- updateActivity client 141273622 $ with
    [ set name (Just "WedEx Pit Stop")
    , set Strive.type (Just Ride)
    , set private (Just False)
    , set commute (Just True)
    , set trainer (Just False)
    , set gearId (Just "b387882")
    , set description Nothing
    ]
  print (updatedActivity :: Either String ActivityDetailed)

Delete an activity

  nothing <- deleteActivity client 162674281
  print (nothing :: Either String ())

List athlete activities

  currentActivities <- getCurrentActivities client $ with
    [ set before (Just (UTCTime (fromGregorian 1970 0 0) 0))
    , set after (Just (UTCTime (fromGregorian 1970 0 0) 0))
    , set page 1
    , set perPage 2
    ]
  print (currentActivities :: Either String [ActivitySummary])

List friends' activities

  feed <- getFeed client $ with
    [ set page 1
    , set perPage 2
    ]
  print (feed :: Either String [ActivitySummary])

List activity zones

  activityZones <- getActivityZones client 141273622
  print (activityZones :: Either String [ActivityZoneDetailed])

List activity laps

  activityLaps <- getActivityLaps client 141273622
  print (activityLaps :: Either String [ActivityLapSummary])

Comments

List activity comments

  activityComments <- getActivityComments client 90112360 $ with
    [ set markdown True
    , set page 1
    , set perPage 2
    ]
  print (activityComments :: Either String [CommentSummary])

Kudos

List activity kudoers

  activityKudoers <- getActivityKudoers client 141273622 $ with
    [ set page 1
    , set perPage 2
    ]
  print (activityKudoers :: Either String [AthleteSummary])

Photos

List activity photos

  activityPhotos <- getActivityPhotos client 141273622
  print (activityPhotos :: Either String [PhotoSummary])

Clubs

Retrieve a club

  club <- getClub client 11193
  print (club :: Either String ClubDetailed)

List athlete clubs

  currentClubs <- getCurrentClubs client
  print (currentClubs :: Either String [ClubSummary])

List club members

  clubMembers <- getClubMembers client 11193 $ with
    [ set page 1
    , set perPage 2
    ]
  print (clubMembers :: Either String [AthleteSummary])

List club activities

  clubActivities <- getClubActivities client 11193 $ with
    [ set page 1
    , set perPage 2
    ]
  print (clubActivities :: Either String [ActivitySummary])

Gear

Retrieve gear

  theGear <- getGear client "b387855"
  print (theGear :: Either String GearDetailed)

Segments

Retrieve a segment

  theSegment <- getSegment client 4773104
  print (theSegment :: Either String SegmentDetailed)

List starred segments

  starredSegments <- getStarredSegments client $ with
    [ set page 1
    , set perPage 2
    ]
  print (starredSegments :: Either String [SegmentSummary])

List efforts

  theSegmentEfforts <- getSegmentEfforts client 4773104 $ with
    [ set athleteId (Just 65516)
    , set range (Just ((UTCTime (fromGregorian 1970 0 0) 0), (UTCTime (fromGregorian 1970 0 0) 0)))
    , set page 1
    , set perPage 2
    ]
  print (theSegmentEfforts :: Either String [EffortDetailed])

Segment leaderboard

  segmentLeaderboardResponse <- getSegmentLeaderboard client 4773104 $ with
    [ set gender (Just Male)
    , set ageGroup (Just Ages0To24)
    , set weightClass (Just Kilograms65To74)
    , set following (Just True)
    , set clubId (Just 11193)
    , set dateRange (Just "this_year")
    , set page 1
    , set perPage 2
    ]
  print (segmentLeaderboardResponse :: Either String SegmentLeaderboardResponse)

Segment explorer

  segmentExplorerResponse <- exploreSegments client (32.0, -96.0, 33.0, -95.0) $ with
    [ set activityType Riding
    , set minCat 0
    , set maxCat 5
    ]
  print (segmentExplorerResponse :: Either String SegmentExplorerResponse)

Segment efforts

Retrieve a segment effort

  segmentEffort <- getSegmentEffort client 1595370098
  print (segmentEffort :: Either String EffortDetailed)

Streams

Retrieve activity streams

  activityStreams <- getActivityStreams client 141273622 [LatlngStream, WattsStream] $ with
    [ set resolution (Just Low)
    , set seriesType Time
    ]
  print (activityStreams :: Either String [StreamDetailed])

Retrieve effort streams

  effortStreams <- getEffortStreams client 1595370098 [LatlngStream, WattsStream] $ with
    [ set resolution (Just Low)
    , set seriesType Time
    ]
  print (effortStreams :: Either String [StreamDetailed])

Retrieve segment streams

  segmentStreams <- getSegmentStreams client 4773104 [LatlngStream, WattsStream] $ with
    [ set resolution (Just Low)
    , set seriesType Time
    ]
  print (segmentStreams :: Either String [StreamDetailed])

Uploads

Upload an activity

  uploadedActivity <- uploadActivity client (pack "...") "gpx.gz" $ with
    [ set activityType (Just Ride)
    , set name (Just "An Example")
    , set description (Just "...")
    , set private True
    , set trainer False
    , set externalId (Just "...")
    ]
  print (uploadedActivity :: Either String UploadStatus)

Check upload status

  upload <- getUpload client 16486788
  print (upload :: Either String UploadStatus)