Have ideas to improve npm?Join in the discussion! »

garmin-connect

1.1.1 • Public • Published

garmin-connect

A powerful JavaScript library for connecting to Garmin Connect for sending and receiving health and workout data. It comes with some predefined methods to get and set different kinds of data for your Garmin account, but also have the possibility to make custom requests GET, POST and PUT are currently supported. This makes it easy to implement whatever may be missing to suite your needs.

Prerequisites

This library will require you to add a configuration file to your project root called garmin.config.json containing your username and password for the Garmin Connect service.

{
	"username": "my.email@example.com",
	"password": "MySecretPassword" 
}

How to install

$ npm install garmin-connect

How to use

const { GarminConnect } = require('garmin-connect');
// Create a new Garmin Connect Client
const GCClient = new GarminConnect();
// Uses credentials from garmin.config.json or uses supplied params
await GCClient.login('my.email@example.com', 'MySecretPassword');
const userInfo = await GCClient.getUserInfo();

Now you can check userInfo.emailAddress to verify that your login was successful.

Reading data

User info

Receive basic user information

GCClient.getUserInfo();

Social Profile

Receive social user information

GCClient.getSocialProfile();

Social Connections

Get a list of all social connections

GCClient.getSocialConnections();

Device info

Get a list of all registered devices including model numbers and firmware versions.

GCClient.getDeviceInfo();

Activities

To get a list of recent activities, use the getActivities method. This function takes two arguments, start and limit, which is used for pagination. Both are optional and will default to whatever Garmin Connect is using. To be sure to get all activities, use this correctly.

// Get a list of default length with most recent activities
GCClient.getActivities();
// Get activities 10 through 15. (start 10, limit 5)
GCClient.getActivities(10, 5);

Activity details

Use the activityId to get details about that specific activity.

const activities = await GCClient.getActivities(0, 1);
const id = activities[0].activityId;
// Use the id as a parameter 
GCClient.getActivity({ activityId: id });
// Or the whole activity response
GCClient.getActivity(activities[0]);

Activities

To get a list of activities in your news feed, use the getNewsFeed method. This function takes two arguments, start and limit, which is used for pagination. Both are optional and will default to whatever Garmin Connect is using. To be sure to get all activities, use this correctly.

// Get the news feed with a default length with most recent activities
GCClient.getNewsFeed();
// Get activities in feed, 10 through 15. (start 10, limit 5)
GCClient.getNewsFeed(10, 5);

Download original activity data

Use the activityId to download the original activity data. Usually this is supplied as a .zip file.

const [activity] = await GCClient.getActivities(0, 1);
// Directory path is optional and defaults to the current working directory.
// Downloads filename will be supplied by Garmin.
GCClient.downloadOriginalActivityData(activity, './some/path/that/exists');

Step count

Get timestamp and number of steps taken for a specific date.

// This will default to today if no date is supplied
const steps = await GCClient.getSteps(new Date('2020-03-24'));

Heart rate

Get heart rate for a specific date.

// This will default to today if no date is supplied
const heartRate = await GCClient.getHeartRate(new Date('2020-03-24'));

Sleep summary

Get the summary of how well you've slept for a specific date.

// This will default to today if no date is supplied
const sleep = await GCClient.getSleep(new Date('2020-03-24'));

Detailed sleep data

Get the details of your sleep for a specific date.

// This will default to today if no date is supplied
const detailedSleep = await GCClient.getSleepData(new Date('2020-03-24'));

Modifying data

Add weight

To add a new weight measurement, use setBodyWeight. Here you specify your weight in kg.

GCClient.setBodyWeight(81.4);

Will set your current weight to 81.4kg. The unit used might be tied to your preferred weight settings.

Add workout

To add a custom workout, use the addWorkout or more specifically addRunningWorkout.

GCClient.addRunningWorkout('My 5k run', 5000, 'Some description');

Will add a running workout of 5km called 'My 5k run' and return a JSON object representing the saved workout.

Schedule workout

To add a workout to your calendar, first find your workout and then add it to a specific date.

const workouts = await GCClient.getWorkouts();
const id = workouts[0].workoutId;
GCClient.scheduleWorkout({ workoutId: id }, new Date('2020-03-24'));

This will add the workout to a specific date in your calendar and make it show up automatically if you're using any of the Garmin watches.

Delete workout

Deleting a workout is very similar to scheduling one.

const workouts = await GCClient.getWorkouts();
const id = workouts[0].workoutId;
GCClient.deleteWorkout({ workoutId: id });

Custom requests

This library will handle custom requests to your active Garmin Connect session. There are a lot of different url's that is used, which means that this library probably wont cover them all. By using the network analyze tool you can find url's that are used by Garmin Connect to fetch data.

Let's assume I found a GET requests to the following url:

https://connect.garmin.com/modern/proxy/wellness-service/wellness/dailyHeartRate/22f5f84c-de9d-4ad6-97f2-201097b3b983?date=2020-03-24

The request can be sent using GCClient by running

// You can get your displayName by using the getUserInfo method;
const displayName = '22f5f84c-de9d-4ad6-97f2-201097b3b983';
const url = 'https://connect.garmin.com/modern/proxy/wellness-service/wellness/dailyHeartRate/';
const dateString = '2020-03-24';
GCClient.get(displayName + url, { date: dateString });

and will net you the same result as using the provided way

GCClient.getHeartRate();

Notice how the client will keep track of the url's, your user information as well as keeping the session alive.

Limitations

For now, this library only supports the following:

  • Get user info
  • Get social user info
  • Get heart rate
  • Set body weight
  • Get list of workouts
  • Add new workouts
  • Add workouts to you calendar
  • Remove previously added workouts
  • Get list of activities
  • Get details about one specific activity
  • Get the step count

Install

npm i garmin-connect

DownloadsWeekly Downloads

40

Version

1.1.1

License

MIT

Unpacked Size

28.9 kB

Total Files

12

Last publish

Collaborators

  • avatar