GithubHelp home page GithubHelp logo

garmin-run-fetch's Introduction

Garmin Run Fetch

Retrieves Garmin Connect run activity data.

Performes a one time login with puppeteer for the credentials which are then kept (encrypted) between runs and are updated only if needed.


Install

npm i garmin-run-fetch

Require module:

const garminRunFetch = require('garmin-run-fetch');
const opts = {
    userName,
    password,
    limit,     // optional
    startDate, // optional
    endDate,   // optional
};
const activitiesJson = await garminRunFetch(opts);

Or use command line:

[email protected] GARMIN_PASSWORD=123456 npx garmin-run-fetch

// Output activity json to console ...

Params

param env var name desc default
userName GARMIN_USER_NAME Garmin connect user email -
password GARMIN_PASSWORD Garmin connect user password -
limit GARMIN_LIMIT (Optional) number of activities to fetch 20
startDate GARMIN_START_DATE (Optional) fetch activitiess only older than this value, a UNIX epoch number. 0
endDate GARMIN_END_DATE (Optional) fetch activitiess only created before this value, a UNIX epoch number. Date.now()
- DEBUG (Optional) set as garmin:* for debugging -

Notes

  • This module creates a .cred.json file (which is encrypted) with your garmin credentials, this is done for avoiding a login with every run. The file can be deleted in between runs.
  • The login is done with scrapping the Garmin Connect web page by using puppeteer.

garmin-run-fetch's People

Watchers

 avatar

Forkers

call203

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.