Skip to content

Instantly share code, notes, and snippets.

@mattsilv

mattsilv/nutritionix-usda.md

Last active May 22, 2017 19:20
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save mattsilv/7122853 to your computer and use it in GitHub Desktop.
Save mattsilv/7122853 to your computer and use it in GitHub Desktop.
Download ZIP
Nutritionix API USDA Documentation
Raw
nutritionix-usda.md

USDA Getting Started

Example NXQL Queries

// returns items that are not restaurants and nf_serving_weight_grams is not null
// includes usda_fields in the results so items that contain those fields will return
// fields.usda_fields
{
  "fields":["item_name","brand_name","keywords","usda_fields"],
  "query":"celery",
  "filters": {
    "not": {
      "item_type": 1,
      "nf_serving_weight_grams":null
    }
  }
}


// Returns only items that have USDA Fields
{
  "fields":["item_name","brand_name","keywords","usda_fields"],
  "query":"celery",
  "filters": {
    "exists":{
      "usda_fields":true
    }
  }
}

Example USDA Item

{
  "_index": "nixProductionV10",
  "_type": "item",
  "_id": "513fceb375b8dbbc21000002",
  "_version": 3,
  "exists": true,
  "_source": {
    "nf_ingredient_statement": null,
    "nf_serving_weight_grams": 5,
    "brand_name": "USDA",
    "nf_calories_from_fat": 36.5,
    "nf_trans_fatty_acid": null,
    "brand_id": "513fcc648110a4cafb90ca5e",
    "nf_sodium": 35.7,
    "allergen_contains_eggs": null,
    "nf_iron_dv": 0.01,
    "nf_polyunsaturated_fat": 0.15,
    "item_description": null,
    "nf_monounsaturated_fat": 1.05,
    "nf_dietary_fiber": 0,
    "nf_serving_size_qty": 1,
    "item_name": "Butter, salted - 1 pat (1\" sq, 1/3\" high)",
    "allergen_contains_tree_nuts": null,
    "allergen_contains_shellfish": null,
    "nf_vitamin_c_dv": 0,
    "nf_cholesterol": 10.75,
    "allergen_contains_peanuts": null,
    "nf_sugars": 0.0,
    "nf_servings_per_container": null,
    "nf_total_fat": 4.06,
    "nf_vitamin_a_dv": 2.5,
    "nf_total_carbohydrate": 0.0,
    "leg_loc_id": 328,
    "nf_saturated_fat": 2.57,
    "remote_db_key": 1001,
    "allergen_contains_wheat": null,
    "old_api_id": null,
    "allergen_contains_gluten": null,
    "nf_protein": 0.04,
    "item_id": "513fceb375b8dbbc21000002",
    "remote_db_id": 3,
    "nf_calories": 35.85,
    "nf_water_grams": 0.79,
    "allergen_contains_fish": null,
    "nf_calcium_dv": 0.12,
    "item_type": 3.0,
    "keywords": [
      "butter",
      "salted butter"
    ],
    "allergen_contains_milk": null,
    "_id": "513fceb375b8dbbc21000002",
    "nf_serving_size_unit": "pat (1\" sq, 1/3\" high)",
    "nf_refuse_pct": null,
    "allergen_contains_soybeans": null,
    "usda_fields": {
      "": {
        "desc": "18:2 i",
        "uom": "g",
        "value": 0.01
      },
      "TYR_G": {
        "desc": "Tyrosine",
        "uom": "g",
        "value": 0.0
      },
      "ASP_G": {
        "desc": "Aspartic acid",
        "uom": "g",
        "value": 0.0
      },
      "ENERC_KJ": {
        "desc": "Energy",
        "uom": "kJ",
        "value": 150.0
      },
      "ALA_G": {
        "desc": "Alanine",
        "uom": "g",
        "value": 0.0
      },
      "FAPU": {
        "desc": "Fatty acids, total polyunsaturated",
        "uom": "g",
        "value": 0.15
      },
      "TRP_G": {
        "desc": "Tryptophan",
        "uom": "g",
        "value": 0.0
      },
      "PRO_G": {
        "desc": "Proline",
        "uom": "g",
        "value": 0.0
      },
      "F18D1C": {
        "desc": "18:1 c",
        "uom": "g",
        "value": 0.85
      },
      "MG": {
        "desc": "Magnesium, Mg",
        "uom": "mg",
        "value": 0.1
      },
      "ZN": {
        "desc": "Zinc, Zn",
        "uom": "mg",
        "value": 0.0
      },
      "WATER": {
        "desc": "Water",
        "uom": "g",
        "value": 0.79
      },
      "SUGAR": {
        "desc": "Sugars, total",
        "uom": "g",
        "value": 0.0
      },
      "FAT": {
        "desc": "Total lipid (fat)",
        "uom": "g",
        "value": 4.06
      },
      "F18D1T": {
        "desc": "18:1 t",
        "uom": "g",
        "value": 0.15
      },
      "TOCTRG": {
        "desc": "Tocotrienol, gamma",
        "uom": "mg",
        "value": 0.0
      },
      "TOCTRB": {
        "desc": "Tocotrienol, beta",
        "uom": "mg",
        "value": 0.0
      },
      "F12D0": {
        "desc": "12:0",
        "uom": "g",
        "value": 0.13
      },
      "F16D1C": {
        "desc": "16:1 c",
        "uom": "g",
        "value": 0.05
      },
      "F8D0": {
        "desc": "8:0",
        "uom": "g",
        "value": 0.06
      },
      "TOCTRD": {
        "desc": "Tocotrienol, delta",
        "uom": "mg",
        "value": 0.0
      },
      "PANTAC": {
        "desc": "Pantothenic acid",
        "uom": "mg",
        "value": 0.01
      },
      "CHOLN": {
        "desc": "Choline, total",
        "uom": "mg",
        "value": 0.94
      },
      "FE": {
        "desc": "Iron, Fe",
        "uom": "mg",
        "value": 0.0
      },
      "TOCTRA": {
        "desc": "Tocotrienol, alpha",
        "uom": "mg",
        "value": 0.0
      },
      "MN": {
        "desc": "Manganese, Mn",
        "uom": "mg",
        "value": 0.0
      },
      "GLY_G": {
        "desc": "Glycine",
        "uom": "g",
        "value": 0.0
      },
      "F6D0": {
        "desc": "6:0",
        "uom": "g",
        "value": 0.1
      },
      "CHOLE": {
        "desc": "Cholesterol",
        "uom": "mg",
        "value": 10.75
      },
      "PROCNT": {
        "desc": "Protein",
        "uom": "g",
        "value": 0.04
      },
      "FIBTG": {
        "desc": "Fiber, total dietary",
        "uom": "g",
        "value": 0.0
      },
      "F22D5": {
        "desc": "22:5 n-3 (DPA)",
        "uom": "g",
        "value": 0.0
      },
      "VAL_G": {
        "desc": "Valine",
        "uom": "g",
        "value": 0.0
      },
      "F22D1": {
        "desc": "22:1 undifferentiated",
        "uom": "g",
        "value": 0.0
      },
      "CAFFN": {
        "desc": "Caffeine",
        "uom": "mg",
        "value": 0.0
      },
      "RIBF": {
        "desc": "Riboflavin",
        "uom": "mg",
        "value": 0.0
      },
      "HISTN_G": {
        "desc": "Histidine",
        "uom": "g",
        "value": 0.0
      },
      "F18D2CN6": {
        "desc": "18:2 n-6 c,c",
        "uom": "g",
        "value": 0.11
      },
      "NA": {
        "desc": "Sodium, Na",
        "uom": "mg",
        "value": 32.15
      },
      "THIA": {
        "desc": "Thiamin",
        "uom": "mg",
        "value": 0.0
      },
      "F22D6": {
        "desc": "22:6 n-3 (DHA)",
        "uom": "g",
        "value": 0.0
      },
      "F14D0": {
        "desc": "14:0",
        "uom": "g",
        "value": 0.37
      },
      "ASH": {
        "desc": "Ash",
        "uom": "g",
        "value": 0.11
      },
      "ARG_G": {
        "desc": "Arginine",
        "uom": "g",
        "value": 0.0
      },
      "STID7": {
        "desc": "Stigmasterol",
        "uom": "mg",
        "value": 0.0
      },
      "F17D0": {
        "desc": "17:0",
        "uom": "g",
        "value": 0.03
      },
      "THR_G": {
        "desc": "Threonine",
        "uom": "g",
        "value": 0.0
      },
      "F18D3": {
        "desc": "18:3 undifferentiated",
        "uom": "g",
        "value": 0.02
      },
      "CA": {
        "desc": "Calcium, Ca",
        "uom": "mg",
        "value": 1.2
      },
      "F18D4": {
        "desc": "18:4",
        "uom": "g",
        "value": 0.0
      },
      "F18D1": {
        "desc": "18:1 undifferentiated",
        "uom": "g",
        "value": 1.0
      },
      "MET_G": {
        "desc": "Methionine",
        "uom": "g",
        "value": 0.0
      },
      "F18D2": {
        "desc": "18:2 undifferentiated",
        "uom": "g",
        "value": 0.14
      },
      "PHE_G": {
        "desc": "Phenylalanine",
        "uom": "g",
        "value": 0.0
      },
      "FATRN": {
        "desc": "Fatty acids, total trans",
        "uom": "g",
        "value": 0.16
      },
      "F18D3CN3": {
        "desc": "18:3 n-3 c,c,c (ALA)",
        "uom": "g",
        "value": 0.02
      },
      "F18D0": {
        "desc": "18:0",
        "uom": "g",
        "value": 0.5
      },
      "K": {
        "desc": "Potassium, K",
        "uom": "mg",
        "value": 1.2
      },
      "LEU_G": {
        "desc": "Leucine",
        "uom": "g",
        "value": 0.0
      },
      "F20D0": {
        "desc": "20:0",
        "uom": "g",
        "value": 0.01
      },
      "F20D1": {
        "desc": "20:1",
        "uom": "g",
        "value": 0.01
      },
      "ILE_G": {
        "desc": "Isoleucine",
        "uom": "g",
        "value": 0.0
      },
      "BETN": {
        "desc": "Betaine",
        "uom": "mg",
        "value": 0.01
      },
      "F10D0": {
        "desc": "10:0",
        "uom": "g",
        "value": 0.13
      },
      "P": {
        "desc": "Phosphorus, P",
        "uom": "mg",
        "value": 1.2
      },
      "SITSTR": {
        "desc": "Beta-sitosterol",
        "uom": "mg",
        "value": 0.2
      },
      "F20D4": {
        "desc": "20:4 undifferentiated",
        "uom": "g",
        "value": 0.0
      },
      "F4D0": {
        "desc": "4:0",
        "uom": "g",
        "value": 0.16
      },
      "F20D5": {
        "desc": "20:5 n-3 (EPA)",
        "uom": "g",
        "value": 0.0
      },
      "F16D1": {
        "desc": "16:1 undifferentiated",
        "uom": "g",
        "value": 0.05
      },
      "F16D0": {
        "desc": "16:0",
        "uom": "g",
        "value": 1.08
      },
      "TOCPHA": {
        "desc": "Vitamin E (alpha-tocopherol)",
        "uom": "mg",
        "value": 0.12
      },
      "ALC": {
        "desc": "Alcohol, ethyl",
        "uom": "g",
        "value": 0.0
      },
      "TOCPHB": {
        "desc": "Tocopherol, beta",
        "uom": "mg",
        "value": 0.0
      },
      "VITA_IU": {
        "desc": "Vitamin A, IU",
        "uom": "IU",
        "value": 124.95
      },
      "FATRNM": {
        "desc": "Fatty acids, total trans-monoenoic",
        "uom": "g",
        "value": 0.15
      },
      "CHOCDF": {
        "desc": "Carbohydrate, by difference",
        "uom": "g",
        "value": 0.0
      },
      "TOCPHD": {
        "desc": "Tocopherol, delta",
        "uom": "mg",
        "value": 0.0
      },
      "VITB6A": {
        "desc": "Vitamin B-6",
        "uom": "mg",
        "value": 0.0
      },
      "GLU_G": {
        "desc": "Glutamic acid",
        "uom": "g",
        "value": 0.01
      },
      "FATRNP": {
        "desc": "Fatty acids, total trans-polyenoic",
        "uom": "g",
        "value": 0.01
      },
      "TOCPHG": {
        "desc": "Tocopherol, gamma",
        "uom": "mg",
        "value": 0.0
      },
      "VITC": {
        "desc": "Vitamin C, total ascorbic acid",
        "uom": "mg",
        "value": 0.0
      },
      "VITD": {
        "desc": "Vitamin D",
        "uom": "IU",
        "value": 3.0
      },
      "FASAT": {
        "desc": "Fatty acids, total saturated",
        "uom": "g",
        "value": 2.57
      },
      "CU": {
        "desc": "Copper, Cu",
        "uom": "mg",
        "value": 0.0
      },
      "CYS_G": {
        "desc": "Cystine",
        "uom": "g",
        "value": 0.0
      },
      "F18D2CLA": {
        "desc": "18:2 CLAs",
        "uom": "g",
        "value": 0.01
      },
      "FAMS": {
        "desc": "Fatty acids, total monounsaturated",
        "uom": "g",
        "value": 1.05
      },
      "ENERC_KCAL": {
        "desc": "Energy",
        "uom": "kcal",
        "value": 35.85
      },
      "NIA": {
        "desc": "Niacin",
        "uom": "mg",
        "value": 0.0
      },
      "SER_G": {
        "desc": "Serine",
        "uom": "g",
        "value": 0.0
      },
      "THEBRN": {
        "desc": "Theobromine",
        "uom": "mg",
        "value": 0.0
      },
      "LYS_G": {
        "desc": "Lysine",
        "uom": "g",
        "value": 0.0
      },
      "CAMD5": {
        "desc": "Campesterol",
        "uom": "mg",
        "value": 0.0
      }
    }
  }
}

All Possible USDA Fields

Fields Description
PROCNT Protein
FAT Total lipid (fat)
CHOCDF Carbohydrate, by difference
ASH Ash
ENERC_KCAL Energy
ALC Alcohol, ethyl
WATER Water
CAFFN Caffeine
THEBRN Theobromine
ENERC_KJ Energy
SUGAR Sugars, total
FIBTG Fiber, total dietary
CA Calcium, Ca
FE Iron, Fe
MG Magnesium, Mg
P Phosphorus, P
K Potassium, K
NA Sodium, Na
ZN Zinc, Zn
CU Copper, Cu
MN Manganese, Mn
VITA_IU Vitamin A, IU
TOCPHA Vitamin E (alpha-tocopherol)
VITD Vitamin D
TOCPHB Tocopherol, beta
TOCPHG Tocopherol, gamma
TOCPHD Tocopherol, delta
TOCTRA Tocotrienol, alpha
TOCTRB Tocotrienol, beta
TOCTRG Tocotrienol, gamma
TOCTRD Tocotrienol, delta
VITC Vitamin C, total ascorbic acid
THIA Thiamin
RIBF Riboflavin
NIA Niacin
PANTAC Pantothenic acid
VITB6A Vitamin B-6
CHOLN Choline, total
BETN Betaine
TRP_G Tryptophan
THR_G Threonine
ILE_G Isoleucine
LEU_G Leucine
LYS_G Lysine
MET_G Methionine
CYS_G Cystine
PHE_G Phenylalanine
TYR_G Tyrosine
VAL_G Valine
ARG_G Arginine
HISTN_G Histidine
ALA_G Alanine
ASP_G Aspartic acid
GLU_G Glutamic acid
GLY_G Glycine
PRO_G Proline
SER_G Serine
18 :2 i
CHOLE Cholesterol
FATRN Fatty acids, total trans
FASAT Fatty acids, total saturated
F4D0 4:0
F6D0 6:0
F8D0 8:0
F10D0 10:0
F12D0 12:0
F14D0 14:0
F16D0 16:0
F18D0 18:0
F20D0 20:0
F18D1 18:1 undifferentiated
F18D2 18:2 undifferentiated
F18D3 18:3 undifferentiated
F20D4 20:4 undifferentiated
F22D6 22:6 n-3 (DHA)
F16D1 16:1 undifferentiated
F18D4 18:4
F20D1 20:1
F20D5 20:5 n-3 (EPA)
F22D1 22:1 undifferentiated
F22D5 22:5 n-3 (DPA)
STID7 Stigmasterol
CAMD5 Campesterol
SITSTR Beta-sitosterol
FAMS Fatty acids, total monounsaturated
FAPU Fatty acids, total polyunsaturated
F17D0 17:0
F18D1T 18:1 t
F18D2CLA 18:2 CLAs
F16D1C 16:1 c
F18D1C 18:1 c
F18D2CN6 18:2 n-6 c,c
FATRNM Fatty acids, total trans-monoenoic
FATRNP Fatty acids, total trans-polyenoic
F18D3CN3 18:3 n-3 c,c,c (ALA)
SUCS Sucrose
LACS Lactose
MALS Maltose
GLUS Glucose (dextrose)
FRUS Fructose
GALS Galactose
F14D1 14:1
F15D0 15:0
F22D0 22:0
F24D0 24:0
F24D1C 24:1 c
F20D2CN6 20:2 n-6 c,c
F17D1 17:1
F20D3 20:3 undifferentiated
F21D5 21:5
F22D4 22:4
F15D1 15:1
STARCH Starch
HYP Hydroxyproline
F18D3CN6 18:3 n-6 c,c,c
F13D0 13:0
F16D1T 16:1 t
F22D1T 22:1 t
F22D1C 22:1 c
F20D3N6 20:3 n-6
F20D3N3 20:3 n-3
PHYSTR Phytosterols
F18D2TT 18:2 t,t
F18D1TN7 18:1-11t (18:1t n-7)
F20D4N6 20:4 n-6
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment