Jawbone UP
UP is a wristband and app that tracks how you sleep, move and eat—then helps you use that information to feel your best. The UP Platform documentation provides information related to establishing and maintaining an API connection with UP. The purpose of this API is to enable the exchange of select data in order to extend and augment the UP user experience and support complementary services. This…
Jawbone UP endpoints
| Method | Endpoint | Description |
|---|---|---|
| Mood | ||
| DELETE |
Delete a single mood event /mood/{xid} |
Deletes an existing event. The event must have been created by the partner for this call to succeed. |
| GET |
Get a single mood event /mood/{xid} |
|
| POST |
Record user's mood /users/@me/mood |
|
| User | ||
| GET |
Get detailed information about the user /users/@me |
Returns the basic information of the user |
| GET |
Get list of friends /users/@me/friends |
Returns the list of unique identifiers (XIDs) of the user's friends. |
| GET |
Get the user's trends /users/@me/trends |
Returns the user's trends over a period of time (e.g. 5 weeks), using the given granularity (e.g. by day). |
| GET |
Get the user's mood /users/@me/mood |
Returns the user's mood for the given day. Defaults to get today's mood. |
| Moves | ||
| GET |
Get move intensity /moves/{move_xid}/snapshot |
Returns a time-series of the move intensity during the day. Each entry is a tuple that contains a timestamp, and the average intensity during that period. Currently, it’s an… |
| GET |
Get the information about a specific move /moves/{move_xid} |
Returns the detailed information of the given move. |
| GET |
Get the user's move graphs /moves/{move_xid}/image |
Returns the image of the given move. |
| GET |
Get the user's moves list /users/@me/moves |
Returns the list of moves of the current user. This list can be paginated by date or timestamp. |
| Cardiac | ||
| DELETE |
Delete a single cardiac metric event /cardiac_events/{event_xid} |
Deletes an existing event. The event must have been created by the partner for this call to succeed. |
| POST |
Create new user event to record cardiac metrics /users/@me/cardiac_events |
|
| GET |
Get a single cardiac metric event /cardiac_events/{event_xid} |
|
| GET |
Get cardiac metrics events for a user /users/@me/cardiac_events |
|
| Generic | ||
| POST |
Creates a new generic event for the user /users/@me/generic_events |
Generic event is recommended as a means to post app specific user actions to the user's feed. |
| DELETE |
Delete a generic event /generic_events/{xid} |
Deletes an existing generic event. The event must have been created by the partner for this call to succeed. |
| GET |
Get a generic event for the user /users/@me/generic_events |
Returns the list of generic events of the current user. This list can be paginated by date or timestamp. |
| Meals | ||
| POST |
Create new meal /users/@me/meals |
|
| DELETE |
Delete single meal event /meals/{xid} |
Deletes an existing meal event. The event must have been created by the partner for this call to succeed. |
| GET |
Get information about specific meal /meals/{xid} |
Returns detailed information about a specific meal |
| GET |
Get user's meal list /users/@me/meals |
Returns the list of meals of the current user. This list can be paginated by date or timestamp. |
| POST |
Update a meal /meals/{xid}/partialUpdate |
|
| Workouts | ||
| POST |
Create workout /users/@me/workouts |
|
| DELETE |
Delete workout event /workouts/{xid} |
Deletes an existing workout event. The event must have been created by the partner for this call to succeed. |
| GET |
Get information about a specific workout /workouts/{xid} |
Returns detailed information about the given workout. |
| GET |
Get the user's workout graphs /workouts/{xid}/image |
|
| GET |
Get the user's workout list /users/@me/workouts |
Returns the list of workouts of the current user. This list can be paginated by date or timestamp. |
| GET |
Get workout intensity /workouts/{xid}/snapshot |
Returns a time-series of the workout intensity during the day. Each entry is a tuple that contains a timestamp, and the average intensity during that period. Currently, it's an… |
| POST |
Update workout /workouts/{xid}/partialUpdate |
Updates an existing workout. |
| Body | ||
| POST |
Create event to record body metrics /users/@me/body_events |
|
| DELETE |
Delete a single weight metric event /body_events/{event_xid} |
Deletes an existing event. The event must have been created by the partner for this call to succeed. |
| GET |
Get a single body composition metric event /body_events/{event_xid} |
|
| GET |
Get body metrics record events /users/@me/body_events |
|
| Sleeps | ||
| POST |
Create sleep /users/@me/sleeps |
Creates a new sleep |
| GET |
Get sleep phases /sleeps/{xid}/snapshot |
A sleep period can be sub-divided into phases: awake, light and deep. This endpoint returns a time-series of the sleep phase during the period. Each entry is a tuple that… |
| GET |
Get sleep period information /sleeps/{xid} |
Returns detailed information about the given sleep period denoted by xid. |
| GET |
Get user's sleep graphs /sleeps/{xid}/image |
Returns the image of the given sleep. |
| GET |
Get user's sleep /users/@me/sleeps |
Returns the list of sleeps of the current user. This list can be paginated by date or timestamp. |
Jawbone UP pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|