REST APIs support cross-platform development to ensure consistent experience on different platforms and improve the efficiency of development. For details about the recommended application scenarios, please refer to Usage Scenarios.
indicates advanced data that is not open to individual developers. You can access these data by registering as an enterprise developer and applying for the relevant scopes.
indicates basic data that is open to both qualified individual and enterprise developers.Category | Sub-Category | Item | Openness Level | Data Timeliness | Read Supported | Write Supported |
|---|---|---|---|---|---|---|
Daily activity | Step sampling details and daily step count |
| In hours | Yes | Yes | |
Calorie sampling details and daily total calorie consumption |
| In hours | Yes | Yes | ||
Distance sampling details and daily total distance |
| In hours | Yes | Yes | ||
Altitude sampling details and daily altitude statistics |
| In hours | Yes | Yes | ||
Time spent in moderate to high-intensity exercise such as walking, running, cycling, and training |
| In hours | Yes | Yes | ||
Number of hours during which the user stands up and moves for at least 1 minute |
| In hours | Yes | Yes | ||
Goals and daily statistics of steps, calories, moderate to high intensity, and hours active |
| In hours | Yes | No | ||
Health data | Height |
| In minutes | Yes | Yes | |
Weight, body fat, BMI, and more |
| In minutes | Yes | Yes | ||
Dynamic heart rate, resting heart rate, and heart rate variability |
| In hours | Yes | Yes | ||
Stress score and stress level |
| In hours | Yes | Yes | ||
Segment-based sleep sampling data, sleep records, and daily sleep statistics |
| In minutes | Yes | Yes | ||
Blood glucose and continuous blood glucose |
| In minutes | Yes | Yes | ||
Systolic blood pressure, diastolic blood pressure, and pulse |
| In minutes | Yes | Yes | ||
Instantaneous blood oxygen saturation |
| In hours | Yes | Yes | ||
Body temperature and skin temperature |
| In minutes | Yes | Yes | ||
Heart health | ECG measurement records, ECG measurement details, and tachycardia and bradycardia data |
| In minutes | Yes | Yes | |
Lung function |
| In minutes | Yes | No | ||
Cervical mucus, cervical status, menstrual volume, ovulation test results, and vaginal spotting |
| In hours | Yes | Yes | ||
Exercise records | The summary of an exercise record for 100+ workout types including running, cycling, walking, jump rope, swimming, ball games, and fitness courses |
| In minutes | Yes | Yes | |
Sampling details including workout heart rate, speed, cadence, altitude, jump-related data, running form, power, resistance, swimming stroke rate, and jump rope speed |
| In minutes | Yes | Yes | ||
Longitude, latitude, and coordinate system |
| In minutes | Yes | Yes | ||
Historical data | Data of the previous week, month, or year |
| N/A | Yes | No |
indicates advanced data that is not open to individual developers. You can access these data by registering as an enterprise developer and applying for the relevant scopes.
indicates basic data that is open to both qualified individual and enterprise developers.Category | Sub-Category | Item | Openness Level | Data Timeliness | Read Supported | Write Supported |
|---|---|---|---|---|---|---|
Daily activity | Step sampling details and daily step count |
| In hours | Yes | Yes | |
Calorie sampling details and daily total calorie consumption |
| In hours | Yes | Yes | ||
Distance sampling details and daily total distance |
| In hours | Yes | Yes | ||
Altitude sampling details and daily altitude statistics |
| In hours | Yes | Yes | ||
Time spent in moderate to high-intensity exercise such as walking, running, cycling, and training |
| In hours | Yes | Yes | ||
Health data | Height |
| In minutes | Yes | Yes | |
Weight, body fat, BMI, and more |
| In minutes | Yes | Yes | ||
Dynamic heart rate and resting heart rate |
| In hours | Yes | Yes | ||
Stress score and stress level |
| In hours | Yes | Yes | ||
Segment-based sleep sampling data, sleep records, and daily sleep statistics |
| In minutes | Yes | Yes | ||
Blood Glucose |
| In minutes | Yes | Yes | ||
Systolic blood pressure, diastolic blood pressure, and pulse |
| In minutes | Yes | Yes | ||
Instantaneous blood oxygen saturation |
| In hours | Yes | Yes | ||
Body temperature and skin temperature |
| In hours | Yes | Yes | ||
Heart health |
| In minutes | Yes | Yes | ||
Lung function |
| In minutes | Yes | No | ||
Exercise records | The summary of an exercise record for 100+ workout types including running, cycling, walking, jump rope, swimming, ball games, and fitness courses |
| In minutes | Yes | Yes | |
Sampling details including workout heart rate, speed, cadence, altitude, jump-related data, running form, power, resistance, swimming stroke rate, and jump rope speed |
| In minutes | Yes | Yes | ||
Historical data | Data of the previous week, month, or year |
| N/A | Yes | No |
The extended capabilities open up real-time data, including real-time exercise and real-time heart rate, and provide some basic atomic data types. For details about the recommended application scenarios, please refer to Usage Scenarios.
indicates advanced data that is not open to individual developers. You can access these data by registering as an enterprise developer and applying for the relevant scopes.
indicates basic data that is open to both qualified individual and enterprise developers.Category | Sub-Category | Item | Openness Level | Timeliness | Read Supported | Write Supported |
|---|---|---|---|---|---|---|
Daily activity | Steps | Step sampling details and daily step count |
| In minutes | Yes | No |
Calories | Total calorie consumption |
| In hours | Yes | No | |
Distance | Total daily distance |
| In hours | Yes | No | |
Moderate to high intensity | Time spent in moderate to high-intensity exercise such as walking, running, cycling, and training |
| In hours | Yes | No | |
Health data | Weight | Weight, body fat, BMI, and more |
| In minutes | Yes | Yes |
Heart rate | Dynamic heart rate and resting heart rate |
| In minutes | Yes | Yes | |
Real-time heart data | Real-time heart rate |
| In seconds | Yes | No | |
Stress | Stress level |
| In minutes | Yes | No | |
Sleep | Segment-based sleep sampling data, sleep records, and daily sleep statistics |
| In minutes | Yes | Yes | |
SpO2 | Instantaneous blood oxygen saturation |
| In hours | Yes | No | |
Body temperature | Body temperature |
| In minutes | Yes | No | |
Exercise records | Exercise record detailed data | Detailed data of an individual workout (e.g. walking, cycling, and running) |
| In minutes | Yes | No |
Real-time workout data | Workout duration, calories burned, distance covered, and more |
| In seconds | Yes | No | |
Personal information | Personal information data | Gender, date of birth, height, and weight |
| N/A | Yes | No |