Make your product
work with UP.

Moves

Get the user's move list

Returns the list of moves of the current user. There is only one move created per day for the user and it details all the activity from the UP band for the day. The move for the day will be created when the user first starts wearing their band, and will be updated throughout the day as new data comes in. The moves data only comes from the UP band and is always tracked when the UP band is being worn (see the Workout endpoint for specific workouts logged by the user via UP or 3rd party apps).

Partners cannot write to the Moves endpoint, this is reserved for UP. You can contribute to calories burned by writing to the Workout endpoint.

This list can be paginated by date or timestamp.
URI Method Response Type Returns
/nudge/api/v.1.1/users/@me/moves GET application/json Collection>Move
Parameter Type Description
date int Date, formatted as YYYYMMDD. If omitted, returns the information for today.
page_token int Timestamp used to paginate the list of moves. The Developer must use the “next” link provided in the “links” section.
start_time int To be used along with end_time. Epoch timestamp that denotes the start of the time range queried for move events.
end_time int To be used with start_time. Epoch timestamp that denotes the end of the time range queried for move events.
updated_after int Epoch timestamp to list move events that are updated later than the timestamp. To be used with start_time to list events that were completed after said start_time.

Example:

GET https://jawbone.com/nudge/api/v.1.1/users/@me/moves?start_time=1383289200 HTTP/1.1
Host: jawbone.com
	

Will return:

HTTP 200 OK
{
   “meta”:
   {
      “user_xid”: “6xl39CsoVp2KirfHwVq_Fx”,
      “message”: “OK”,
      “code”: 200
      "time": 1386122022
   },
   “data”:
   {
      "items": 
      [{
         "xid": "40F7_htRRnQwoMjIFucJ2g",
         "title": "16,804 steps",
         "type": "move",
         "time_created": 1384963500,
         "time_updated": 1385049599,
         "time_completed": 1385099220,
         "date": 20131121
         "snapshot_image": "/nudge/image/e/1385107737/40F7_htRRnQwoMjIFucJ2g/grEGutn_XYZ.png"
         "details": 
         {
            "distance": 14745,
            "km": 14.745,
            "steps": 16804,
            "active_time": 11927,
            "longest_active": 2516,
            "inactive_time": 32760,
            "longest_idle": 27180,
            "calories": 1760.30480012,
            "bmr_day": 1697.47946931,
            "bmr": 1697.47946931,
            "bg_calories": 1099.9439497,
            "wo_calories": 388.506116077,
            "wo_time": 11484,
            "wo_active_time": 3902,
            "wo_count": 2,
            "wo_longest": 2516,
            "sunrise": 1409578680,
            "sunset": 1409625420,
            "tz": "America/Los Angeles",
            "tzs": 
            [
               [1384963500, "America/Phoenix"],
               [1385055720, "America/Los_Angeles"]
            ],
            "hourly_totals": 
            {
                "2013112101":
                {
                    "distance": 1324,
                    "calories": 90.0120018125,
                    "steps": 1603,
                    "active_time": 793,
                    "inactive_time": 220,
                    "longest_active_time": 302,
                    "longest_idle_time": 780
                },
                "2013112101":
                {
                    "distance": 626,
                    "calories": 47.0120018125,
                    "steps": 455,
                    "active_time": 246,
                    "inactive_time": 260,
                    "longest_active_time": 203,
                    "longest_idle_time": 650
                },
                ... more hours ...
            }
         }
      },
      {
      ... more items ....
      }],
      "links": 
      {
         "next": "/nudge/api/v.1.1/users/6xl39CsoVp2KirfHwVq_Fx/moves?page_token=1384390680"
      },
      “size”: 10
   }   
}
	
Data Value Type Description
xid string Unique ID for this event. Can be used to retrieve data for this specific event, see below.
title string Title of this move.
type string Type of event, in this case a move.
time_created int Epoch timestamp when this move was created.
time_updated int Epoch timestamp when this move was last updated. NOTE: unlike other endpoints, this value is not when the user last submitted data, but is always updated in real time due to the fact that the BMR value (see below) is always changing throughout the day. This is true even for move events from previous days.
time_completed int Epoch timestamp when this move was completed. This is the timestamp to use for the last time the move data from the user's band was updated.
date int Date when this move was created, formatted as YYYYMMDD.
snapshot_image URI Link to the image of this move event (relative, add prefix https://jawbone.com)
distance int Distance travelled, in meters.
km int Distance travelled, in kilometers.
steps int Number of steps taken.
active_time int Total active time for move, in seconds.
longest_active int Longest consecutive active period, in seconds.
inactive_time int Total inactive time for move, in seconds.
longest_idle int Longest consecutive inactive period, in seconds.
calories int Total calories burned. This is computed by this formula: wo_calories+bg_calories+bmr_day / 86400 * active_time
bmr_day int Estimated basal metabolic rate for entire day, in calories.
bmr int Estimated basal metabolic rate at current time. For previous days should approximately equal bmr_day.
bg_calories int Calories directly from UP band activity outside the context of a workout.
wo_calories int Calories burned from workouts.
wo_time int Total time spent in workouts, in seconds.
wo_active_time int Actual active time during workout (where user was stepping) in seconds.
wo_count int Number of workouts logged during this move.
wo_longest int Longest workout period, in seconds.
sunrise int Epoch timestamp of sunrise.
sunset int Epoch timestamp of sunset.
tz string Time zone when this event was generated. Whenever possible, Olson format (e.g., "America/Los Angeles") will be returned, otherwise the GMT offset (e.g., "GMT+0800") or a seconds offset (e.g., -14400) will be returned.
tzs [epoch timestamp, timezone] Move can have more than one timezone associated with it if the user has crossed timezone in the given day. Epoch timestamp for the period starting in that time zone, and the time zone string. Whenever possible, Olson format (e.g., "America/Los Angeles") will be returned, otherwise the GMT offset (e.g., "GMT+0800") or a seconds offset (e.g., -14400) will be returned.
hourly_totals JSON Data broken out by hour (values as above).
size int Number of items in this list.
Next URI Link to next page of data (relative, add https://jawbone.com as prefix).

Get the information about a specific move

Returns the detailed information of the given move.
URI Method Response Type Returns
/nudge/api/v.1.1/moves/{move_xid} GET application/json Move

Example:

GET https://jawbone.com/nudge/api/v.1.1/moves/40F7_htRRnQwoMjIFucJ2x HTTP/1.1
Host: jawbone.com
	

Will return:

HTTP 200 OK
{
   “meta”:
   {
      “user_xid”: “6xl39CsoVp2KirfHwVq_Fx”,
      “message”: “OK”,
      “code”: 200
      "time": 1386122022
   },
   “data”:
   {
      "xid": "40F7_htRRnQwoMjIFucJ2x",
      "title": "16,804 steps",
      "type": "move",
      "time_created": 1384963500,
      "time_updated": 1385049599,
      "time_completed": 1385099220,
      "date": 20131121
      "snapshot_image": "/nudge/image/e/1385107737/40F7_htRRnQwoMjIFucJ2g/grEGutn_XYZ.png"
      "details": 
      {
         "distance": 14745,
         "km": 14.745,
         "steps": 16804,
         "active_time": 11927,
         "longest_active": 2516,
         "inactive_time": 32760,
         "longest_idle": 27180,
         "calories": 1760.30480012,
         "bmr_day": 1697.47946931,
         "bmr": 1697.47946931,
         "bg_calories": 1099.9439497,
         "wo_calories": 388.506116077,
         "wo_time": 11484,
         "wo_active_time": 3902,
         "wo_count": 2,
         "wo_longest": 2516,
         "tz": "America/Los Angeles",
         "tzs": 
         [
            [1384963500, "America/Phoenix"],
            [1385055720, "America/Los_Angeles"]
         ],
         "hourly_totals": 
         {
            "2013112101":
            {
               "distance": 1324,
               "calories": 90.0120018125,
               "steps": 1603,
               "active_time": 793,
               "inactive_time": 220,
               "longest_active_time": 302,
               "longest_idle_time": 780
            },
            "2013112101":
            {
               "distance": 626,
               "calories": 47.0120018125,
               "steps": 455,
               "active_time": 246,
               "inactive_time": 260,
               "longest_active_time": 203,
               "longest_idle_time": 650
            },
            ... more hours ...
         }  
      }
   }
}
	

Get the user's move graphs

Returns the image of the given move.
URI Method Response Type Returns
/nudge/api/v.1.1/moves/{move_xid}/image GET image/png Binary image

Example:

GET https://jawbone.com/nudge/api/v.1.1/moves/40F7_htRRnSLLvJP0G6cbA/image HTTP/1.1
Host: jawbone.com
	

Will return:

Binary contents of the image.
	

Get move ticks

Returns granular details for the specific Move event. Each entry contains a tick bucket with the details for that time slice. Currently the tick bucket is 60 seconds wide (which may be subject to change in the future, so please utilize the timestamp included).

NOTE: the v1.0 endpoint, /snapshot, has been deprecated but is still useable, but as it may not be supported in future versions we recommend updating to this endpoint. You can view the deprecated snapshot endpoint documentation here.

URI Method Response Type Returns
/nudge/api/v.1.1/moves/{move_xid}/ticks GET application/json Ticks

Example:

GET https://jawbone.com/nudge/api/v.1.1/moves/40F7_htRRnSLLvJP0G6cbA/ticks HTTP/1.1
Host: jawbone.com
	

Will return:

HTTP 200 OK
{
   “meta”:
   {
      “user_xid”: “b9yCLa3f01yf”,
      “message”: “OK”,
      “code”: 200,
      "time": 1396298766
   },
   “data”:
   {
      "items": 
      [{
         "distance": 20.0,
         "time_completed": 1396287540,
         "active_time": 11, 
         "calories": 1.48109316826, 
         "steps": 23, 
         "time": 1396287480, 
         "speed": 1.0
      }, {
         "distance": 58.0, 
         "time_completed": 1396287600,
         "active_time": 35,  
         "calories": 3.83396744728, 
         "steps": 70, 
         "time": 1396287540, 
         "speed": 1.0
      },
      ...
      }],
      "size": 50
   }
}
	
Data Value Type Description
distance int Distance travelled in meters.
time_completed int Time stamp for end of this tick bucket.
active_time int Active time during this tick bucket, in seconds.
calories int Calories burned during this tick bucket.
steps int Steps taken during this tick bucket.
time int Time stamp for start of this tick bucket.
speed int Speed is calculated as distance/active_time (m/s)