endomondo-unofficial-api

This is a promise based unofficial endomondo api.

installation

npm install endomondo-unofficial-api

Use

the API provides the next functionalities

Authentication

Get login information and tokens. The next snippet describes an example of the call:

var authenticate = require('endomondo-unofficial-api').authenticate

authenticate({email: <email>, password: <password>})
    .then((result) => console.log(result))
    .catch((result) => console.log(result))

the complete set of parameters get determined by:

{
    email: params.email,
    password: params.password,
    deviceId: params.uuid || uuid,
    country: params.country || 'ES',
    action: params.action || 'pair'
}

The result of the promise will be if failed the error that caused it and if success an result object similar to this:

{ 
  authToken: <token>,
  measure: <mesure unit>,
  displayName: <user name>,
  userId: <user id>,
  facebookConnected: <true|false>
}

Workouts

Get a list of your workouts. The next snippet describes an example of the call:

var workouts = require('endomondo-unofficial-api').workouts

var token = 'authToken'

workouts({authToken: token})
    .then((result) => { console.log(result) })
    .catch((result) => console.log(result))

the complete set of parameters get determined by:

{
    authToken: params.authToken,
    fields: params.fields || undefined,
    maxResults: params.maxResults || undefined,
    deflate: params.deflate || undefined,
    compression: params.compression || undefined,
    before: params.before || undefined,
    after: params.after || undefined,
}

The result of the promise will be if failed the error that caused it and if success an result object similar to this:

{
  "data":[<activities>],
  "more":false
}

Workout (get)

Get a specific workout. The next snippet describes an example of the call:

var workoutGet = require('endomondo-unofficial-api').workout.get

var token = 'authToken'
var workoutId = 'workoutId'

workoutGet({authToken: token, workoutId: workoutId})
    .then((result) => { console.log(result) })
    .catch((result) => console.log(result))

Workout (set)

Set (or create) a specific workout. The next snippet describes an example of the call:

var workoutSet = require('endomondo-unofficial-api').workout.set

var token = 'authToken'
var userId = 'userId'

workoutSet({authToken: token, userId: userId, time: Date.now()-70, duration: 60, distance: 0.05 })
    .then((result) => { console.log(result) })
    .catch((result) => console.log(result))

the complete set of parameters are determined by:

{
    authToken: params.authToken,
    duration: params.duration,
    trackPoints: [ { dateTime, inst, latitude, longitude, distance, speed, altitude, heartRate }],
    workoutId: params.workoutId || Math.floor(Math.random() * Number.MAX_SAFE_INTEGER)
}

or

{
    authToken: params.authToken,
    duration: params.duration,
    time: params.time, 
    distance: params.distance,
    workoutId: params.workoutId || Math.floor(Math.random() * Number.MAX_SAFE_INTEGER)
}

The result of the promise will be if failed the error that caused it and if success an result object like this:

{ workoutId: <workoutId> }

Workout (remove)

Get a specific workout. The next snippet describes an example of the call:

var workoutRemove = require('endomondo-unofficial-api').workout.remove

var token = 'authToken'
var workoutId = 'workoutId'

workoutRemove({authToken: token, workoutId: workoutId})
    .then((result) => { console.log(result) })
    .catch((result) => console.log(result))

the complete set of parameters are determined by:

{
    workoutId: params.id,
    sport: params.sport || 0,
    duration: params.duration || 0,
    gzip: params.gzip || true,
    audioMessage: params.audioMessage || false,
    goalType: params.goalType || 'BASIC',
    extendedResponse: params.extendedResponse || undefined,
    calories: params.calories || undefined,
    hydration: params.hydration || undefined
}

The result of the promise will be if failed the error that caused it and if success a result object that is quite complex to describe just try it ;).

Thanks

Special thanks to @aperezm85 whos code was used as inspiration for this package.

Logo

Sport graphic by Webalys from Flaticon is licensed under CC BY 3.0. Made with Logo Maker

Disclaimer, legalese and everything else.

This is not affiliated or endorset by Endomondo, or any other party. This software available on the site is provided "as is" and any expressed or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the user under the pseudonym Kanekotic, or any of their contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Tor Anders Johansen 💻

Marc Poppleton 💻

This project follows the all-contributors specification. Contributions of any kind welcome!