Get a Recipe

Gets recipe information by the recipe identifier or by URL

get
Get Recipe

https://api.whisk.com/recipe/v2/get?id=
Request
Response
Request
Path Parameters
id
required
string
Recipe Id or URL. (can be a path or a query param id)
fields
optional
array
Extra fields to return on the recipe. The options are: normalizedIngredients, instructions, instructionIntents,nutrition, nutritionCoverage, saved
servings
optional
number
Scale normalizedIngredients amounts to the requested number of servings
scale
optional
number
Multiplier for ingredients amounts in recipe: 0.5, 2, ...
Response
200: OK
{
"recipe": {
"id": "10166b9b5f457863f73ae1309b2fdf9470b78d75d39",
"name": "Omelette pancakes with tomato & pepper sauce",
"description": "Healthy, low-calorie and gluten-free - these herby egg 'pancakes' will become your go-to favourite for a quick midweek meal",
"ingredients": [
{
"text": "4 large eggs"
},
...
{
"text": "wholemeal bread or salad leaves, to serve"
}
],
"images": [
{
"responsive": {
"url": "https://whisk-res.cloudinary.com/image/upload/v1523012138/recipe/758058656142eaae402f1781e18c527c.jpg",
"width": 454,
"height": 500
},
"url": "https://whisk-res.cloudinary.com/image/upload/v1523012138/recipe/758058656142eaae402f1781e18c527c.jpg"
}
],
"source": {
"name": "bbcgoodfood.com",
"display_name": "BBC Good Food",
"source_recipe_url": "https://www.bbcgoodfood.com/recipes/omelette-pancakes-tomato-pepper-sauce",
"image": {
"responsive": {
"url": "https://whisk-res.cloudinary.com/image/upload/publishers/logos/bbcgoodfood-logo.png",
"width": 256,
"height": 256
},
"url": "https://whisk-res.cloudinary.com/image/upload/publishers/logos/bbcgoodfood-logo.png"
},
"license": "LICENCE_FAIRUSE"
},
"servings": 2,
"durations": {
"cook_time": 20,
"prep_time": 10,
"total_time": 30
},
"nutrition": {
"status": "STATUS_AVAILABLE",
"total": [
{
"label": "Carbohydrate Total",
"code": "NUTRITION_CODE_CHOCDF",
"value": 22,
"unit": "NUTRITION_UNIT_G"
},
...
{
"name": "diabetes-friendly",
"display_name": "Diabetes Friendly"
}
],
"health_score": {
"value": 5.372154194041782,
"nutrients_influence": [
{
"code": "NUTRITION_CODE_FAT_UNSAT",
"influence": 0.7762592808559045,
"comment": "Strong positive impact"
},
...
{
"code": "NUTRITION_CODE_SUGAR",
"influence": -0.1876448970439361,
"comment": "Low negative impact"
}
]
},
"glycemic_index": {
"value": 42.12
},
"glycemic_load": {
"value": 7.66
}
},
"labels": {
"meal_type": [
{
"name": "main-course",
"display_name": "Main Course"
},
...
{
"name": "dinner",
"display_name": "Dinner"
}
],
"cuisine": [
{
"name": "french",
"display_name": "French"
}
],
"category": [
{
"name": "dinner",
"display_name": "Dinner"
},
{
"name": "lunch",
"display_name": "Lunch"
}
],
"technique": [
{
"name": "simmering",
"display_name": "Simmering"
},
...
{
"name": "pan-frying",
"display_name": "Pan Frying"
}
]
},
"constraints": {
"violates": {
"diets": [
"DIET_VEGAN",
"DIET_LACTO_VEGETARIAN"
],
"avoidances": [
"AVOIDANCE_YEAST",
"AVOIDANCE_GLUTEN",
"AVOIDANCE_SOYBEAN",
"AVOIDANCE_WHEAT",
"AVOIDANCE_EGG"
]
}
},
"author": {
"name": "Sara Buenfeld"
},
"language": "en"
}
}
400: Bad Request
If a recipe is not valid or couldn't be found
// Recipe ID not found
{
"code": "general.badRequest",
"message": "Can't decode recipe id: 9773cb7eca5d11dwaawe7ae7e42010a9a0035"
}
‚Äč
// Recipe URL not Found
{
"code": "recipes.unavailable",
"message": "Can't get recipe"
}

For performance reasons, we recommend including fields only when required. Doing so will make the server respond faster by only returning the essential recipe data.

Sample Request - Recipe ID

curl -X GET "https://api.whisk.com/recipe/v2/get?id=9773cb7eca5d11e7ae7e42010a9a0035" \
-H "accept: application/json" \
-H "Authorization: Token <Access-Token>"

Sample Request - URL

curl -X GET "https://api.whisk.com/recipe/v2/get?id=https%3A%2F%2Fwww.bbcgoodfood.com%2Frecipes%2Fchilli-con-carne-recipe" \
-H "Accept: application/json" \
-H "Authorization: Token <Access-Token>"