Menu

Architecture

About this API Domains Versioning Example URLs

General

Identifiers Supported Data Formats Data Types
Requests
Access Token and Related Information Localization GET Request Query Parameter Collection Requests
Responses
Content Type Response Codes Response Body Error Responses Standard Responses

Authentication and Authorization

Partner Authentication User Authorization
Authorization Code Grant (GET /oauth2/auth)
Request query parameters Example 1: Requesting the diary scope Example 2: Requesting all available scopes Response Authorization Errors
Access Token Request (POST /oauth2/token)
Request body form parameters Response Access Token Errors
Refreshing Access Tokens (POST /oauth2/token)
Request body form parameters Response Refresh Token Errors Making Requests
Revoking Tokens (POST /oauth2/revoke)
Request body form parameters Response

Users

Resources GET /users/:userId
Example Response with no fields parameter Example Response with fields elements
Resources PATCH /users/:userId
Request Example

Measurements

Resources
GET /measurements/ POST /measurements/

Diary

Resources
GET /diary/ POST /diary/ PATCH /diary/ DELETE /diary/

Exercises

Resources
GET /exercises/

Subscriptions

Management
POST /subscription/ GET /subscription/ DELETE /subscription/
Notifications
Example Request Body Best Design Practices

Appendix

Data Structures
User Measured Value User Profile Account Privacy Preferences Goal Preferences Location Preferences Diary Preferences Nutritional Contents Exercise Measurement Diary Subscription
Error Codes
Error Codes
Migrating from MyFitnessPal API v1 to v2
v1 action: log_cardio_exercise v1 action: remove_cardio_exercise v1 action: log_weight v1 action: log_expended_energy v1 action: get_food_summary v1 action: get_cardio_exercises v1 action: get_weight v1 action: fetch_user_info v1 action: subscribe_to_user_updates v1 action: unsubscribe_from_user_updates
Tracking all­day steps activity
Tracking all-day steps activity Recommended approach for tracking steps Determining daily totals Calorie Adjustments
MyFitnessPal exercises and their identifiers
MyFitnessPal exercises and their identifiers
Full request and response examples
POST and GET request and response

Tracking all­day steps activity

MyFitnessPal encourages clients that provide step­counting to their users to integrate that feature with their users’ MyFitnessPal accounts. The best way to accomplish this is through creating diary entries with type ​steps​ at regular intervals throughout the day.

A key feature for people using MyFitnessPal is the integration of fitness activities into their daily goals. To this end, people can log discrete exercises such as running, bowling, cardio training, and even custom exercises to their diaries. Partner integrations automate this logging, with fitness tracking applications able to log discrete exercises on behalf of their users.

It is often the case that a user’s exercise logging comes from multiple sources: manually logged exercises via the MyFitnessPal website or mobile applications, automatically logged exercises from partner applications, and all­day step tracking applications.

MyFitnessPal aims to ensure that the energy expenditure reflected in a person’s diary is accurate. To that end, we make a strong effort to prevent duplication of activity logging, such as that which might happen when a person wears a step tracker while using a GPS­ enabled running application to log a long­distance run. This is why we require a starting time and duration on both discrete exercise diary entries as well as step entries.