fitbit_web_api.NutritionApi

All URIs are relative to https://api.fitbit.com/

Method	HTTP request	Description
add_favorite_food	POST /1/user/-/foods/log/favorite/{food-id}.json	Add Favorite Food
add_foods	POST /1/user/-/foods.json	Create Food
add_foods_log	POST /1/user/-/foods/log.json	Log Food
add_meal	POST /1/user/-/meals.json	Create Meal
add_update_foods_goal	POST /1/user/-/foods/log/goal.json	Update Food Goal
add_update_water_goal	POST /1/user/-/foods/log/water/goal.json	Update Water Goal
add_water_log	POST /1/user/-/foods/log/water.json	Log Water
delete_favorite_food	DELETE /1/user/-/foods/log/favorite/{food-id}.json	Delete Favorite Food
delete_foods	DELETE /1/user/-/foods/{food-id}.json	Delete Custom Food
delete_foods_log	DELETE /1/user/-/foods/log/{food-log-id}.json	Delete Food Log
delete_meal	DELETE /1/user/-/meals/{meal-id}.json	Delete Meal
delete_water_log	DELETE /1/user/-/foods/log/water/{water-log-id}.json	Delete Water Log
edit_foods_log	POST /1/user/-/foods/log/{food-log-id}.json	Edit Food Log
get_favorite_foods	GET /1/user/-/foods/log/favorite.json	Get Favorite Foods
get_foods_by_date	GET /1/user/-/foods/log/date/{date}.json	Get Food Logs
get_foods_goal	GET /1/user/-/foods/log/goal.json	Get Food Goals
get_foods_info	GET /1/foods/{food-id}.json	Get Food
get_foods_list	GET /1/foods/search.json	Search Foods
get_foods_locales	GET /1/foods/locales.json	Get Food Locales
get_foods_units	GET /1/foods/units.json	Get Food Units
get_frequent_foods	GET /1/user/-/foods/log/frequent.json	Get Frequent Foods
get_meals	GET /1/user/-/meals.json	Get Meals
get_recent_foods	GET /1/user/-/foods/log/recent.json	Get Recent Foods
get_water_by_date	GET /1/user/-/foods/log/water/date/{date}.json	Get Water Logs
get_water_goal	GET /1/user/-/foods/log/water/goal.json	Get Water Goal
update_meal	POST /1/user/-/meals/{meal-id}.json	Update Meal
update_water_log	POST /1/user/-/foods/log/water/{water-log-id}.json	Update Water Log

add_favorite_food

add_favorite_food(food_id)

Add Favorite Food

Updates a user's daily activity goals and returns a response using units in the unit system which corresponds to the Accept-Language header provided.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))
food_id = 'food_id_example' # str | The ID of the food to be added to user's favorites.

try:
    # Add Favorite Food
    api_instance.add_favorite_food(food_id)
except ApiException as e:
    print("Exception when calling NutritionApi->add_favorite_food: %s\n" % e)

Parameters

Name	Type	Description	Notes
food_id	str	The ID of the food to be added to user's favorites.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

add_foods

add_foods(name, default_food_measurement_unit_id, default_serving_size, calories, form_type=form_type, description=description)

Create Food

Creates a new private food for a user and returns a response in the format requested. The created food is found via the Search Foods call.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))
name = 'name_example' # str | The food name.
default_food_measurement_unit_id = 'default_food_measurement_unit_id_example' # str | The ID of the default measurement unit. Full list of units can be retrieved via the Get Food Units endpoint.
default_serving_size = 'default_serving_size_example' # str | The size of the default serving. Nutrition values should be provided for this serving size.
calories = 'calories_example' # str | The calories in the default serving size.
form_type = 'form_type_example' # str | Form type; LIQUID or DRY. (optional)
description = 'description_example' # str | The description of the food. (optional)

try:
    # Create Food
    api_instance.add_foods(name, default_food_measurement_unit_id, default_serving_size, calories, form_type=form_type, description=description)
except ApiException as e:
    print("Exception when calling NutritionApi->add_foods: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	The food name.
default_food_measurement_unit_id	str	The ID of the default measurement unit. Full list of units can be retrieved via the Get Food Units endpoint.
default_serving_size	str	The size of the default serving. Nutrition values should be provided for this serving size.
calories	str	The calories in the default serving size.
form_type	str	Form type; LIQUID or DRY.	[optional]
description	str	The description of the food.	[optional]

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

add_foods_log

add_foods_log(food_id, meal_type_id, unit_id, amount, _date, food_name=food_name, favorite=favorite, brand_name=brand_name, calories=calories)

Log Food

Creates food log entries for users with or without foodId value.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))
food_id = 'food_id_example' # str | The ID of the food to be logged. Either foodId or foodName must be provided.
meal_type_id = 'meal_type_id_example' # str | Meal types. 1=Breakfast; 2=Morning Snack; 3=Lunch; 4=Afternoon Snack; 5=Dinner; 7=Anytime.
unit_id = 'unit_id_example' # str | The ID of units used. Typically retrieved via a previous call to Get Food Logs, Search Foods, or Get Food Units.
amount = 'amount_example' # str | The amount consumed in the format X.XX in the specified unitId.
_date = '2013-10-20' # date | Log entry date in the format yyyy-MM-dd.
food_name = 'food_name_example' # str | Food entry name. Either foodId or foodName must be provided. (optional)
favorite = true # bool | The `true` value will add the food to the user's favorites after creating the log entry; while the `false` value will not. Valid only with foodId value. (optional)
brand_name = 'brand_name_example' # str | Brand name of food. Valid only with foodName parameters. (optional)
calories = 56 # int | Calories for this serving size. This is allowed with foodName parameter (default to zero); otherwise it is ignored. (optional)

try:
    # Log Food
    api_instance.add_foods_log(food_id, meal_type_id, unit_id, amount, _date, food_name=food_name, favorite=favorite, brand_name=brand_name, calories=calories)
except ApiException as e:
    print("Exception when calling NutritionApi->add_foods_log: %s\n" % e)

Parameters

Name	Type	Description	Notes
food_id	str	The ID of the food to be logged. Either foodId or foodName must be provided.
meal_type_id	str	Meal types. 1=Breakfast; 2=Morning Snack; 3=Lunch; 4=Afternoon Snack; 5=Dinner; 7=Anytime.
unit_id	str	The ID of units used. Typically retrieved via a previous call to Get Food Logs, Search Foods, or Get Food Units.
amount	str	The amount consumed in the format X.XX in the specified unitId.
_date	date	Log entry date in the format yyyy-MM-dd.
food_name	str	Food entry name. Either foodId or foodName must be provided.	[optional]
favorite	bool	The `true` value will add the food to the user's favorites after creating the log entry; while the `false` value will not. Valid only with foodId value.	[optional]
brand_name	str	Brand name of food. Valid only with foodName parameters.	[optional]
calories	int	Calories for this serving size. This is allowed with foodName parameter (default to zero); otherwise it is ignored.	[optional]

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

add_meal

add_meal(body)

Create Meal

Creates a meal with the given food contained in the post body.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))
body = fitbit_web_api.Meal() # Meal | Meal to create

try:
    # Create Meal
    api_instance.add_meal(body)
except ApiException as e:
    print("Exception when calling NutritionApi->add_meal: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Meal	Meal to create

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

add_update_foods_goal

add_update_foods_goal(calories, intensity=intensity, personalized=personalized)

Update Food Goal

Updates a user's daily calories consumption goal or food plan and returns a response in the format requested.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))
calories = 56 # int | Manual calorie consumption goal in either calories or intensity must be provided.
intensity = 'intensity_example' # str | Food plan intensity (MAINTENANCE, EASIER, MEDIUM, KINDAHARD, or HARDER). Either calories or intensity must be provided. (optional)
personalized = 'personalized_example' # str | Food plan type; true or false. (optional)

try:
    # Update Food Goal
    api_instance.add_update_foods_goal(calories, intensity=intensity, personalized=personalized)
except ApiException as e:
    print("Exception when calling NutritionApi->add_update_foods_goal: %s\n" % e)

Parameters

Name	Type	Description	Notes
calories	int	Manual calorie consumption goal in either calories or intensity must be provided.
intensity	str	Food plan intensity (MAINTENANCE, EASIER, MEDIUM, KINDAHARD, or HARDER). Either calories or intensity must be provided.	[optional]
personalized	str	Food plan type; true or false.	[optional]

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

add_update_water_goal

add_update_water_goal(target)

Update Water Goal

Updates a user's daily calories consumption goal or food plan and returns a response in the format requested.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))
target = 56 # int | The target water goal in the format X.X is set in unit based on locale.

try:
    # Update Water Goal
    api_instance.add_update_water_goal(target)
except ApiException as e:
    print("Exception when calling NutritionApi->add_update_water_goal: %s\n" % e)

Parameters

Name	Type	Description	Notes
target	int	The target water goal in the format X.X is set in unit based on locale.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

add_water_log

add_water_log(_date, amount, unit=unit)

Log Water

Creates a log entry for water using units in the unit systems that corresponds to the Accept-Language header provided.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))
_date = '2013-10-20' # date | The date of records to be returned in the format yyyy-MM-dd.
amount = 56 # int | The amount consumption in the format X.XX and in the specified waterUnit or in the unit system that corresponds to the Accept-Language header provided.
unit = 'unit_example' # str | Water measurement unit; `ml`, `fl oz`, or `cup`. (optional)

try:
    # Log Water
    api_instance.add_water_log(_date, amount, unit=unit)
except ApiException as e:
    print("Exception when calling NutritionApi->add_water_log: %s\n" % e)

Parameters

Name	Type	Description	Notes
_date	date	The date of records to be returned in the format yyyy-MM-dd.
amount	int	The amount consumption in the format X.XX and in the specified waterUnit or in the unit system that corresponds to the Accept-Language header provided.
unit	str	Water measurement unit; `ml`, `fl oz`, or `cup`.	[optional]

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_favorite_food

delete_favorite_food(food_id)

Delete Favorite Food

Deletes a food with the given ID to the user's list of favorite foods.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))
food_id = 'food_id_example' # str | The ID of the food to be deleted from user's favorites.

try:
    # Delete Favorite Food
    api_instance.delete_favorite_food(food_id)
except ApiException as e:
    print("Exception when calling NutritionApi->delete_favorite_food: %s\n" % e)

Parameters

Name	Type	Description	Notes
food_id	str	The ID of the food to be deleted from user's favorites.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_foods

delete_foods(food_id)

Delete Custom Food

Deletes custom food for a user and returns a response in the format requested.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))
food_id = 'food_id_example' # str | The ID of the food to be deleted.

try:
    # Delete Custom Food
    api_instance.delete_foods(food_id)
except ApiException as e:
    print("Exception when calling NutritionApi->delete_foods: %s\n" % e)

Parameters

Name	Type	Description	Notes
food_id	str	The ID of the food to be deleted.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_foods_log

delete_foods_log(food_log_id)

Delete Food Log

Deletes a user's food log entry with the given ID.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))
food_log_id = 'food_log_id_example' # str | The ID of the food log entry to be deleted.

try:
    # Delete Food Log
    api_instance.delete_foods_log(food_log_id)
except ApiException as e:
    print("Exception when calling NutritionApi->delete_foods_log: %s\n" % e)

Parameters

Name	Type	Description	Notes
food_log_id	str	The ID of the food log entry to be deleted.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_meal

delete_meal(meal_id)

Delete Meal

Deletes a user's meal with the given meal id.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))
meal_id = 'meal_id_example' # str | Id of the meal to delete.

try:
    # Delete Meal
    api_instance.delete_meal(meal_id)
except ApiException as e:
    print("Exception when calling NutritionApi->delete_meal: %s\n" % e)

Parameters

Name	Type	Description	Notes
meal_id	str	Id of the meal to delete.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_water_log

delete_water_log(water_log_id)

Delete Water Log

Deletes a user's water log entry with the given ID.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))
water_log_id = 'water_log_id_example' # str | The ID of the waterUnit log entry to be deleted.

try:
    # Delete Water Log
    api_instance.delete_water_log(water_log_id)
except ApiException as e:
    print("Exception when calling NutritionApi->delete_water_log: %s\n" % e)

Parameters

Name	Type	Description	Notes
water_log_id	str	The ID of the waterUnit log entry to be deleted.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_foods_log

edit_foods_log(food_log_id, meal_type_id, unit_id, amount, calories=calories)

Edit Food Log

The Edit Food Log endpoint changes the quantity or calories consumed for a user's food log entry with the given Food Log ID.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))
food_log_id = 'food_log_id_example' # str | The ID of the food log entry to be edited.
meal_type_id = 'meal_type_id_example' # str | Meal types. 1=Breakfast; 2=Morning Snack; 3=Lunch; 4=Afternoon Snack; 5=Dinner; 7=Anytime.
unit_id = 'unit_id_example' # str | The ID of units used. Typically retrieved via a previous call to Get Food Logs, Search Foods, or Get Food Units.
amount = 'amount_example' # str | The amount consumed in the format X.XX in the specified unitId.
calories = 56 # int | Calories for this serving size. This is allowed with foodName parameter (default to zero); otherwise it is ignored. (optional)

try:
    # Edit Food Log
    api_instance.edit_foods_log(food_log_id, meal_type_id, unit_id, amount, calories=calories)
except ApiException as e:
    print("Exception when calling NutritionApi->edit_foods_log: %s\n" % e)

Parameters

Name	Type	Description	Notes
food_log_id	str	The ID of the food log entry to be edited.
meal_type_id	str	Meal types. 1=Breakfast; 2=Morning Snack; 3=Lunch; 4=Afternoon Snack; 5=Dinner; 7=Anytime.
unit_id	str	The ID of units used. Typically retrieved via a previous call to Get Food Logs, Search Foods, or Get Food Units.
amount	str	The amount consumed in the format X.XX in the specified unitId.
calories	int	Calories for this serving size. This is allowed with foodName parameter (default to zero); otherwise it is ignored.	[optional]

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_favorite_foods

get_favorite_foods()

Get Favorite Foods

Returns a list of a user's favorite foods in the format requested. A favorite food in the list provides a quick way to log the food via the Log Food endpoint.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))

try:
    # Get Favorite Foods
    api_instance.get_favorite_foods()
except ApiException as e:
    print("Exception when calling NutritionApi->get_favorite_foods: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_foods_by_date

get_foods_by_date(_date)

Get Food Logs

Retreives a summary and list of a user's food log entries for a given day in the format requested.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))
_date = '2013-10-20' # date | The date of records to be returned. In the format yyyy-MM-dd.

try:
    # Get Food Logs
    api_instance.get_foods_by_date(_date)
except ApiException as e:
    print("Exception when calling NutritionApi->get_foods_by_date: %s\n" % e)

Parameters

Name	Type	Description	Notes
_date	date	The date of records to be returned. In the format yyyy-MM-dd.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_foods_goal

get_foods_goal()

Get Food Goals

Returns a user's current daily calorie consumption goal and/or foodPlan value in the format requested.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))

try:
    # Get Food Goals
    api_instance.get_foods_goal()
except ApiException as e:
    print("Exception when calling NutritionApi->get_foods_goal: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_foods_info

get_foods_info(food_id)

Get Food

Returns the details of a specific food in the Fitbit food databases or a private food that an authorized user has entered in the format requested.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))
food_id = 'food_id_example' # str | The ID of the food.

try:
    # Get Food
    api_instance.get_foods_info(food_id)
except ApiException as e:
    print("Exception when calling NutritionApi->get_foods_info: %s\n" % e)

Parameters

Name	Type	Description	Notes
food_id	str	The ID of the food.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_foods_list

get_foods_list(query)

Search Foods

Returns a list of public foods from the Fitbit food database and private food the user created in the format requested.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))
query = 'query_example' # str | The URL-encoded search query.

try:
    # Search Foods
    api_instance.get_foods_list(query)
except ApiException as e:
    print("Exception when calling NutritionApi->get_foods_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
query	str	The URL-encoded search query.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_foods_locales

get_foods_locales()

Get Food Locales

Returns the food locales that the user may choose to search, log, and create food in.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))

try:
    # Get Food Locales
    api_instance.get_foods_locales()
except ApiException as e:
    print("Exception when calling NutritionApi->get_foods_locales: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_foods_units

get_foods_units()

Get Food Units

Returns a list of all valid Fitbit food units in the format requested.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))

try:
    # Get Food Units
    api_instance.get_foods_units()
except ApiException as e:
    print("Exception when calling NutritionApi->get_foods_units: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_frequent_foods

get_frequent_foods()

Get Frequent Foods

Returns a list of a user's frequent foods in the format requested. A frequent food in the list provides a quick way to log the food via the Log Food endpoint.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))

try:
    # Get Frequent Foods
    api_instance.get_frequent_foods()
except ApiException as e:
    print("Exception when calling NutritionApi->get_frequent_foods: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_meals

get_meals()

Get Meals

Returns a list of meals created by user in the user's food log in the format requested. User creates and manages meals on the Food Log tab on the website.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))

try:
    # Get Meals
    api_instance.get_meals()
except ApiException as e:
    print("Exception when calling NutritionApi->get_meals: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_recent_foods

get_recent_foods()

Get Recent Foods

Returns a list of a user's frequent foods in the format requested. A frequent food in the list provides a quick way to log the food via the Log Food endpoint.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))

try:
    # Get Recent Foods
    api_instance.get_recent_foods()
except ApiException as e:
    print("Exception when calling NutritionApi->get_recent_foods: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_water_by_date

get_water_by_date(_date)

Get Water Logs

Retreives a summary and list of a user's water log entries for a given day in the requested using units in the unit system that corresponds to the Accept-Language header provided.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))
_date = '2013-10-20' # date | The date of records to be returned. In the format yyyy-MM-dd.

try:
    # Get Water Logs
    api_instance.get_water_by_date(_date)
except ApiException as e:
    print("Exception when calling NutritionApi->get_water_by_date: %s\n" % e)

Parameters

Name	Type	Description	Notes
_date	date	The date of records to be returned. In the format yyyy-MM-dd.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_water_goal

get_water_goal()

Get Water Goal

Retreives a summary and list of a user's water goal entries for a given day in the requested using units in the unit system that corresponds to the Accept-Language header provided.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))

try:
    # Get Water Goal
    api_instance.get_water_goal()
except ApiException as e:
    print("Exception when calling NutritionApi->get_water_goal: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_meal

update_meal(body)

Update Meal

Replaces an existing meal with the contents of the request. The response contains the updated meal.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))
body = fitbit_web_api.Meal() # Meal | Meal to create

try:
    # Update Meal
    api_instance.update_meal(body)
except ApiException as e:
    print("Exception when calling NutritionApi->update_meal: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Meal	Meal to create

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_water_log

update_water_log(water_log_id, amount, unit=unit)

Update Water Log

Updates a user's water log entry with the given ID.

Example

from __future__ import print_function
import time
import fitbit_web_api
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = fitbit_web_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fitbit_web_api.NutritionApi(fitbit_web_api.ApiClient(configuration))
water_log_id = 'water_log_id_example' # str | The ID of the waterUnit log entry to be deleted.
amount = 'amount_example' # str | Amount consumed; in the format X.X and in the specified waterUnit or in the unit system that corresponds to the Accept-Language header provided.
unit = 'unit_example' # str | Water measurement unit. 'ml', 'fl oz', or 'cup'. (optional)

try:
    # Update Water Log
    api_instance.update_water_log(water_log_id, amount, unit=unit)
except ApiException as e:
    print("Exception when calling NutritionApi->update_water_log: %s\n" % e)

Parameters

Name	Type	Description	Notes
water_log_id	str	The ID of the waterUnit log entry to be deleted.
amount	str	Amount consumed; in the format X.X and in the specified waterUnit or in the unit system that corresponds to the Accept-Language header provided.
unit	str	Water measurement unit. 'ml', 'fl oz', or 'cup'.	[optional]

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

NutritionApi.md

Latest commit

History

NutritionApi.md

File metadata and controls

fitbit_web_api.NutritionApi

add_favorite_food

Example

Parameters

Return type

Authorization

HTTP request headers

add_foods

Example

Parameters

Return type

Authorization

HTTP request headers

add_foods_log

Example

Parameters

Return type

Authorization

HTTP request headers

add_meal

Example

Parameters

Return type

Authorization

HTTP request headers

add_update_foods_goal

Example

Parameters

Return type

Authorization

HTTP request headers

add_update_water_goal

Example

Parameters

Return type

Authorization

HTTP request headers

add_water_log

Example

Parameters

Return type

Authorization

HTTP request headers

delete_favorite_food

Example

Parameters

Return type

Authorization

HTTP request headers

delete_foods

Example

Parameters

Return type

Authorization

HTTP request headers

delete_foods_log

Example

Parameters

Return type

Authorization

HTTP request headers

delete_meal

Example

Parameters

Return type

Authorization

HTTP request headers

delete_water_log

Example

Parameters

Return type

Authorization

HTTP request headers

edit_foods_log