Guides

Welcome
Authentication
OAuth 2.0
OAuth 1.0
3-Legged OAuth
Data Types
Storable Data
Error Codes
Localization*

Method Overview
Foods
food.find_id_for_barcode*
food.get.v2
food.get (deprecated)
foods.autocomplete*
foods.search.v2*
foods.search
Food Brands
food_brands.get*
Food Categories
food_categories.get*
Food Sub Categories
food_sub_categories.get*
Recipes
recipe.get.v2
recipe.get
recipes.search.v3
recipes.search.v2
recipes.search
Recipe Types
recipe_types.get.v2
recipe_types.get

API Method Reference (OAuth 1.0)

Method Overview
Foods
food.add_favorite
food.create.v2*
food.create* (deprecated)
food.delete_favorite
food.find_id_for_barcode*
food.get.v2
food.get (deprecated)
foods.autocomplete*
foods.get_favorites
foods.get_most_eaten
foods.get_recently_eaten
foods.search.v2*
foods.search
Food Brands
food_brands.get*
Food Categories
food_categories.get*
Food Sub Categories
food_sub_categories.get*
Recipes
recipe.add_favorite
recipe.delete_favorite
recipe.get.v2
recipe.get
recipes.get_favorites
recipes.search.v3
recipes.search.v2
recipes.search
Recipe Types
recipe_types.get.v2
recipe_types.get
Saved Meals
saved_meal.create
saved_meal.delete
saved_meal.edit
saved_meals.get
saved_meal_item.add
saved_meal_item.delete
saved_meal_item.edit
saved_meal_items.get
Exercises
exercises.get
Profile - Management
profile.create
profile.get
profile.get_auth
Profile - Food Diary
food_entries.copy
food_entries.copy_saved_meal
food_entries.get
food_entries.get_month
food_entry.create
food_entry.delete
food_entry.edit
Profile - Exercise Diary
exercise_entries.commit_day
exercise_entries.get
exercise_entries.get_month
exercise_entries.save_template
exercise_entry.edit
Profile - Weight Diary
weight.update
weights.get_month

* denotes methods only available at the PREMIER level

Developers

REST API

API Method Reference (OAuth 1): food_brands.get

food_brands.get

Description

This is a utility method, returning the list of food brands.

Parameters

Required

Name	Type	Description
oauth_consumer_key	String	Your API key when you registered as a developer
oauth_signature_method	String	The method used to generate the signature (only HMAC-SHA1 is supported)
oauth_timestamp	Int	The date and time, expressed in the number of seconds since January 1, 1970 00:00:00 GMT. The timestamp value must be a positive integer and must be equal or greater than the timestamp used in previous requests
oauth_nonce	String	A randomly generated string for a request that can be combined with the timestamp to produce a unique value
oauth_version	String	MUST be "1.0"
oauth_signature	String	The signature, a consistent reproducible concatenation of the request elements into a single string. The string is used as an input in hashing or signing algorithms.
method	String	MUST be "food_brands.get"

Optional

Name	Type	Description
format	String	The desired response format. Valid reponse formats are "xml" or "json" (default value is "xml").
starts_with	String	Food brands that begin with the first letter is returned. The "*" will return all food brands beginning with a numeric character. If this is not specified then the most popular food brands at the time is returned. E.G.: "Kraft" will return all food brands beginning "k"
brand_type	String	The type of brand to return. Valid brand types are "manufacturer", "restaurant" and "supermarket" (default value is "manufacturer")

Example Return XML

<?xml version="1.0" encoding="utf-8" ?>

<food_brands xmlns="http://platform.fatsecret.com/api/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://platform.fatsecret.com/api/1.0/ http://platform.fatsecret.com/api/1.0/fatsecret.xsd">

<food_brand>Kraft</food_brand>

</food_brands>

Example Return JSON

{ "food_brands": {"food_brand": "Kraft" }}

Error Code

Code	Description
2	Missing required oauth parameter: "<detail>"
3	Unsupported oauth parameter: "<detail>"
4	Invalid signature method: "<detail>"
5	Invalid consumer key: "<detail>"
6	Invalid/expired timestamp: "<detail>"
7	Invalid/used nonce: "<detail>"
8	Invalid signature: "<detail>"
108	Invalid Type: "<detail>"