Health Information API

What is Health Information API?

A FastAPI application that provides health and nutrition calculators including BMI, body frame size, body fat percentage, macronutrient targets, and food nutrition via the USDA FoodData Central API. It is designed for developers who want to integrate these health metrics into their applications.

How to use Health Information API?

Clone the repository, install dependencies with pip install -r requirements.txt, set the USDA_API_KEY environment variable (and optionally OPENAI_API_KEY), then run uvicorn main:app --reload. The API will be available at http://localhost:8000 with interactive documentation at /docs and /redoc.

Key features of Health Information API

• BMI Calculator
• Body Frame Size Calculator
• Body Fat Percentage Calculator (U.S. Navy Method)
• Macronutrient Calculator
• Food Nutrition Calculator (USDA FoodData Central API)

Use cases of Health Information API

• Calculate BMI from weight and height for health assessments.
• Determine body frame size based on wrist circumference and height.
• Estimate body fat percentage using the U.S. Navy method.
• Compute daily calorie and macronutrient targets based on personal data and goals.
• Look up the nutritional content of food ingredients using the USDA database.

FAQ from Health Information API

What endpoints does Health Information API offer?

The API provides a POST /bmi endpoint for BMI, POST /body-frame for body frame size, POST /body-fat for body fat percentage, POST /macros for macronutrients, and a GET /food-nutrition endpoint for food nutrition.

How do I get a USDA API key for the Food Nutrition Calculator?

Sign up for a free API key at https://fdc.nal.usda.gov/api-key-signup.html and set it as the USDA_API_KEY environment variable.

What dependencies are required to run the server?

Python libraries listed in requirements.txt. The README instructs to clone the repository and run pip install -r requirements.txt.

Is there an optional OpenAI API key?

Yes, an OPENAI_API_KEY can be set, but it is optional and not required for the basic functionality.

How do I run tests for Health Information API?

Use pytest -v from the root of the cloned repository.