Recipe recommendations for SH

A method to fetch a set of recipes supporting a certain calorie goal

To provide diversity across recommended recipes result is shuffled for every request.

We return recipes with calories per serving matching the range from 85% to 120% from requested

Recommended integration flow is below. Let us know if it's not possible

Recommended integration flow

Swagger Spec

Get Healthy Recipes

GET https://samsung-health-api.whisk.com/health/recipe/v2/search?

Path Parameters

Name	Type	Description
meal_time*	string	Meal time for which to recommend recipes. One of MEAL_TIME_BREAKFAST,MEAL_TIME_LUNCH,MEAL_TIME_DINNER,MEAL_TIME_SNACK
calories*	number	Calorie target for selected meal, kcal
language	string	ISO 639-1 two letter language code. We return certain text fields localized. We do not perform mapping country to language. Client should select and pass language explicitly. The list of supported languages will be communicated separately. Default en
country	string	ISO 3166-1 two letter country code. We may boost certain meals depending on user's country. The list of supported countries will be communicated separately. Default US
limit*	number	Number of recipes to be returned. Max 20
response_mask*	string[]	The list of recipe fields which should be returned. We return .explicitly requested fields only to save users' traffic. Possible values are id, title, image, nutrition, recipe_link, number_of_servings

200

{
  "recipes": [
    {
      "id": "107d638402cd5cd4dcbae589a0032668444",
      "title": "French toast by Lau",
      "image": {
        "url": "https://cloudinary-cdn.whisk.com/image/upload/v1592914668/recipe/61010b3adc018e6ab6aae7051771901f.jpg"
      },
      "nutrition": {
        "nutrition": [
          {
            "amount": 1.0110000000000001,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_NIA"
          },
          {
            "amount": 0.05,
            "unit_name": "NUTRITION_UNIT_G",
            "code": "NUTRITION_CODE_FATRN"
          },
          {
            "amount": 212.29,
            "unit_name": "NUTRITION_UNIT_G",
            "code": "NUTRITION_CODE_CHOCDF"
          },
          {
            "amount": 800.76,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_CHOLE"
          },
          {
            "amount": 593.9530000000001,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_P"
          },
          {
            "amount": 326.521,
            "unit_name": "NUTRITION_UNIT_MKG",
            "code": "NUTRITION_CODE_VITA_RAE"
          },
          {
            "amount": 6.072,
            "unit_name": "NUTRITION_UNIT_MKG",
            "code": "NUTRITION_CODE_VITD"
          },
          {
            "amount": 74.66499999999999,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_MG"
          },
          {
            "amount": 0.652,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_VITB6A"
          },
          {
            "amount": 4.7219999999999995,
            "unit_name": "NUTRITION_UNIT_MKG",
            "code": "NUTRITION_CODE_VITK1"
          },
          {
            "amount": 58.717999999999996,
            "unit_name": "NUTRITION_UNIT_G",
            "code": "NUTRITION_CODE_PROCNT"
          },
          {
            "amount": 27.552,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_VITC"
          },
          {
            "amount": 460.392,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_CA"
          },
          {
            "amount": 83.40100000000001,
            "unit_name": "NUTRITION_UNIT_MKG",
            "code": "NUTRITION_CODE_FOL"
          },
          {
            "amount": 2.978,
            "unit_name": "NUTRITION_UNIT_G",
            "code": "NUTRITION_CODE_FAPU"
          },
          {
            "amount": 71.81699999999998,
            "unit_name": "NUTRITION_UNIT_G",
            "code": "NUTRITION_CODE_SUGAR"
          },
          {
            "amount": 1760.569,
            "unit_name": "NUTRITION_UNIT_KCAL",
            "code": "NUTRITION_CODE_ENERC_KCAL"
          },
          {
            "amount": 17.968,
            "unit_name": "NUTRITION_UNIT_G",
            "code": "NUTRITION_CODE_FIBTG"
          },
          {
            "amount": 69.349,
            "unit_name": "NUTRITION_UNIT_G",
            "code": "NUTRITION_CODE_FAT"
          },
          {
            "amount": 926.807,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_K"
          },
          {
            "amount": 1551.4779999999996,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_NA"
          },
          {
            "amount": 3.1229999999999998,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_ZN"
          },
          {
            "amount": 33.238,
            "unit_name": "NUTRITION_UNIT_G",
            "code": "NUTRITION_CODE_FASAT"
          },
          {
            "amount": 1.7710000000000001,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_TOCPHA"
          },
          {
            "amount": 1.0949999999999998,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_RIBF"
          },
          {
            "amount": 2.827,
            "unit_name": "NUTRITION_UNIT_MKG",
            "code": "NUTRITION_CODE_VITB12"
          },
          {
            "amount": 0.269,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_THIA"
          },
          {
            "amount": 2.662,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_FE"
          },
          {
            "amount": 6.9799999999999995,
            "unit_name": "NUTRITION_UNIT_G",
            "code": "NUTRITION_CODE_FAMS"
          }
        ]
      },
      "recipe_link": "https://app.samsungfood.com/recipes/107d638402cd5cd4dcbae589a0032668444",
      "number_of_servings": 4
    },
    ...
  ]
}

400 If some request parameter is invalid, unsupported, or out of bound

{
	"code": "general.badRequest",
	"message": "language is incorrect"
}

403: Forbidden

{
    // Response
}

500: Internal Server Error

{
    // Response
}

https://api.whisk.com/spec/#/HealthyRecipeAPI/HealthyRecipeAPI_Search

Sample Request

The example below requests five Breakfast options around 400 kcal in English language. All fields are requested.

curl -X GET "https://api.whisk.com/health/recipe/v2/search?meal_time=MEAL_TIME_BREAKFAST&calories=400&language=en&country=gb&limit=5&response_mask.paths=id&response_mask.paths=title&response_mask.paths=image&response_mask.paths=nutrition&response_mask.paths=recipe_link&response_mask.paths=number_of_servings" -H  "accept: application/json" -H "Authorization: Token %TOKEN%"

Response

Data returned in JSON. Empty strings, zero values, empty arrays and null values are not returned.

Json response example with the proper response_mask.paths specified

{
  "recipes": [
    {
      "id": "107d638402cd5cd4dcbae589a0032668444",
      "title": "French toast by Lau",
      "image": {
        "url": "https://cloudinary-cdn.whisk.com/image/upload/v1592914668/recipe/61010b3adc018e6ab6aae7051771901f.jpg"
      },
      "nutrition": {
        "nutrition": [
          {
            "amount": 1.0110000000000001,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_NIA"
          },
          {
            "amount": 0.05,
            "unit_name": "NUTRITION_UNIT_G",
            "code": "NUTRITION_CODE_FATRN"
          },
          {
            "amount": 212.29,
            "unit_name": "NUTRITION_UNIT_G",
            "code": "NUTRITION_CODE_CHOCDF"
          },
          {
            "amount": 800.76,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_CHOLE"
          },
          {
            "amount": 593.9530000000001,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_P"
          },
          {
            "amount": 326.521,
            "unit_name": "NUTRITION_UNIT_MKG",
            "code": "NUTRITION_CODE_VITA_RAE"
          },
          {
            "amount": 6.072,
            "unit_name": "NUTRITION_UNIT_MKG",
            "code": "NUTRITION_CODE_VITD"
          },
          {
            "amount": 74.66499999999999,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_MG"
          },
          {
            "amount": 0.652,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_VITB6A"
          },
          {
            "amount": 4.7219999999999995,
            "unit_name": "NUTRITION_UNIT_MKG",
            "code": "NUTRITION_CODE_VITK1"
          },
          {
            "amount": 58.717999999999996,
            "unit_name": "NUTRITION_UNIT_G",
            "code": "NUTRITION_CODE_PROCNT"
          },
          {
            "amount": 27.552,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_VITC"
          },
          {
            "amount": 460.392,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_CA"
          },
          {
            "amount": 83.40100000000001,
            "unit_name": "NUTRITION_UNIT_MKG",
            "code": "NUTRITION_CODE_FOL"
          },
          {
            "amount": 2.978,
            "unit_name": "NUTRITION_UNIT_G",
            "code": "NUTRITION_CODE_FAPU"
          },
          {
            "amount": 71.81699999999998,
            "unit_name": "NUTRITION_UNIT_G",
            "code": "NUTRITION_CODE_SUGAR"
          },
          {
            "amount": 1760.569,
            "unit_name": "NUTRITION_UNIT_KCAL",
            "code": "NUTRITION_CODE_ENERC_KCAL"
          },
          {
            "amount": 17.968,
            "unit_name": "NUTRITION_UNIT_G",
            "code": "NUTRITION_CODE_FIBTG"
          },
          {
            "amount": 69.349,
            "unit_name": "NUTRITION_UNIT_G",
            "code": "NUTRITION_CODE_FAT"
          },
          {
            "amount": 926.807,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_K"
          },
          {
            "amount": 1551.4779999999996,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_NA"
          },
          {
            "amount": 3.1229999999999998,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_ZN"
          },
          {
            "amount": 33.238,
            "unit_name": "NUTRITION_UNIT_G",
            "code": "NUTRITION_CODE_FASAT"
          },
          {
            "amount": 1.7710000000000001,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_TOCPHA"
          },
          {
            "amount": 1.0949999999999998,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_RIBF"
          },
          {
            "amount": 2.827,
            "unit_name": "NUTRITION_UNIT_MKG",
            "code": "NUTRITION_CODE_VITB12"
          },
          {
            "amount": 0.269,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_THIA"
          },
          {
            "amount": 2.662,
            "unit_name": "NUTRITION_UNIT_MG",
            "code": "NUTRITION_CODE_FE"
          },
          {
            "amount": 6.9799999999999995,
            "unit_name": "NUTRITION_UNIT_G",
            "code": "NUTRITION_CODE_FAMS"
          }
        ]
      },
      "recipe_link": "https://app.samsungfood.com/recipes/107d638402cd5cd4dcbae589a0032668444",
      "number_of_servings": 4
    },
    ...
  ]
}

Core attributes

Name	Type	Description
recipes	array	top-level container object
recipes.id	string	unique recipe identifier across Samsung Food
recipes.title	string	recipe title
recipes.nutrition	object	container object
recipes.nutrition.nutrition	array	container array
recipes.nutrition.nutrition.amount	number	amount for a certain nutrient per 1 recipe serving
recipes.nutrition.nutrition.unit_name	string	nutrient unit name, depends on the nutrient. One of NUTRITION_UNIT_G, NUTRITION_UNIT_MG, NUTRITION_UNIT_MKG, NUTRITION_UNIT_KCAL
recipes.nutrition.nutrition.code	string	nutrient code. The following nutrients are supported: NUTRITION_CODE_ENERC_KCAL: Energy, NUTRITION_CODE_FAT: Total Fat, NUTRITION_CODE_FASAT: Saturated Fat, NUTRITION_CODE_CHOCDF: Carbohydrate Total, NUTRITION_CODE_SUGAR: Sugars, NUTRITION_CODE_PROCNT: Protein, NUTRITION_CODE_NA: Sodium, NUTRITION_CODE_FIBTG: Fiber, NUTRITION_CODE_FATRN: Trans Fat, NUTRITION_CODE_FAMS: Monounsaturated Fat, NUTRITION_CODE_FAPU: Polyunsaturated Fat, NUTRITION_CODE_FAT_UNSAT: Unsaturated Fat, NUTRITION_CODE_CHOLE: Cholesterol, NUTRITION_CODE_CA: Calcium, NUTRITION_CODE_MG: Magnesium, NUTRITION_CODE_K: Potassium, NUTRITION_CODE_FE: Iron, NUTRITION_CODE_ZN: Zinc, NUTRITION_CODE_P: Phosphorus, NUTRITION_CODE_VITA_RAE: Vitamin A, NUTRITION_CODE_VITC: Vitamin C, NUTRITION_CODE_THIA: Thiamin B1, NUTRITION_CODE_RIBF: Riboflavin B2, NUTRITION_CODE_NIA: Niacin B3, NUTRITION_CODE_VITB6A: Vitamin B6, NUTRITION_CODE_FOL: Folic Acid B9, NUTRITION_CODE_VITB12: Vitamin B12, NUTRITION_CODE_VITD: Vitamin D, NUTRITION_CODE_TOCPHA: Vitamin E, NUTRITION_CODE_VITK1: Vitamin K
recipes.image	object	container object
recipes.image.url	string	Image url leading to Samsung Food CDN
recipes.recipe_link	array	A link to the recipe on Samsung Food
recipes.number_of_servings	array	Default number of serving for the recipe