Recipe Search API Documentation

We have released the Recipe Search V2! The changelog for this new version can be found here Recipe Search API V2 Changelog. We are currently continuing to support the older version of the Recipe Search API.

 

The above OpenAPI specification for our API can be found here.
More information on OpenAPI can be found at: https://swagger.io/.

HTTP Compression

Edamam servers support standard HTTP compression using gzip. Using compression can reduce the size of the response and thus, increase the transfer speed.

The client can include the following header, to indicate what compression methods it supports:

Accept-Encoding: gzip

The server, then will include the following header to indicate the compressed response

Content-Encoding: gzip

or it will omit it, if the response is not compressed.

For more information see here: http://en.wikipedia.org/wiki/Http_compression

Nutrient Guide

The list of all of the nutrients that may be contained as part of a recipe’s nutritional information under the totalNutrients and the totalDaily section of the response. totalNutrients is the absolute nutrient amount, while totalDaily is the percent of daily recommended nutrient intake.

NTR Code Name Unit
CA Calcium mg
ENERC_KCAL Energy kcal
CHOCDF Carbs g
NIA Niacin (B3) mg
CHOLE Cholesterol mg
P Phosphorus mg
FAMS Monounsaturated g
PROCNT Protein g
FAPU Polyunsaturated g
RIBF Riboflavin (B2) mg
FASAT Saturated g
SUGAR Sugars g
FAT Fat g
THIA Thiamin (B1) mg
FATRN Trans g
TOCPHA Vitamin E mg
FE Iron mg
VITA_RAE Vitamin A æg
FIBTG Fiber g
VITB12 Vitamin B12 æg
FOLDFE Folate (Equivalent) æg
VITB6A Vitamin B6 mg
K Potassium mg
VITC Vitamin C mg
MG Magnesium mg
VITD Vitamin D æg
NA Sodium mg
VITK1 Vitamin K æg

Nutrient Structure

The structure of the Nutrients based on what is under the totalNutrients and totalDaily sections of the response.

Field Type Description
uri string Ontology identifier
label string Display label
quantity float Quantity of specified units
unit string Units

Response Guide

Ingredient Structure

The structure of the Ingredients based on what is under the ingredients section of the response.

Please note that some plans may not include all of the fields for the ingredient object.

Field Type Description
foodId string Food identifier
quantity float Quantity of specified measure
measure Measure Measure
weight float Total weight, g
food Food Food
foodCategory string Shopping aisle category

Image Sizes

You can narrow down the recipe search by specifying the “imageSize” parameter. By specifying from the possible values: THUMBNAIL, SMALL, REGULAR, and LARGE, the search will return recipes that have the specified image size available to use, i.e. using the LARGE value will return recipes that have the Large image size available (which might not be the same results as a query without the image sizes parameter defined, due to differing availability of image resolutions.)

These different sized images can then be accessed by adding a suffix to the image file name following the table below.

Image Size Dimensions Suffix
Thumbnail 100×100 -s
Small 200×200 -m
Regular 300×300 no suffix
Large 600×600 -l

Adding no suffix gives the “regular” sized 300×300 image.

Example:

“https://www.edamam.com/web-img/1a7/example.jpg”
Returns a “regular” 300×300 image, while

“https://www.edamam.com/web-img/1a7/example-m.jpg”
Returns a “small” 200×200 image.

Diet Labels

The list of all possible Diet Labels generated from the nutrient information on the recipes. These labels describe commonly used nutrient level aspects of the recipe.

Type Web Label API Parameter Definition
Diet Balanced balanced Protein/Fat/Carb values in 15/35/50 ratio
Diet High-Fiber high-fiber More than 5g fiber per serving
Diet High-Protein high-protein More than 50% of total calories from proteins
Diet Low-Carb low-carb Less than 20% of total calories from carbs
Diet Low-Fat low-fat Less than 15% of total calories from fat
Diet Low-Sodium low-sodium Less than 140mg Na per serving

Health Labels

The list of all possible Health Labels generated from the ingredient information on the recipes. These labels describe commonly used ingredient level aspects of the recipe.

Type Web Label API Parameter Definition
Health Alcohol-free alcohol-free No alcohol used or contained
Health Immune-Supportive immuno-supportive Recipes which fit a science-based approach to eating to strengthen the immune system
Health Celery-free celery-free Does not contain celery or derivatives
Health Crustcean-free crustacean-free Does not contain crustaceans (shrimp, lobster etc.) or derivatives
Health Dairy dairy-free No dairy; no lactose
Health Eggs egg-free No eggs or products containing eggs
Health Fish fish-free No fish or fish derivatives
Health FODMAP free fodmap-free Does not contain FODMAP foods
Health Gluten gluten-free No ingredients containing gluten
Health Keto keto-friendly Maximum 7 grams of net carbs per serving
Health Kidney friendly kidney-friendly Per serving – phosphorus less than 250 mg AND potassium less than 500 mg AND sodium less than 500 mg
Health Kosher kosher Contains only ingredients allowed by the kosher diet. However it does not guarantee kosher preparation of the ingredients themselves
Health Low potassium low-potassium Less than 150mg per serving
Health Lupine-free lupine-free Does not contain lupine or derivatives
Health Mustard-free mustard-free Does not contain mustard or derivatives
Health n/a low-fat-abs Less than 3g of fat per serving
Health No oil added No-oil-added No oil added except to what is contained in the basic ingredients
Health No-sugar low-sugar No simple sugars – glucose, dextrose, galactose, fructose, sucrose, lactose, maltose
Health Paleo paleo Excludes what are perceived to be agricultural products; grains, legumes, dairy products, potatoes, refined salt, refined sugar, and processed oils
Health Peanuts peanut-free No peanuts or products containing peanuts
Health Pescatarian pecatarian Does not contain meat or meat based products, can contain dairy and fish
Health Pork-free pork-free Does not contain pork or derivatives
Health Red meat-free red-meat-free Does not contain beef, lamb, pork, duck, goose, game, horse, and other types of red meat or products containing red meat.
Health Sesame-free sesame-free Does not contain sesame seed or derivatives
Health Shellfish shellfish-free No shellfish or shellfish derivatives
Health Soy soy-free No soy or products containing soy
Health Sugar-conscious sugar-conscious Less than 4g of sugar per serving
Health Tree Nuts tree-nut-free No tree nuts or products containing tree nuts
Health Vegan vegan No meat, poultry, fish, dairy, eggs or honey
Health Vegetarian vegetarian No meat, poultry, or fish
Health Wheat-free wheat-free No wheat, can have gluten though

Meal Types

List of all possible Meal Types. The meal types refer to the meals in a day the recipe is commonly consumed in.

Type API Parameter
mealType Breakfast
mealType Lunch
mealType Dinner
mealType Snack
mealType Teatime

Dish Types

List of all possible Dish Types. The dish types refer to the category of food the recipe would fall under.

Type API Parameter
dishType Alcohol-cocktail
dishType Biscuits and cookies
dishType Bread
dishType Cereals
dishType Condiments and sauces
dishType Drinks
dishType Desserts
dishType Egg
dishType Main course
dishType Omelet
dishType Pancake
dishType Preps
dishType Preserve
dishType Salad
dishType Sandwiches
dishType Soup
dishType Starter

Cuisine Types

The list of all possible Cuisine Types. The cuisine types refer to the cuisine that the recipe would fall under.

Type API Parameter
cuisineType American
cuisineType Asian
cuisineType British
cuisineType Caribbean
cuisineType Central Europe
cuisineType Chinese
cuisineType Eastern Europe
cuisineType French
cuisineType Indian
cuisineType Italian
cuisineType Japanese
cuisineType Kosher
cuisineType Mediterranean
cuisineType Mexican
cuisineType Middle Eastern
cuisineType Nordic
cuisineType South American
cuisineType South East Asian