fatsecret Platform API Documentation

NAME	TYPE	REQUIRED	DESCRIPTION
URL (new) Method	N/A	Required	"https://platform.fatsecret.com/rest/brands/v2" HTTP "GET"
OR
method	String	Required	"food_brands.get.v2" (included with other parameters)

Additional Parameters

NAME	TYPE	REQUIRED	DESCRIPTION
starts_with	String	Required	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
brand_type	String	Optional	Either "manufacturer", "restaurant" or "supermarket" (default value is "manufacturer")
region	String	Optional	Results will be filtered by region. E.G.: "FR" returns results from France. If not specified this will default to "US" (United States). Click here for full documentation on localization.
language	String	Optional	(Ignored unless region is also specified) Results will be in the specified language. E.G.: "fr" returns results in French
format	String	Optional	The desired response format. Valid response formats are "xml" or "json" (default value is "xml").

Scopes for OAuth2 integration: premier

Response

There are no storable values returned by this call.

Each food_brands element contains information as follows:

NAME	TYPE	DESCRIPTION
food_brand	String	Brand of the food

Example Response

Example 1:

<?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 1:

{
  "food_brands": {
    "food_brand": [
      "Kraft"
    ]
  }
}

Error Codes

CODE	TYPE	DESCRIPTION
2	OAuth 1.0	Missing required oauth parameter: '<details>'
3	OAuth 1.0	Unsupported oauth parameter: '<details>'
4	OAuth 1.0	Invalid signature method: '<details>'
5	OAuth 1.0	Invalid consumer key: '<details>'
6	OAuth 1.0	Invalid/expired timestamp: '<details>'
7	OAuth 1.0	Invalid/used nonce: '<details>'
8	OAuth 1.0	Invalid signature: '<details>'
9	OAuth 1.0	Invalid access token: '<details>'
13	OAuth 2.0	Invalid token: '<details>'
14	OAuth 2.0	Missing scope: '<details>'
108	Parameter	Invalid Type: '<details>'