Insights API Reference

Technical specifications for the HealthIQ RapidAPI Insights operations.

Basic Tier

Profile Flags

Reviews key indicators like BMI and raises alerts for critically low or high metabolic states.

POST /v1/insights/profile-flags

Request Parameters

Parameter	Type	Range / Options	Description
`Age`	Number	1-120	Chronological age of user.
`Weight`	Number	> 0 (kg)	User weight in kg.
`Height`	Number	> 0 (cm)	User height in cm.
`Gender`	String	`male`, `female`	Biological sex.
`ActivityLevel`	String	`sedentary`, `light`, `moderate`, `active`	Basic multiplier tracking.
`Goal`	String	`lose`, `maintain`, `gain`	Directs algorithmic trajectory.

Example JSON Request

{
  "age": 30,
  "weight": 85.0,
  "height": 175.0,
  "gender": "male",
  "activityLevel": "sedentary",
  "goal": "lose"
}

Response Parameters

Parameter	Type	Range / Options	Description
`bmi`	Number	points	Measured Body Mass Index.
`bmiCategory`	String	`Underweight`, `Normal`, `Overweight`, `Obese`	Category placement according to CDC bands.
`recommendedCalories`	Number	kcal/day	Deficit or surplus adjustments for target.
`flags`	Array[String]	Critical risk indicators	Warnings associated with current mass levels.
`recommendations`	Array[String]	Suggestive text	Actionable suggestions mapped algorithmically.
`summary`	String	text	Wrap-up notification text.

Example JSON Response

{
  "bmi": 27.7,
  "bmiCategory": "Overweight",
  "recommendedCalories": 2200,
  "flags": [
    "Elevated BMI"
  ],
  "recommendations": [
    "Lower caloric intake slightly",
    "Incorporate cardio sessions."
  ],
  "summary": "Health risk profile calculated."
}

Pro Tier

Body Fat

Applies the sophisticated US Navy circumference method to calculate body fat percentage.

POST /v1/insights/body-fat

Request Parameters

Parameter	Type	Range / Options	Description
`Gender`	String	`male`, `female`	Required for differing mathematical equations.
`HeightCm`	Number	> 0 (cm)	Height in centimeters.
`NeckCircumferenceCm`	Number	> 0 (cm)	Neck measurement around the adam's apple.
`WaistCircumferenceCm`	Number	> 0 (cm)	Waist measurement at the navel.
`HipCircumferenceCm`	Number	> 0 (cm)	Hip measurement at widest point (Optional mostly for men).

Example JSON Request

{
  "gender": "male",
  "heightCm": 175.0,
  "neckCircumferenceCm": 38.0,
  "waistCircumferenceCm": 85.0
}

Response Parameters

Parameter	Type	Range / Options	Description
`estimatedBodyFatPercentage`	Number	% Percentage	The computed total body fat.
`category`	String	`Essential Fat`, `Athletes`, `Fitness`, `Average`, `Obese`	The bracket standard matching the percentage.
`summary`	String	text	Wrapup text defining the process used.

Example JSON Response

{
  "estimatedBodyFatPercentage": 14.5,
  "category": "Fitness",
  "summary": "Estimated using US Navy Method."
}

Ultra Tier

Goal Timeline

Provides trajectory analyses on how many safe weeks it will realistically take to drop required weight.

POST /v1/insights/goal-timeline

Request Parameters

Parameter	Type	Range / Options	Description
`Weight`	Number	> 0 (kg)	Current body weight.
`TargetWeight`	Number	> 0 (kg)	Desired goal body weight.
(Base Profile)	...	...	Requires all base `ProfileBaseClass` requirements.

Example JSON Request

{
  "weight": 90.0,
  "targetWeight": 80.0,
  "age": 30,
  "height": 175.0,
  "gender": "male",
  "activityLevel": "sedentary",
  "goal": "lose"
}

Response Parameters

Parameter	Type	Range / Options	Description
`estimatedWeeksToGoal`	Number	Weeks scalar	Total number of predicted weeks to reach the final goal.
`summary`	String	text	Sentence summarizing duration stringing.

Example JSON Response

{
  "estimatedWeeksToGoal": 12,
  "summary": "It will take approximately 12 weeks to safely reach your target."
}

Mega Tier

Framingham Risk Score

Calculates the 10-year risk of cardiovascular disease using standard CDC lipid and BP metrics.

POST /v1/insights/framingham-risk

Request Parameters

Parameter	Type	Range / Options	Description
`Age`	Number	Years	Chronological age.
`Gender`	String	`male`, `female`	Biological sex.
`TotalCholesterol`	Number	mg/dL	Total serum cholesterol.
`HdlCholesterol`	Number	mg/dL	High-density lipoprotein cholesterol.
`SystolicBp`	Number	mmHg	Systolic blood pressure.
`IsTreatedForBp`	Boolean	`true`, `false`	Current treatment status.
`IsSmoker`	Boolean	`true`, `false`	Current smoking status.

Example JSON Request

{
  "age": 45,
  "gender": "male",
  "totalCholesterol": 210,
  "hdlCholesterol": 45,
  "systolicBp": 130,
  "isTreatedForBp": false,
  "isSmoker": false
}

Response Parameters

Parameter	Type	Range / Options	Description
`tenYearRiskPercentage`	Number	% Probability	10-year CVD risk percentage metric.
`riskCategory`	String	`Low Risk`, `Intermediate Risk`, `High Risk`	Banded risk stratification framework.
`summary`	String	text	Methodology wrap-up description.

Example JSON Response

{
  "tenYearRiskPercentage": 14.5,
  "riskCategory": "Intermediate Risk",
  "summary": "Predicted using standardized Framework Cardiovascular Risk tables."
}

Mega Tier

Phenotypic Age

Calculates estimated biological age vs chronological age using the Levine Gompertz mortality score algorithm.

POST /v1/insights/phenotypic-age

Request Parameters

Parameter	Type	Range / Options	Description
`Age`	Number	Years	Chronological age at time of measurement.
`Albumin`	Number	g/dL	Serum albumin concentration.
`Creatinine`	Number	mg/dL	Serum creatinine level.
`Glucose`	Number	mg/dL	Fasting blood glucose.
`Crp`	Number	mg/dL	C-Reactive Protein (Inflammation marker).
`LymphocytePercent`	Number	%	Lymphocyte differential percentage.
`MeanCellVolume`	Number	fL	Mean corpuscular volume (MCV).
`Rdw`	Number	%	Red blood cell distribution width.
`AlkalinePhosphatase`	Number	U/L	Alkaline Phosphatase enzyme presence.
`Wbc`	Number	1000/uL	Total White Blood Cell Count.

Example JSON Request

{
  "age": 40,
  "albumin": 4.5,
  "creatinine": 0.9,
  "glucose": 95.0,
  "crp": 1.2,
  "lymphocytePercent": 30.0,
  "meanCellVolume": 90.0,
  "rdw": 13.0,
  "alkalinePhosphatase": 70.0,
  "wbc": 6.0
}

Response Parameters

Parameter	Type	Range / Options	Description
`phenotypicAge`	Number	Years count	Calculated biological age in numerical years.
`mortalityScore`	Number	Levine Gompertz Base	Raw predictive mortality risk ratio.
`chronologicalAge`	Number	echo	Actual measured chronological age.
`summary`	String	text	Conclusion contrasting phenotype to genotype age.

Example JSON Response

{
  "phenotypicAge": 52.8,
  "mortalityScore": 1.5,
  "chronologicalAge": 40,
  "summary": "Calculated Biological Age is 52.8 vs Chronological Age 40."
}