User Guide
API Reference
FdcClient
FdcClient.api_key
FdcClient.base_url
FdcClient.session
FdcClient.__init__()
FdcClient.search()
FdcClient.get_food()
FdcClient.get_foods()
FdcClient.get_nutrients()
FdcClient.list_foods()
Food
Food.fdc_id
Food.description
Food.data_type
Food.publication_date
Food.food_class
Food.food_category
Food.scientific_name
Food.brand_owner
Food.brand_name
Food.ingredients
Food.serving_size
Food.serving_size_unit
Food.household_serving_fulltext
Food.nutrients
Food.food_portions
Food.from_api_data()
Food.__init__()
Nutrient
Nutrient.id
Nutrient.name
Nutrient.amount
Nutrient.unit_name
Nutrient.nutrient_nbr
Nutrient.rank
Nutrient.from_api_data()
Nutrient.__init__()
FoodPortion
FoodPortion.id
FoodPortion.amount
FoodPortion.gram_weight
FoodPortion.portion_description
FoodPortion.modifier
FoodPortion.measure_unit
FoodPortion.from_api_data()
FoodPortion.__init__()
SearchResult
SearchResult.foods
SearchResult.total_hits
SearchResult.current_page
SearchResult.total_pages
SearchResult.from_api_data()
SearchResult.__init__()
SearchResultFood
SearchResultFood.fdc_id
SearchResultFood.description
SearchResultFood.data_type
SearchResultFood.publication_date
SearchResultFood.food_category
SearchResultFood.brand_owner
SearchResultFood.brand_name
SearchResultFood.from_api_data()
SearchResultFood.__init__()
NutrientAnalysis
NutrientAnalysis.food
NutrientAnalysis.nutrients
NutrientAnalysis.dri_type
NutrientAnalysis.gender
NutrientAnalysis.serving_size
NutrientAnalysis.calories_per_serving
NutrientAnalysis.macronutrient_distribution
NutrientAnalysis.get_nutrient()
NutrientAnalysis.get_nutrients_by_group()
NutrientAnalysis.get_macronutrients()
NutrientAnalysis.get_vitamins()
NutrientAnalysis.get_minerals()
NutrientAnalysis.get_amino_acids()
NutrientAnalysis.get_nutrient_density()
NutrientAnalysis.to_dict()
NutrientValue
NutrientValue.nutrient
NutrientValue.amount
NutrientValue.unit
NutrientValue.dri_percent
analyze_food()
analyze_foods()
compare_foods()
Nutrient.display_name
Nutrient.unit
Nutrient.group
Nutrient.usda_id
NUTRIENTS
NUTRIENT_GROUPS
DietaryReferenceIntakes
DietaryReferenceIntakes.data
DietaryReferenceIntakes.metadata
DietaryReferenceIntakes.__init__()
DietaryReferenceIntakes.get_dri()
DietaryReferenceIntakes.get_all_dris()
DriType
DriType.RDA
DriType.AI
DriType.UL
Gender
Gender.MALE
Gender.FEMALE
get_dri()
Recipe
Recipe.name
Recipe.ingredients
Recipe.servings
Recipe.instructions
Recipe.total_weight_g
Recipe.add_ingredient()
Recipe.get_weight_per_serving()
Ingredient
Ingredient.food
Ingredient.amount
Ingredient.unit
Ingredient.weight_g
RecipeAnalysis
RecipeAnalysis.recipe
RecipeAnalysis.total_analysis
RecipeAnalysis.per_serving_analysis
RecipeAnalysis.ingredient_analyses
parse_ingredient()
create_recipe()
analyze_recipe()
generate_macronutrient_chart_data()
generate_dri_chart_data()
generate_nutrient_comparison_chart_data()
generate_nutrient_radar_chart_data()
generate_html_report()
main()
parse_unit_and_value()
convert_to_grams()
convert_to_milliliters()
convert_measurement()
normalize_nutrient_value()
FdcApiError
FdcAuthError
FdcRateLimitError
FdcValidationError
FdcResourceNotFoundError
search_command()
food_command()
nutrients_command()
list_command()
format_output()
pretty_print_object()
Development
The django module provides integration with Django applications.