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

Appendix Data Structures - Diary

The following types of diary entries are supported:

● diary_meal (DM)
● exercise (E)
● steps (S)
● steps_aggregate (SA)
Name Type Description DM E S SA
type String type of the entry x x x x
id String unique identifier - x x x
date Date The date of this entry, in ISO 8601 format (YYYY­MM­DD) x x x x
device_id String The identifier of the device used to create this entry - x x x
parent_id String unique identifier of the parent of this entry, if one exists - - x -
tags List(String) A set of string tags associated with this entry - x - -
nutritional_contents Nutritional Contents Calculated nutritional contents of this entry x - - -
start_time Timestamp The start date/time of the entry - x x x
duration Integer The duration of the entry, in seconds - x x x
energy Measured Value Energy expended in this entry - x x x
diary_meal String The name of the diary meal logged in this entry x - - -
exercise Exercise - x - -  
steps Integer The number of steps logged in this entry - - x x
quantity [deprecated] Integer The number of times this exercise was performed, such as with pushups. - x - -
sets Integer The number of sets performed - x - -
reps_per_set Integer The number of repetitions per set - x - -
weight_per_set Measured Value The amount of weight used on each set - x - -
distance Measured Value The distance covered by the exercise - x - -
max_speed Measured Value The maximum speed achieved in the exercise - x - -
avg_heart_rate Integer The average heart rate measured during the exercise, in beats per minute - x - -
max_heart_rate Integer The maximum heart rate measured during the exercise, in beats per minute - x - -
elevation_change Measured Value The elevation change experienced in the exercise. May be negative. - x - -
primary Boolean Whether this aggregate is from the user’s primary step source - - - x

Property legend, by diary entry type:

x: Applies
-: Not Applicable