About this endpoint
What it does
Calculates BMI from the submitted weight and height, using metric or imperial units. The endpoint accepts optional waist and target BMI inputs, but the response schema is not yet defined in the output schema.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| unit | ENUM | No | Allowed values: metric, imperial.Default: metric.Use metric for kg and cm, or imperial for lb and inches. |
| waist | Number | No | Optional waist measurement in cm (metric) or inches (imperial). Minimum: 0.0001. Adds the waist-to-height ratio and its band. |
| height | Number | Yes | Height in cm (metric) or inches (imperial). Minimum: 0.0001. Metric range: 50 to 272 cm. Imperial range: 20 to 107 in. |
| weight | Number | Yes | Weight in kg (metric) or pounds (imperial). Minimum: 0.0001. Metric range: 2 to 700 kg. Imperial range: 4 to 1500 lb. |
| targetBmi | Number | No | Optional target BMI. Minimum: 0.0001. Allowed range: 10 to 60. Adds the weight that gives it at this height and the change from now. |
| targetBmiPrime | Number | No | Optional target BMI Prime. Minimum: 0.0001. Target BMI Prime is target BMI divided by 25. Send this or targetBmi, not both. |
Response
| Parameter | Type | Description |
|---|---|---|
| result | object | Contains the BMI calculation results. |
| result.bmi | number | Calculated Body Mass Index (BMI). |
| result.category | string | BMI category (e.g., Normal). |
| result.bmiPrime | number | BMI Prime value. |
| result.ponderalIndex | number | Calculated Ponderal Index. |
| result.whoClass | string | WHO BMI classification. |
| result.whoRange | string | BMI range associated with the WHO classification. |
| result.healthyWeightRange | object | Contains the estimated healthy weight range in kilograms. |
| result.healthyWeightRange.lowKg | number | Lower limit of the healthy weight range in kg. |
| result.healthyWeightRange.highKg | number | Upper limit of the healthy weight range in kg. |
| result.steps | array | Contains the calculation steps, formulas, inputs, and intermediate results. |
| result.steps[].label | string | Name of the calculation step. |
| result.steps[].formula | string | Formula used for the calculation. |
| result.steps[].inputs | object | Input values used in the calculation step. |
| result.steps[].result | number/string | Result of the calculation step. |


