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

User Authorization

MyFitnessPal API user authorization is based on the OAuth 2.0 protocol. (See: http://oauth.net/2/​) In order to use the API to interact with a user’s MyFitnessPal account, these steps must be followed:

  1. Obtain permission from the user to link their account to your application. To do this, create a link on your website to the Authorization Code Grant URL hosted by MyFitnessPal. When the user follows this link, they will be presented with the option to grant access to your application. (If they do not already have a session in MyFitnessPal, they will first be presented with a login form.)

  2. If the user grants access to your application, the MyFitnessPal servers will redirect the user back to your site. Along with this redirect you will be passed an ​authorization code which represents the link between your application and the user.

  3. Immediately exchange the authorization code for an access token and a refresh token from MyFitnessPal. As part of this request, you will pass along your ​client id​ and ​client secret​, which serve to authenticate your application to the MyFitnessPal API. MyFitnessPal will provide you with the c​lient id​ and ​client secret​ when you set up your API account.

  4. The provided access token represents a fully authenticated token that must be used to make API requests on behalf of the linked user account. Every API request must contain a valid access token. The access token will expire after a certain period. A client app may request a new access token at any time using the refresh token. The refresh token remains valid until revoked by either your application or the user.

  5. Once a user has authorized your app to make requests to the MyFitnessPal API on their behalf, you may use the API methods documented below, including the access token with each request.

Each step in this process is described in more detail in the following sections.