Food Database API Documentation

Food Database

This API provides you with tools to find nutrition and diet data for generic foods, packaged foods and restaurant meals. In addition it employs NLP (Natural Language Processing) which allows for extraction of food entities from unstructured text.

Covered Use Cases

  • Search for a food by keyword, food name or UPC/Barcode
  • Sourcing of nutrition facts for a given food, including: macro and micro nutrients, allergen labels, lifestyle and health labels
  • Search for a food by given nutrient quantity for 28 nutrients
  • Seach for foods within a given brand

Food Database Requests

Parse requests: https://api.edamam.com/api/food-database/parser

Food Database Text Search

The parser access point handles text search for foods as well as filters for the foods like presence specific nutrient content or exclusion of allergens

  • Basic food search request returnes database matches for the search string which was submitted.
  • There are 40 diet and health labels which can be used to limit the results of the seach
  • Edamam also provides over 20 nutrients which can be used to specify nutrient content desired in the food results

UPC or Barcode Search

Allows for search of an item based UPC/Barcode number.

Parser Request

You will use a GET request to access the Parser. Either UPC or ingr should be present for a valid request

When searching by keyword

Parameter Required Type Description
app_id yes String Your 3scale application ID
app_key yes String Your 3scale application key
ingr yes* String The ingredient (don’t forget to URL-encode!)
health no enum Health label: One of the Health api parameters listed in Diet and Health Labels table at the end of this documentation. For example “peanut-free”, “tree-nut-free”, “soy-free”, “fish-free”, “shellfish-free”
calories no range The format is calories=RANGE where RANGE is replaced by the value in kcal. RANGE is in one of MIN+, MIN-MAX or MAX, where MIN and MAX are non-negative integer numbers. The + symbol needs to be properly encoded. Examples: “calories=100-300” will return all foods with which have between 100 and 300 kcal per serving.
page no integer Lists results from the sellected page (20 per page).

When searching by UPC

Parameter Required Type Description
app_id yes String Your 3scale application ID
app_key yes String Your 3scale application key
upc yes* number The UPC or barcode number for the food

Search by nutrient range

When searching by keyword you can also specify nutrient ranges by adding parameters in the following form:

nutrients[NTR]=RANGE where

NTR is one of: CA, CHOCDF, CHOLE, FAMS, FAPU, FASAT, FAT, FATRN, FE, FIBTG, FOLDFE, K, MG, NA, NIA, P, PROCNT, RIBF, SUGAR, THIA, TOCPHA, VITA_RAE, VITB12, VITB6A, VITC, VITD, VITK1 or ZN;

and

RANGE is in one of MIN+, MIN-MAX or MAX, where MIN and MAX are non-negative integer numbers.

For example:
nutrients[CA]=50+ means minimum 50mg calcium, where ‘50+’ has to be properly encoded as ‘50%2B’
nutrients[FAT]=30 means maximum 30g fat and
nutrients[FE]=5-10 means iron between 5mg and 10mg inclusive

You can combine more then one nutrient ranges in a search requests

NTR Code Name Unit 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

Example Parser request

As an example, let’s say we want to find matches in the food database for a red apple. We then need to URL-encode this string. In this case, this means to just replace the spaces with %20,so it becomes “red%20apple” Please note, that the quotation marks aren’t part of the string.
Here is an example using curl:

'https://api.edamam.com/api/food-database/parser?ingr=red%20apple&app_id={your app_id}&app_key={your app_key}&page=0'

UPC or Barcode Search
This is a service allowing you to submit a UPC or barcode and find a match for it in the food database.

Here is an example using curl:
'https://api.edamam.com/api/food-database/parser?upc={upc code}&app_id={your app_id}&app_key={your app_key}'

Parser Response

HTTP Status code Description
200 OK List of food objects, with each food object containing: kcal per 100gr, protein per 100 grams, carbohydrates per 100 grams, brand of the food, if the food is generic or brandid, a list of existing measures for the food, contents label of the food
404 Not Found The specified URL was not found or couldn’t be retrieved

Example response to text search

Nutrition Data Requests

Nutrition Requests: https://api.edamam.com/api/food-database/nutrients

In the response to your parser request you receive the a food URI for each database match. Using the food URI and the measure URI which parser provides you can make a request to the ‘nutrients’ acces point. The ‘nutrients’ access points returns nutrition with diet and health labels for a given quantity of the food.

Nutrients Request

The contents of the request must be a JSON object with the following format:

Parameter Required Type Description
yield no number number of servings
ingredients yes Ingredient[] ingredients (array of Ingredient)

Ingredient

Parameter Required Type Description
quantity yes number The quantity of the ingredient
measureURI yes String one fo the measuement URI’s received in the parser response
foodURI yes String The food URI received in the parser response)

The API return nutritional analysis for the specified ingredient.

Example Nutrients request

You will use a POST request to access ‘nutrients’.

Here is an example using curl:

This will send the food.json file for processing.

Here is the contents of the food.json file:

Nutrients Response

HTTP Status code Content-Type Type Description
200 OK application/json FoodInfo Object containing number of servings (yield), total calories for the food (calories), nutrient content by nutrient type (totalNutrients, totalDaily), diet and health classification (dietLabels, healthLabels)
404 Not Found text/html HTML The specified URL was not found or couldn’t be retrieved
422 Uprocessable Entity text/html HTML Couldn’t parse the request or extract the nutritional info
555 text/html HTML Text with insufficient quality to process correctly

Example Nutrients response

Nutirion

field type description
uri string Ontology identifier
calories float Total energy, kcal
totalNutrients NutrientInfo[*] Total nutrients
totalDaily NutrientInfo[*] % daily value
dietLabels enum[] Diet labels: “balanced”, “high-protein”, “high-fiber”, “low-fat”, “low-carb”, “low-sodium”
healthLabels enum[] Health labels: “vegan”, “vegetarian”, “dairy-free”, “low-sugar”, “low-fat-abs”, “sugar-conscious”, “fat free”, “gluten free”, “wheat free”

For ‘Nutritional Label Definitions’ consult the table at the bottom of this document

NutrientInfo

field type description
uri string Ontology identifier
label string Display label
quantity float Quantity of specified units
unit string Units

Ingredient

Field Type Description
uri string Ontology identifier
quantity float Quantity of specified measure
measure Measure Measure
weight float Total weight, g
food Food Food

Autocomplete Request

Edamam provides a convinient autocomplete functionality which can be used when searching for ingredients.

Path: http://api.edamam.com/auto-complete

The endpoint returns suggestions for the text submitted to it. Here is an example

http://api.edamam.com/auto-complete?q=rou&limit=10&app_id=${YOUR_APP_ID}&app_key=${YOUR_APP_KEY}

Nutrients Codes and units

NTR Code Name Unit 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

Nutritional Label Definitions

Nutrition labels are shared by recipes and foods alike. They are assigned by Edamam based on the ingredients contained in the food label for CPG foods and by the basic ingredients of each recipe for recipes.

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 Alcohol alcohol-free No alcohol used or contained
Health Alcohol-free alcohol-free No alcohol used or contained
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 Gluten gluten-free No ingredients containing gluten
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

Types

Composite types are described in terms of their JSON representation.

Throughout descriptions, the following notation is used:

  • integer, float, and string stand for the JavaScript primitive types integer, float, and string, respectively
  • enum stands for a string field that only takes on values from a pre-defined range (the range is specified where essential)
  • T[] stands for an array of objects of type T
  • T[*] stands for an object (associative map) whose every field (element) is of type T.