FatSecret Platform API Documentation

⚠️ This is version has been deprecated. Please upgrade to the latest version.

Profile - Recipes: Get All Favorites

Description

Returns the favorite recipes for the specified user.

Parameters

All

NAME	TYPE	REQUIRED	DESCRIPTION
method	String	Required	MUST be "recipe.get_favorites"
format	String	Optional	The desired response format. Valid response formats are "xml" or "json" (default value is "xml").

Response

The only storable value returned by this call is recipe_id.

Each recipe element contains information as follows:

NAME	TYPE	DESCRIPTION
recipe_id	Long	Unique recipe identifier
recipe_name	Long	Name of the recipe
recipe_url	String	URL of this recipe item on www.fatsecret.com
recipe_description	String	A short description of the recipe
recipe_image	String	URL of this image on www.fatsecret.com

Example Response

⚠️ Response json is only in array format when more than one object is returned

Example 1:

<?xml version="1.0" encoding="utf-8"?>
<recipes 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">
  <recipe>
    <recipe_id>91</recipe_id>
    <recipe_name>Baked Lemon Snapper</recipe_name>
    <recipe_url>http://www.fatsecret.com/recipes/baked-lemon-snapper/Default.aspx</recipe_url>
    <recipe_description>Healthy fish with a tasty sauce.</recipe_description>
    <recipe_image>http://www.fatsecret.com/static/recipe/bf0c5912-9cf8-4e7a-b07a-6703c4b77082.jpg</recipe_image>
  </recipe>
</recipes>

Example 1:

{
  "recipes": {
    "recipe": {
      "recipe_description": "Healthy fish with a tasty sauce.",
      "recipe_id": "91",
      "recipe_image": "http://www.fatsecret.com/static/recipe/bf0c5912-9cf8-4e7a-b07a-6703c4b77082.jpg",
      "recipe_name": "Baked Lemon Snapper",
      "recipe_url": "http://www.fatsecret.com/recipes/baked-lemon-snapper/Default.aspx"
    }
  }
}

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>'