Web API Reference
Fitbit provides a set of public Web APIs that developers may use to retrieve Fitbit user data collected by the Fitbit trackers & smartwatches, Aria & Aria 2 scales, and manually entered log data. Anyone may use the Web APIs to build integrations with the Fitbit data services, so long as their application complies with the Fitbit Platform Terms of Service, the Fitbit User Data and Developer Policy, and the Fitbit user consents to share their data with the developer’s application.
Here are some resources to help you get started.
- Developer Guide contains information such as how to get started using the Web APIs, tips for designing your application, best practices and sample code.
- Troubleshooting Guide helps you debug common problems and errors, and tells you where to find some tools to help test and troubleshoot the endpoints.
The API endpoint pages show you the proper syntax, the expected response and meaning, and any nuances that you need to be aware. The endpoints are grouped by the following,
- Active Zone Minutes Time Series provides a user's heart-pumping activity throughout the day.
- Activity and Activity Time Series provides information about a user's activity and their activity goals. The time series endpoints can be used to observe trends.
- Authorization contains the endpoints needed to manage consent to Fitbit user data.
- Body and Body Time Series provides data on a user's weight and body fat percentage. The time series endpoints can be used to observe trends.
- Breathing Rate provides a user's average breaths per minute at night.
- Cardio Fitness Score (VO2 Max) returns the maximum or optimum rate at which the user’s heart, lungs, and muscles can effectively use oxygen during exercise.
- Devices contains information about the devices paired to a user's account and when their last sync time.
- Electrocardiogram contains information about the user's on-device electrocardiogram readings.
- Friends contains information about a user's friends and their leaderboard.
- Heart Rate Time Series returns a user's heart rate and resting heart rate values. The time series endpoints can be used to observe trends.
- Heart Rate Variability provides the room mean square of successive differences values recorded during a user's period of sleep.
- Intraday provides a daily, granular-level of detail to a user's active zone minutes, activity, breathing rate, heart rate, heart rate variability and SpO2 metrics.
- Nutrition and Nutrition Time Series allows a user to record the foods they consumed and include the food's nutritional metadata. The time series endpoints can be used to observe trends.
- Sleep returns information about a user's sleep patterns.
- SpO2 provides a user's blood oxygen levels.
- Subscription notifies your application via webhooks when new data is available.
- Temperature returns a user's core and skin temperature.
- User returns basic information about the user who shared their data with your application.
