(Version Retired)
Welcome,
This is documentation for the nutritional data API. The nutritional data API provides information about single ingredinet.
Happy coding!
Interfaces
Nutritional data
Path: https://api.edamam.com/api/nutrition-data
Returns nutritional information for the spcified ingredient.
GET
Request
You will use a GET request to submit the ingredient.
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!) |
The API return nutritional analysis for the specified ingredient.
Example GET
request
As an example, let’s say we want to find the nutrition information for an apple. You should always include the quantity and the measure, so we’ll have to say “1 large apple
” instead of just “apple
”. We then need to URL-encode this string. In this case, this means to just replace the spaces with %20
, so it becomes “1%20large%20apple
”. Please note, that the quotation marks aren’t part of the string.
Here is an example using curl:
Response
HTTP Status code | Content-Type | Type | Description |
---|---|---|---|
200 OK | application/json | Recipe | Recipe object containing number of servings (yield), total calories for the recipe (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 recipe or extract the nutritional info |
555 | text/html | HTML | Recipe with insufficient quality to process correctly |
Example response
Types
Composite types are described in terms of their JSON representation.
Throughout descriptions, the following notation is used:
integer
,float
, andstring
stand for the JavaScript primitive typesinteger
,float
, andstring
, respectivelyenum
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 typeT
T[*]
stands for an object (associative map) whose every field (element) is of typeT
.
Recipe
Note: Only a subset of the fields may be present, depending on the interface through which the recipe is obtained. Refer to the specific interface description for details.
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” |
NutrientInfo
field | type | description |
---|---|---|
uri |
string |
Ontology identifier |
label |
string |
Display label |
quantity |
float |
Quantity of specified units |
unit |
string |
Units |
Nutritional Label Definitions
Type | Web Label | API Parameter | Deffinition |
---|---|---|---|
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 |
Balanced | balanced | Protein/Fat/Carb values in 15/35/50 ratio |
Diet |
Fat-free | fat-free | 0.5% or less of the total weight is from fat |
Diet |
High-Fiber | high-fiber | More than 5g fiber per serving |
Diet |
Low-Sodium | low-sodium | Less than 140mg Na per serving |
Health |
No-sugar | low-sugar | No simple sugars – glucose, dextrose, galactose, fructose, sucrose, lactose, maltose |
Health |
Sugar-conscious | sugar-conscious | Less than 4g of sugar per serving |
Health |
n/a | low-fat-abs | Less than 3g of fat per serving |
Health |
Gluten | gliten-free | No ingredients containing gluten |
Health |
Vegetarian | vegetarian | No meat, poultry, or fish |
Health |
Vegan | vegan | No meat, poultry, fish, dairy, eggs or honey |
Health |
Paleo | paleo | Excludes what are perceived to be agricultural products; grains, legumes, dairy products, potatoes, refined salt, refined sugar, and processed oils |
Health |
Wheat-free | wheat-free | No wheat, can have gluten though |
Health |
Dairy | dairy-free | No dairy; no lactose |
Health |
Eggs | egg-free | No eggs or products containing eggs |
Health |
Soy | soy-free | No soy or products containing soy |
Health |
Fish | fish-free | No fish or fish derivatives |
Health |
Shellfish | shellfish-free | No shellfish or shellfish derivatives |
Health |
Tree Nuts | tree-nut-free | No tree nuts or products containing tree nuts |
Health |
Low potassium | low-potassium | Less than 150mg per serving |
Health |
Alcohol-free | alcohol-free | No alcohol used or contained |
Health |
No oil added | No-oil-added | No oil added except to what is contained in the basic ingredients |
Health |
Kidney friendly | kidney-friendly | per serving – phosphorus < 250 mg AND potassium < 500 mg AND sodium: <500 mg |
Health |
Peanuts | peanut-free | No peanuts or products containing peanuts |
Health |
Alcohol | alcohol-free | No alcohol used or contained in the recipe |