API: ingredients

Parameters

key

[required] key for access to the API (get/view your key)
format: api key

offset

[not required] offset of results to get (paging)
format: integer with a max of 10 (default: 0)

s

[required] part or full string of an ingredient to search for
format: string

food_group

[not required] narrow results to a single food group
format: select from: Dairy and Egg Products | Spices and Herbs | Baby Foods | Fats and Oils | Poultry Products | Soups, Sauces, and Gravies | Sausages and Luncheon Meats | Breakfast Cereals | Fruits and Fruit Juices | Pork Products | Vegetables and Vegetable Products | Nut and Seed Products | Beef Products | Beverages | Finfish and Shellfish Products | Legumes and Legume Products | Lamb, Veal, and Game Products | Baked Products | Sweets | Cereal Grains and Pasta | Fast Foods | Meals, Entrees, and Side Dishes | Snacks | American Indian/Alaska Native Foods | Restaurant Foods

nutrition

[not required] include nutritional information in the results
format: 0 | 1

Return Values

api

Returns details about the API and call

• status: see below Return Status Codes
• api_version: 2.1
• format: json
• api_key: [your api key]

ingredients

Return of ingredients with the following structure

• ingredient_id: generated key
• description: string
• manufacturer: string
• food_group: Dairy and Egg Products | Spices and Herbs | Baby Foods | Fats and Oils | Poultry Products | Soups, Sauces, and Gravies | Sausages and Luncheon Meats | Breakfast Cereals | Fruits and Fruit Juices | Pork Products | Vegetables and Vegetable Products | Nut and Seed Products | Beef Products | Beverages | Finfish and Shellfish Products | Legumes and Legume Products | Lamb, Veal, and Game Products | Baked Products | Sweets | Cereal Grains and Pasta | Fast Foods | Meals, Entrees, and Side Dishes | Snacks | American Indian/Alaska Native Foods | Restaurant Foods
• refuse_percentage: float
• refuse_description: string
• weight_in_grams: float
• measurements:
  • description: string
  • weight_amount: float
  • weight_grams: float
  • edible_portion: float
• claims:
  • alcohol_free: true | false
  • sodium_free: true | false
  • good_source_protein: true | false
  • high_protein: true | false
  • good_source_fiber: true | false
  • high_fiber: true | false
• calories:
  • calories_alcohol: float
  • calories_fat: float
  • calories_carbohydrates: float
  • calories_protein: float
  • total: float
• nutrition:
  [total_fat | saturated_fat | trans_fat | cholesterol | sodium | total_carbohydrate | dietary_fiber | total_sugars | protein | vitamin_a | vitamin_c | vitamin_b6 | vitamin_d | vitamin_e | iron | calcium | magnesium]
  • amount: float
  • units: string
  • daily_value: percentage

Return Status Codes

200

successful call

204

call resulted in an empty resultset

400

incorrect or missing API key

404

incorrect or missing required parameter

429

call limit exceeded on API key (check your limit)

Sample Response

{ "response": { "api": { "status": 200, "api_version": "2.1", "format": "json", "api_key": "[your_key]" }, "result": { "ingredients": [{ "ingredient_id": "", "description": "", "manufacturer": "", "food_group": "", "refuse_percentage": "", "refuse_description": "", "measurements": { "1": { "description": "", "weight_amount": "", "weight_grams": "", "edible_portion": "" } }, "weight_in_grams": "", "claims": { "alcohol_free": true, "sodium_free": true, "good_source_protein": false, "high_protein": false, "good_source_fiber": false, "high_fiber": false }, "calories": { "calories_alcohol": "", "calories_fat": "", "calories_carbohydrates": "", "calories_protein": "", "total": "" }, "nutrition": { "total_fat": { "amount": "", "units": "", "daily_value": "" }, "saturated_fat": { "amount": "", "units": "", "daily_value": "" }, "trans_fat": { "amount": "", "units": "", "daily_value": "" }, "cholesterol": { "amount": "", "units": "", "daily_value": "" }, "sodium": { "amount": "", "units": "", "daily_value": "" }, "total_carbohydrate": { "amount": "", "units": "", "daily_value": "" }, "dietary_fiber": { "amount": "", "units": "", "daily_value": "" }, "total_sugars": { "amount": "", "units": "", "daily_value": "" }, "protein": { "amount": "", "units": "", "daily_value": "" }, "vitamin_a": { "amount": "", "units": "", "daily_value": "" }, "vitamin_c": { "amount": "", "units": "", "daily_value": "" }, "vitamin_b6": { "amount": "", "units": "", "daily_value": "" }, "vitamin_d": { "amount": "", "units": "", "daily_value": "" }, "vitamin_e": { "amount": "", "units": "", "daily_value": "" }, "iron": { "amount": "", "units": "", "daily_value": "" }, "calcium": { "amount": "", "units": "", "daily_value": "" }, "magnesium": { "amount": "", "units": "", "daily_value": "" } } }] } } }