@giveback007/fitbit-api v0.1.0

This library supports both browser and nodejs.

Install

Install npm or yarn library:

npm install @giveback007/fitbit-api
<or>
yarn add @giveback007/fitbit-api

Polyfills

NodeJs requires fetch polyfills (not required if running in browser).

// Using ES6 modules
import 'cross-fetch/polyfill';

// Using CommonJS modules
require('cross-fetch/polyfill');

global.FormData = require('form-data');

Usage

If a fitbit-user-id isn't passed it will default to "-" for the current logged in user.

import { FitbitApi } from '@giveback007/fitbit-api';

const api = new FitbitApi("<access-token>", "<fitbit-user-id>" || "-");

api.user.getProfile().then(profile => console.log(profile));

Automatic Token Refresh

Pass in a function as a third argument, it will automatically be called on "expired_token" or "invalid_token" errors.

If the refresh function fails -> returns an error object with "expired_token" or "invalid_token".

If new "<access-token>" is successfully retrieved the api will retry the call it first failed on.

new FitbitApi("<access-token>", "<fitbit-user-id>", async () => {
  const newToken = await /* some code retrieving new access-token */;
  return newToken;
});

List Of Supported Endpoints

https://dev.fitbit.com/build/reference/web-api

• Activity api.activity:
  • /activity/
  • /activity-timeseries/
  • /intraday/get-activity-intraday-by-date/
  • /intraday/get-activity-intraday-by-date-range/
• Body api.body:
  • /body/
  • /body-timeseries/
• Devices api.devices:
  • /devices/
• Friends api.devices:
  • /friends/
• HeartRate api.heartRate:
  • /heartrate-timeseries/
  • /intraday/get-heartrate-intraday-by-date/
  • /intraday/get-heartrate-intraday-by-date-range/
• Nutrition api.nutrition:
  • /nutrition/
  • /nutrition-timeseries/
• Sleep api.sleep:
  • /sleep/
• Subscription api.subscription:
  • /subscription/
• User api.user:
  • /user/

Typescript & Intellisense

All data is typed and api endpoint with more complex interface arguments are boiled down to be easier to understand with the use intellisense.

Error Handling

Successful responses are wrapped in a success object:

{
    "type": "SUCCESS",
    "isSuccess": true,
    "code": 200,
    "data": {...},
    "response": Response,
    "headers": {
        "content-type": "application/json; charset=utf-8"
    }
}

And an error response will return an error object:

{
    "type": "ERROR",
    "isSuccess": false,
    "code": 401,
    "error": { "errors": [{...}], "success": false },
    "response": Response,
    "headers": {
        "content-length": "135",
        "content-type": "application/json"
    }
}

Headers

Certain fitbit response headers (such as rate limiting) are unsupported by the browser and therefore won't show up when the api is called.

Some of these headers are:

• fitbit-rate-limit-limit
• fitbit-rate-limit-remaining
• fitbit-rate-limit-reset

Subscriptions

This can't be accessed in the browser since it requires passing in headers that the browser doesn't support.

Make sure to set up a subscriber endpoint with fitbit were you manage fitbit api app credentials https://dev.fitbit.com/apps. To add this to an existing application use the [Edit Application Settings] button.

For more information: https://dev.fitbit.com/build/reference/web-api/developer-guide/using-subscriptions/

Developer Discord

This project is by the MyAlyce team. If you have any questions join us in our discord:

Invitation Link, use #fitbit_integration channel for fitbit api specific things.

TODOs

QUICK TODOS:

• setup a publish script
• set this up: https://hackernoon.com/these-6-essential-tools-will-maintain-your-npm-modules-for-you-4cbbee88e0cb
• publish to npm
• chart based api data

TODO:

• additional header handling (localization etc.)
• a way to handle rate limiting
  • rate limiting headers only exist in node (possibly make rate limiting utils, look up how rate limiting translates to the end user)
• tests
• set up subscription endpoint on alyce
• research some form of swagger api change detection
• turn everything from fitbit into package. (eg. auth on nodejs & browser side)
  • separate out parts that don't have node dependencies &import the non-node dependent parts with node parts.
• add a simple way to add-in/expose fitbit api endpoints.
• implement 'Get Activity TCX' https://dev.fitbit.com/build/reference/web-api/activity/get-activity-tcx/