Body Composition

AverageType

Bases: StrEnum

Relative descriptor indicating how a measurement compares to the average range.

BodyFatPercentIndicator

Bases: StrEnum

Body fat percentage classification based on age and gender.

LeanBodyMass pydantic-model

Bases: OtfItemBase

Lean body mass measurements by body segment, in pounds.

Show JSON schema:

{
  "description": "Lean body mass measurements by body segment, in pounds.",
  "properties": {
    "lbmOfLeftArm": {
      "description": "Lean body mass of left arm.",
      "title": "Lbmofleftarm",
      "type": "number"
    },
    "lbmOfLeftLeg": {
      "description": "Lean body mass of left leg.",
      "title": "Lbmofleftleg",
      "type": "number"
    },
    "lbmOfRightArm": {
      "description": "Lean body mass of right arm.",
      "title": "Lbmofrightarm",
      "type": "number"
    },
    "lbmOfRightLeg": {
      "description": "Lean body mass of right leg.",
      "title": "Lbmofrightleg",
      "type": "number"
    },
    "lbmOfTrunk": {
      "description": "Lean body mass of trunk.",
      "title": "Lbmoftrunk",
      "type": "number"
    }
  },
  "required": [
    "lbmOfLeftArm",
    "lbmOfLeftLeg",
    "lbmOfRightArm",
    "lbmOfRightLeg",
    "lbmOfTrunk"
  ],
  "title": "LeanBodyMass",
  "type": "object"
}

Fields:

• left_arm (float)
• left_leg (float)
• right_arm (float)
• right_leg (float)
• trunk (float)

left_arm pydantic-field

left_arm

Lean body mass of left arm.

left_leg pydantic-field

left_leg

Lean body mass of left leg.

right_arm pydantic-field

right_arm

Lean body mass of right arm.

right_leg pydantic-field

right_leg

Lean body mass of right leg.

trunk pydantic-field

trunk

Lean body mass of trunk.

LeanBodyMassPercent pydantic-model

Bases: OtfItemBase

Lean body mass as a percentage of total segment weight, by body segment.

Show JSON schema:

{
  "description": "Lean body mass as a percentage of total segment weight, by body segment.",
  "properties": {
    "lbmPercentOfLeftArm": {
      "description": "Lean body mass percent of left arm.",
      "title": "Lbmpercentofleftarm",
      "type": "number"
    },
    "lbmPercentOfLeftLeg": {
      "description": "Lean body mass percent of left leg.",
      "title": "Lbmpercentofleftleg",
      "type": "number"
    },
    "lbmPercentOfRightArm": {
      "description": "Lean body mass percent of right arm.",
      "title": "Lbmpercentofrightarm",
      "type": "number"
    },
    "lbmPercentOfRightLeg": {
      "description": "Lean body mass percent of right leg.",
      "title": "Lbmpercentofrightleg",
      "type": "number"
    },
    "lbmPercentOfTrunk": {
      "description": "Lean body mass percent of trunk.",
      "title": "Lbmpercentoftrunk",
      "type": "number"
    }
  },
  "required": [
    "lbmPercentOfLeftArm",
    "lbmPercentOfLeftLeg",
    "lbmPercentOfRightArm",
    "lbmPercentOfRightLeg",
    "lbmPercentOfTrunk"
  ],
  "title": "LeanBodyMassPercent",
  "type": "object"
}

Fields:

• left_arm (float)
• left_leg (float)
• right_arm (float)
• right_leg (float)
• trunk (float)

left_arm pydantic-field

left_arm

Lean body mass percent of left arm.

left_leg pydantic-field

left_leg

Lean body mass percent of left leg.

right_arm pydantic-field

right_arm

Lean body mass percent of right arm.

right_leg pydantic-field

right_leg

Lean body mass percent of right leg.

trunk pydantic-field

trunk

Lean body mass percent of trunk.

BodyFatMass pydantic-model

Bases: OtfItemBase

Body fat mass measurements by body segment, in pounds.

Show JSON schema:

{
  "description": "Body fat mass measurements by body segment, in pounds.",
  "properties": {
    "bfmControl": {
      "description": "Target body fat mass for the member's profile, used as a reference point on the InBody graph.",
      "title": "Bfmcontrol",
      "type": "number"
    },
    "bfmOfLeftArm": {
      "description": "Body fat mass of left arm.",
      "title": "Bfmofleftarm",
      "type": "number"
    },
    "bfmOfLeftLeg": {
      "description": "Body fat mass of left leg.",
      "title": "Bfmofleftleg",
      "type": "number"
    },
    "bfmOfRightArm": {
      "description": "Body fat mass of right arm.",
      "title": "Bfmofrightarm",
      "type": "number"
    },
    "bfmOfRightLeg": {
      "description": "Body fat mass of right leg.",
      "title": "Bfmofrightleg",
      "type": "number"
    },
    "bfmOfTrunk": {
      "description": "Body fat mass of trunk.",
      "title": "Bfmoftrunk",
      "type": "number"
    }
  },
  "required": [
    "bfmControl",
    "bfmOfLeftArm",
    "bfmOfLeftLeg",
    "bfmOfRightArm",
    "bfmOfRightLeg",
    "bfmOfTrunk"
  ],
  "title": "BodyFatMass",
  "type": "object"
}

Fields:

• control (float)
• left_arm (float)
• left_leg (float)
• right_arm (float)
• right_leg (float)
• trunk (float)

control pydantic-field

control

Target body fat mass for the member's profile, used as a reference point on the InBody graph.

left_arm pydantic-field

left_arm

Body fat mass of left arm.

left_leg pydantic-field

left_leg

Body fat mass of left leg.

right_arm pydantic-field

right_arm

Body fat mass of right arm.

right_leg pydantic-field

right_leg

Body fat mass of right leg.

trunk pydantic-field

trunk

Body fat mass of trunk.

BodyFatMassPercent pydantic-model

Bases: OtfItemBase

Body fat mass as a percentage of total segment weight, by body segment.

Show JSON schema:

{
  "description": "Body fat mass as a percentage of total segment weight, by body segment.",
  "properties": {
    "bfmPercentOfLeftArm": {
      "description": "Body fat mass percent of left arm.",
      "title": "Bfmpercentofleftarm",
      "type": "number"
    },
    "bfmPercentOfLeftLeg": {
      "description": "Body fat mass percent of left leg.",
      "title": "Bfmpercentofleftleg",
      "type": "number"
    },
    "bfmPercentOfRightArm": {
      "description": "Body fat mass percent of right arm.",
      "title": "Bfmpercentofrightarm",
      "type": "number"
    },
    "bfmPercentOfRightLeg": {
      "description": "Body fat mass percent of right leg.",
      "title": "Bfmpercentofrightleg",
      "type": "number"
    },
    "bfmPercentOfTrunk": {
      "description": "Body fat mass percent of trunk.",
      "title": "Bfmpercentoftrunk",
      "type": "number"
    }
  },
  "required": [
    "bfmPercentOfLeftArm",
    "bfmPercentOfLeftLeg",
    "bfmPercentOfRightArm",
    "bfmPercentOfRightLeg",
    "bfmPercentOfTrunk"
  ],
  "title": "BodyFatMassPercent",
  "type": "object"
}

Fields:

• left_arm (float)
• left_leg (float)
• right_arm (float)
• right_leg (float)
• trunk (float)

left_arm pydantic-field

left_arm

Body fat mass percent of left arm.

left_leg pydantic-field

left_leg

Body fat mass percent of left leg.

right_arm pydantic-field

right_arm

Body fat mass percent of right arm.

right_leg pydantic-field

right_leg

Body fat mass percent of right leg.

trunk pydantic-field

trunk

Body fat mass percent of trunk.

TotalBodyWater pydantic-model

Bases: OtfItemBase

Total body water measurements by body segment (TBW from InBody scanner).

Show JSON schema:

{
  "description": "Total body water measurements by body segment (TBW from InBody scanner).",
  "properties": {
    "tbwOfRightArm": {
      "description": "Total body water of right arm.",
      "title": "Tbwofrightarm",
      "type": "number"
    },
    "tbwOfLeftArm": {
      "description": "Total body water of left arm.",
      "title": "Tbwofleftarm",
      "type": "number"
    },
    "tbwOfTrunk": {
      "description": "Total body water of trunk.",
      "title": "Tbwoftrunk",
      "type": "number"
    },
    "tbwOfRightLeg": {
      "description": "Total body water of right leg.",
      "title": "Tbwofrightleg",
      "type": "number"
    },
    "tbwOfLeftLeg": {
      "description": "Total body water of left leg.",
      "title": "Tbwofleftleg",
      "type": "number"
    }
  },
  "required": [
    "tbwOfRightArm",
    "tbwOfLeftArm",
    "tbwOfTrunk",
    "tbwOfRightLeg",
    "tbwOfLeftLeg"
  ],
  "title": "TotalBodyWater",
  "type": "object"
}

Fields:

• right_arm (float)
• left_arm (float)
• trunk (float)
• right_leg (float)
• left_leg (float)

right_arm pydantic-field

right_arm

Total body water of right arm.

left_arm pydantic-field

left_arm

Total body water of left arm.

trunk pydantic-field

trunk

Total body water of trunk.

right_leg pydantic-field

right_leg

Total body water of right leg.

left_leg pydantic-field

left_leg

Total body water of left leg.

IntraCellularWater pydantic-model

Bases: OtfItemBase

Intracellular water measurements by body segment.

Show JSON schema:

{
  "description": "Intracellular water measurements by body segment.",
  "properties": {
    "icwOfRightArm": {
      "description": "Intracellular water of right arm.",
      "title": "Icwofrightarm",
      "type": "number"
    },
    "icwOfLeftArm": {
      "description": "Intracellular water of left arm.",
      "title": "Icwofleftarm",
      "type": "number"
    },
    "icwOfTrunk": {
      "description": "Intracellular water of trunk.",
      "title": "Icwoftrunk",
      "type": "number"
    },
    "icwOfRightLeg": {
      "description": "Intracellular water of right leg.",
      "title": "Icwofrightleg",
      "type": "number"
    },
    "icwOfLeftLeg": {
      "description": "Intracellular water of left leg.",
      "title": "Icwofleftleg",
      "type": "number"
    }
  },
  "required": [
    "icwOfRightArm",
    "icwOfLeftArm",
    "icwOfTrunk",
    "icwOfRightLeg",
    "icwOfLeftLeg"
  ],
  "title": "IntraCellularWater",
  "type": "object"
}

Fields:

• right_arm (float)
• left_arm (float)
• trunk (float)
• right_leg (float)
• left_leg (float)

right_arm pydantic-field

right_arm

Intracellular water of right arm.

left_arm pydantic-field

left_arm

Intracellular water of left arm.

trunk pydantic-field

trunk

Intracellular water of trunk.

right_leg pydantic-field

right_leg

Intracellular water of right leg.

left_leg pydantic-field

left_leg

Intracellular water of left leg.

ExtraCellularWater pydantic-model

Bases: OtfItemBase

Extracellular water measurements by body segment.

Show JSON schema:

{
  "description": "Extracellular water measurements by body segment.",
  "properties": {
    "ecwOfRightArm": {
      "description": "Extracellular water of right arm.",
      "title": "Ecwofrightarm",
      "type": "number"
    },
    "ecwOfLeftArm": {
      "description": "Extracellular water of left arm.",
      "title": "Ecwofleftarm",
      "type": "number"
    },
    "ecwOfTrunk": {
      "description": "Extracellular water of trunk.",
      "title": "Ecwoftrunk",
      "type": "number"
    },
    "ecwOfRightLeg": {
      "description": "Extracellular water of right leg.",
      "title": "Ecwofrightleg",
      "type": "number"
    },
    "ecwOfLeftLeg": {
      "description": "Extracellular water of left leg.",
      "title": "Ecwofleftleg",
      "type": "number"
    }
  },
  "required": [
    "ecwOfRightArm",
    "ecwOfLeftArm",
    "ecwOfTrunk",
    "ecwOfRightLeg",
    "ecwOfLeftLeg"
  ],
  "title": "ExtraCellularWater",
  "type": "object"
}

Fields:

• right_arm (float)
• left_arm (float)
• trunk (float)
• right_leg (float)
• left_leg (float)

right_arm pydantic-field

right_arm

Extracellular water of right arm.

left_arm pydantic-field

left_arm

Extracellular water of left arm.

trunk pydantic-field

trunk

Extracellular water of trunk.

right_leg pydantic-field

right_leg

Extracellular water of right leg.

left_leg pydantic-field

left_leg

Extracellular water of left leg.

ExtraCellularWaterOverTotalBodyWater pydantic-model

Bases: OtfItemBase

Ratio of extracellular water to total body water by body segment.

Show JSON schema:

{
  "description": "Ratio of extracellular water to total body water by body segment.",
  "properties": {
    "ecwOverTBWOfRightArm": {
      "description": "ECW/TBW ratio of right arm.",
      "title": "Ecwovertbwofrightarm",
      "type": "number"
    },
    "ecwOverTBWOfLeftArm": {
      "description": "ECW/TBW ratio of left arm.",
      "title": "Ecwovertbwofleftarm",
      "type": "number"
    },
    "ecwOverTBWOfTrunk": {
      "description": "ECW/TBW ratio of trunk.",
      "title": "Ecwovertbwoftrunk",
      "type": "number"
    },
    "ecwOverTBWOfRightLeg": {
      "description": "ECW/TBW ratio of right leg.",
      "title": "Ecwovertbwofrightleg",
      "type": "number"
    },
    "ecwOverTBWOfLeftLeg": {
      "description": "ECW/TBW ratio of left leg.",
      "title": "Ecwovertbwofleftleg",
      "type": "number"
    }
  },
  "required": [
    "ecwOverTBWOfRightArm",
    "ecwOverTBWOfLeftArm",
    "ecwOverTBWOfTrunk",
    "ecwOverTBWOfRightLeg",
    "ecwOverTBWOfLeftLeg"
  ],
  "title": "ExtraCellularWaterOverTotalBodyWater",
  "type": "object"
}

Fields:

• right_arm (float)
• left_arm (float)
• trunk (float)
• right_leg (float)
• left_leg (float)

right_arm pydantic-field

right_arm

ECW/TBW ratio of right arm.

left_arm pydantic-field

left_arm

ECW/TBW ratio of left arm.

trunk pydantic-field

trunk

ECW/TBW ratio of trunk.

right_leg pydantic-field

right_leg

ECW/TBW ratio of right leg.

left_leg pydantic-field

left_leg

ECW/TBW ratio of left leg.

BodyCompositionData pydantic-model

Bases: OtfItemBase

InBody scan results including body composition metrics and segmental analysis.

NOTE: weight is hardcoded to be pounds here, regardless of the unit shown in the member details.

Show JSON schema:

{
  "$defs": {
    "BodyFatMass": {
      "description": "Body fat mass measurements by body segment, in pounds.",
      "properties": {
        "bfmControl": {
          "description": "Target body fat mass for the member's profile, used as a reference point on the InBody graph.",
          "title": "Bfmcontrol",
          "type": "number"
        },
        "bfmOfLeftArm": {
          "description": "Body fat mass of left arm.",
          "title": "Bfmofleftarm",
          "type": "number"
        },
        "bfmOfLeftLeg": {
          "description": "Body fat mass of left leg.",
          "title": "Bfmofleftleg",
          "type": "number"
        },
        "bfmOfRightArm": {
          "description": "Body fat mass of right arm.",
          "title": "Bfmofrightarm",
          "type": "number"
        },
        "bfmOfRightLeg": {
          "description": "Body fat mass of right leg.",
          "title": "Bfmofrightleg",
          "type": "number"
        },
        "bfmOfTrunk": {
          "description": "Body fat mass of trunk.",
          "title": "Bfmoftrunk",
          "type": "number"
        }
      },
      "required": [
        "bfmControl",
        "bfmOfLeftArm",
        "bfmOfLeftLeg",
        "bfmOfRightArm",
        "bfmOfRightLeg",
        "bfmOfTrunk"
      ],
      "title": "BodyFatMass",
      "type": "object"
    },
    "BodyFatMassPercent": {
      "description": "Body fat mass as a percentage of total segment weight, by body segment.",
      "properties": {
        "bfmPercentOfLeftArm": {
          "description": "Body fat mass percent of left arm.",
          "title": "Bfmpercentofleftarm",
          "type": "number"
        },
        "bfmPercentOfLeftLeg": {
          "description": "Body fat mass percent of left leg.",
          "title": "Bfmpercentofleftleg",
          "type": "number"
        },
        "bfmPercentOfRightArm": {
          "description": "Body fat mass percent of right arm.",
          "title": "Bfmpercentofrightarm",
          "type": "number"
        },
        "bfmPercentOfRightLeg": {
          "description": "Body fat mass percent of right leg.",
          "title": "Bfmpercentofrightleg",
          "type": "number"
        },
        "bfmPercentOfTrunk": {
          "description": "Body fat mass percent of trunk.",
          "title": "Bfmpercentoftrunk",
          "type": "number"
        }
      },
      "required": [
        "bfmPercentOfLeftArm",
        "bfmPercentOfLeftLeg",
        "bfmPercentOfRightArm",
        "bfmPercentOfRightLeg",
        "bfmPercentOfTrunk"
      ],
      "title": "BodyFatMassPercent",
      "type": "object"
    },
    "ExtraCellularWater": {
      "description": "Extracellular water measurements by body segment.",
      "properties": {
        "ecwOfRightArm": {
          "description": "Extracellular water of right arm.",
          "title": "Ecwofrightarm",
          "type": "number"
        },
        "ecwOfLeftArm": {
          "description": "Extracellular water of left arm.",
          "title": "Ecwofleftarm",
          "type": "number"
        },
        "ecwOfTrunk": {
          "description": "Extracellular water of trunk.",
          "title": "Ecwoftrunk",
          "type": "number"
        },
        "ecwOfRightLeg": {
          "description": "Extracellular water of right leg.",
          "title": "Ecwofrightleg",
          "type": "number"
        },
        "ecwOfLeftLeg": {
          "description": "Extracellular water of left leg.",
          "title": "Ecwofleftleg",
          "type": "number"
        }
      },
      "required": [
        "ecwOfRightArm",
        "ecwOfLeftArm",
        "ecwOfTrunk",
        "ecwOfRightLeg",
        "ecwOfLeftLeg"
      ],
      "title": "ExtraCellularWater",
      "type": "object"
    },
    "ExtraCellularWaterOverTotalBodyWater": {
      "description": "Ratio of extracellular water to total body water by body segment.",
      "properties": {
        "ecwOverTBWOfRightArm": {
          "description": "ECW/TBW ratio of right arm.",
          "title": "Ecwovertbwofrightarm",
          "type": "number"
        },
        "ecwOverTBWOfLeftArm": {
          "description": "ECW/TBW ratio of left arm.",
          "title": "Ecwovertbwofleftarm",
          "type": "number"
        },
        "ecwOverTBWOfTrunk": {
          "description": "ECW/TBW ratio of trunk.",
          "title": "Ecwovertbwoftrunk",
          "type": "number"
        },
        "ecwOverTBWOfRightLeg": {
          "description": "ECW/TBW ratio of right leg.",
          "title": "Ecwovertbwofrightleg",
          "type": "number"
        },
        "ecwOverTBWOfLeftLeg": {
          "description": "ECW/TBW ratio of left leg.",
          "title": "Ecwovertbwofleftleg",
          "type": "number"
        }
      },
      "required": [
        "ecwOverTBWOfRightArm",
        "ecwOverTBWOfLeftArm",
        "ecwOverTBWOfTrunk",
        "ecwOverTBWOfRightLeg",
        "ecwOverTBWOfLeftLeg"
      ],
      "title": "ExtraCellularWaterOverTotalBodyWater",
      "type": "object"
    },
    "IntraCellularWater": {
      "description": "Intracellular water measurements by body segment.",
      "properties": {
        "icwOfRightArm": {
          "description": "Intracellular water of right arm.",
          "title": "Icwofrightarm",
          "type": "number"
        },
        "icwOfLeftArm": {
          "description": "Intracellular water of left arm.",
          "title": "Icwofleftarm",
          "type": "number"
        },
        "icwOfTrunk": {
          "description": "Intracellular water of trunk.",
          "title": "Icwoftrunk",
          "type": "number"
        },
        "icwOfRightLeg": {
          "description": "Intracellular water of right leg.",
          "title": "Icwofrightleg",
          "type": "number"
        },
        "icwOfLeftLeg": {
          "description": "Intracellular water of left leg.",
          "title": "Icwofleftleg",
          "type": "number"
        }
      },
      "required": [
        "icwOfRightArm",
        "icwOfLeftArm",
        "icwOfTrunk",
        "icwOfRightLeg",
        "icwOfLeftLeg"
      ],
      "title": "IntraCellularWater",
      "type": "object"
    },
    "LeanBodyMass": {
      "description": "Lean body mass measurements by body segment, in pounds.",
      "properties": {
        "lbmOfLeftArm": {
          "description": "Lean body mass of left arm.",
          "title": "Lbmofleftarm",
          "type": "number"
        },
        "lbmOfLeftLeg": {
          "description": "Lean body mass of left leg.",
          "title": "Lbmofleftleg",
          "type": "number"
        },
        "lbmOfRightArm": {
          "description": "Lean body mass of right arm.",
          "title": "Lbmofrightarm",
          "type": "number"
        },
        "lbmOfRightLeg": {
          "description": "Lean body mass of right leg.",
          "title": "Lbmofrightleg",
          "type": "number"
        },
        "lbmOfTrunk": {
          "description": "Lean body mass of trunk.",
          "title": "Lbmoftrunk",
          "type": "number"
        }
      },
      "required": [
        "lbmOfLeftArm",
        "lbmOfLeftLeg",
        "lbmOfRightArm",
        "lbmOfRightLeg",
        "lbmOfTrunk"
      ],
      "title": "LeanBodyMass",
      "type": "object"
    },
    "LeanBodyMassPercent": {
      "description": "Lean body mass as a percentage of total segment weight, by body segment.",
      "properties": {
        "lbmPercentOfLeftArm": {
          "description": "Lean body mass percent of left arm.",
          "title": "Lbmpercentofleftarm",
          "type": "number"
        },
        "lbmPercentOfLeftLeg": {
          "description": "Lean body mass percent of left leg.",
          "title": "Lbmpercentofleftleg",
          "type": "number"
        },
        "lbmPercentOfRightArm": {
          "description": "Lean body mass percent of right arm.",
          "title": "Lbmpercentofrightarm",
          "type": "number"
        },
        "lbmPercentOfRightLeg": {
          "description": "Lean body mass percent of right leg.",
          "title": "Lbmpercentofrightleg",
          "type": "number"
        },
        "lbmPercentOfTrunk": {
          "description": "Lean body mass percent of trunk.",
          "title": "Lbmpercentoftrunk",
          "type": "number"
        }
      },
      "required": [
        "lbmPercentOfLeftArm",
        "lbmPercentOfLeftLeg",
        "lbmPercentOfRightArm",
        "lbmPercentOfRightLeg",
        "lbmPercentOfTrunk"
      ],
      "title": "LeanBodyMassPercent",
      "type": "object"
    },
    "TotalBodyWater": {
      "description": "Total body water measurements by body segment (TBW from InBody scanner).",
      "properties": {
        "tbwOfRightArm": {
          "description": "Total body water of right arm.",
          "title": "Tbwofrightarm",
          "type": "number"
        },
        "tbwOfLeftArm": {
          "description": "Total body water of left arm.",
          "title": "Tbwofleftarm",
          "type": "number"
        },
        "tbwOfTrunk": {
          "description": "Total body water of trunk.",
          "title": "Tbwoftrunk",
          "type": "number"
        },
        "tbwOfRightLeg": {
          "description": "Total body water of right leg.",
          "title": "Tbwofrightleg",
          "type": "number"
        },
        "tbwOfLeftLeg": {
          "description": "Total body water of left leg.",
          "title": "Tbwofleftleg",
          "type": "number"
        }
      },
      "required": [
        "tbwOfRightArm",
        "tbwOfLeftArm",
        "tbwOfTrunk",
        "tbwOfRightLeg",
        "tbwOfLeftLeg"
      ],
      "title": "TotalBodyWater",
      "type": "object"
    }
  },
  "description": "InBody scan results including body composition metrics and segmental analysis.\n\nNOTE: weight is hardcoded to be pounds here, regardless of the unit shown in the member details.",
  "properties": {
    "memberUUId": {
      "description": "Unique identifier for the member.",
      "title": "Memberuuid",
      "type": "string"
    },
    "memberId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        }
      ],
      "description": "Numeric member ID.",
      "title": "Memberid"
    },
    "scanResultUUId": {
      "description": "Unique identifier for this scan result.",
      "title": "Scanresultuuid",
      "type": "string"
    },
    "id": {
      "description": "InBody ID, same as email address",
      "title": "Id",
      "type": "string"
    },
    "email": {
      "description": "Email address associated with the InBody account.",
      "title": "Email",
      "type": "string"
    },
    "height": {
      "description": "Height in cm",
      "title": "Height",
      "type": "string"
    },
    "gender": {
      "description": "Gender used for body fat percentage calculations.",
      "enum": [
        "M",
        "F"
      ],
      "title": "Gender",
      "type": "string"
    },
    "age": {
      "description": "Age used for body fat percentage calculations.",
      "title": "Age",
      "type": "integer"
    },
    "testDatetime": {
      "description": "When the InBody scan was performed.",
      "format": "date-time",
      "title": "Testdatetime",
      "type": "string"
    },
    "weight": {
      "description": "Weight in pounds, provided by member at time of scan",
      "title": "Weight",
      "type": "number"
    },
    "lean_body_mass_details": {
      "allOf": [
        {
          "$ref": "#/$defs/LeanBodyMass"
        }
      ],
      "description": "Lean body mass breakdown by body segment."
    },
    "lean_body_mass_percent_details": {
      "allOf": [
        {
          "$ref": "#/$defs/LeanBodyMassPercent"
        }
      ],
      "description": "Lean body mass percentages by body segment."
    },
    "tbw": {
      "description": "Total body water in liters, from InBody scan.",
      "title": "Tbw",
      "type": "number"
    },
    "dlm": {
      "description": "Dry lean mass in pounds.",
      "title": "Dlm",
      "type": "number"
    },
    "bfm": {
      "description": "Body fat mass in pounds.",
      "title": "Bfm",
      "type": "number"
    },
    "lbm": {
      "description": "Total lean body mass in pounds.",
      "title": "Lbm",
      "type": "number"
    },
    "smm": {
      "description": "Skeletal muscle mass in pounds.",
      "title": "Smm",
      "type": "number"
    },
    "bmi": {
      "description": "Body mass index.",
      "title": "Bmi",
      "type": "number"
    },
    "pbf": {
      "description": "Body fat as a percentage of total weight.",
      "title": "Pbf",
      "type": "number"
    },
    "bmr": {
      "description": "Basal metabolic rate in calories.",
      "title": "Bmr",
      "type": "number"
    },
    "inBodyType": {
      "description": "InBody body type classification.",
      "title": "Inbodytype",
      "type": "string"
    },
    "bfmGraphScale": {
      "items": {
        "type": "number"
      },
      "title": "Bfmgraphscale",
      "type": "array"
    },
    "pfatnew": {
      "title": "Pfatnew",
      "type": "number"
    },
    "smmGraphScale": {
      "items": {
        "type": "number"
      },
      "title": "Smmgraphscale",
      "type": "array"
    },
    "psmm": {
      "title": "Psmm",
      "type": "number"
    },
    "wtGraphScale": {
      "items": {
        "type": "number"
      },
      "title": "Wtgraphscale",
      "type": "array"
    },
    "pwt": {
      "title": "Pwt",
      "type": "number"
    },
    "body_fat_mass_details": {
      "$ref": "#/$defs/BodyFatMass"
    },
    "body_fat_mass_percent_details": {
      "$ref": "#/$defs/BodyFatMassPercent"
    },
    "total_body_water_details": {
      "$ref": "#/$defs/TotalBodyWater"
    },
    "intra_cellular_water_details": {
      "$ref": "#/$defs/IntraCellularWater"
    },
    "extra_cellular_water_details": {
      "$ref": "#/$defs/ExtraCellularWater"
    },
    "extra_cellular_water_over_total_body_water_details": {
      "$ref": "#/$defs/ExtraCellularWaterOverTotalBodyWater"
    },
    "vfl": {
      "title": "Vfl",
      "type": "number"
    },
    "vfa": {
      "title": "Vfa",
      "type": "number"
    },
    "bcm": {
      "title": "Bcm",
      "type": "number"
    },
    "tbwOverLBM": {
      "title": "Tbwoverlbm",
      "type": "number"
    },
    "icw": {
      "title": "Icw",
      "type": "number"
    },
    "ecw": {
      "title": "Ecw",
      "type": "number"
    },
    "lbmControl": {
      "title": "Lbmcontrol",
      "type": "number"
    }
  },
  "required": [
    "memberUUId",
    "memberId",
    "scanResultUUId",
    "id",
    "email",
    "height",
    "gender",
    "age",
    "testDatetime",
    "weight",
    "lean_body_mass_details",
    "lean_body_mass_percent_details",
    "tbw",
    "dlm",
    "bfm",
    "lbm",
    "smm",
    "bmi",
    "pbf",
    "bmr",
    "inBodyType",
    "bfmGraphScale",
    "pfatnew",
    "smmGraphScale",
    "psmm",
    "wtGraphScale",
    "pwt",
    "body_fat_mass_details",
    "body_fat_mass_percent_details",
    "total_body_water_details",
    "intra_cellular_water_details",
    "extra_cellular_water_details",
    "extra_cellular_water_over_total_body_water_details",
    "vfl",
    "vfa",
    "bcm",
    "tbwOverLBM",
    "icw",
    "ecw",
    "lbmControl"
  ],
  "title": "BodyCompositionData",
  "type": "object"
}

Fields:

• member_uuid (str)
• member_id (str | int)
• scan_result_uuid (str)
• inbody_id (str)
• email (str)
• height (str)
• gender (Literal['M', 'F'])
• age (int)
• scan_datetime (datetime)
• provided_weight (float)
• lean_body_mass_details (LeanBodyMass)
• lean_body_mass_percent_details (LeanBodyMassPercent)
• total_body_water (float)
• dry_lean_mass (float)
• body_fat_mass (float)
• lean_body_mass (float)
• skeletal_muscle_mass (float)
• body_mass_index (float)
• percent_body_fat (float)
• basal_metabolic_rate (float)
• in_body_type (str)
• body_fat_mass_dividers (list[float])
• body_fat_mass_plot_point (float)
• skeletal_muscle_mass_dividers (list[float])
• skeletal_muscle_mass_plot_point (float)
• weight_dividers (list[float])
• weight_plot_point (float)
• body_fat_mass_details (BodyFatMass)
• body_fat_mass_percent_details (BodyFatMassPercent)
• total_body_water_details (TotalBodyWater)
• intra_cellular_water_details (IntraCellularWater)
• extra_cellular_water_details (ExtraCellularWater)
• extra_cellular_water_over_total_body_water_details (ExtraCellularWaterOverTotalBodyWater)
• visceral_fat_level (float)
• visceral_fat_area (float)
• body_comp_measurement (float)
• total_body_water_over_lean_body_mass (float)
• intracellular_water (float)
• extracellular_water (float)
• lean_body_mass_control (float)

Validators:

• convert_dividers_to_float_list → skeletal_muscle_mass_dividers, weight_dividers, body_fat_mass_dividers
• convert_body_water_from_kg_to_liters → total_body_water

member_uuid pydantic-field

member_uuid

Unique identifier for the member.

member_id pydantic-field

member_id

Numeric member ID.

scan_result_uuid pydantic-field

scan_result_uuid

Unique identifier for this scan result.

inbody_id pydantic-field

inbody_id

InBody ID, same as email address

email pydantic-field

email

Email address associated with the InBody account.

height pydantic-field

height

Height in cm

gender pydantic-field

gender

Gender used for body fat percentage calculations.

age pydantic-field

age

Age used for body fat percentage calculations.

scan_datetime pydantic-field

scan_datetime

When the InBody scan was performed.

provided_weight pydantic-field

provided_weight

Weight in pounds, provided by member at time of scan

lean_body_mass_details pydantic-field

lean_body_mass_details

Lean body mass breakdown by body segment.

lean_body_mass_percent_details pydantic-field

lean_body_mass_percent_details

Lean body mass percentages by body segment.

total_body_water pydantic-field

total_body_water

Total body water in liters, from InBody scan.

dry_lean_mass pydantic-field

dry_lean_mass

Dry lean mass in pounds.

body_fat_mass pydantic-field

body_fat_mass

Body fat mass in pounds.

lean_body_mass pydantic-field

lean_body_mass

Total lean body mass in pounds.

skeletal_muscle_mass pydantic-field

skeletal_muscle_mass

Skeletal muscle mass in pounds.

body_mass_index pydantic-field

body_mass_index

Body mass index.

percent_body_fat pydantic-field

percent_body_fat

Body fat as a percentage of total weight.

basal_metabolic_rate pydantic-field

basal_metabolic_rate

Basal metabolic rate in calories.

in_body_type pydantic-field

in_body_type

InBody body type classification.

body_fat_mass_relative_descriptor property

body_fat_mass_relative_descriptor

Get the relative descriptor for the body fat mass plot point.

For this item, a lower value is better.

Returns:

Name	Type	Description
AverageType	AverageType	The relative descriptor for the body fat mass plot point

skeletal_muscle_mass_relative_descriptor property

skeletal_muscle_mass_relative_descriptor

Get the relative descriptor for the skeletal muscle mass plot point.

For this item, a higher value is better.

Returns:

Name	Type	Description
AverageType	AverageType	The relative descriptor for the skeletal muscle mass plot point

weight_relative_descriptor property

weight_relative_descriptor

Get the relative descriptor for the weight plot point.

For this item, a lower value is better.

Returns:

Name	Type	Description
AverageType	AverageType	The relative descriptor for the weight

body_fat_percent_relative_descriptor property

body_fat_percent_relative_descriptor

Get the relative descriptor for the percent body fat.

Returns:

Name	Type	Description
BodyFatPercentIndicator	BodyFatPercentIndicator	The relative descriptor for the percent body fat

convert_dividers_to_float_list pydantic-validator

convert_dividers_to_float_list(v)

Convert the dividers from a string to a list of floats.

Parameters:

Name	Type	Description	Default
v	str	The dividers as a string, separated by semicolons.	required

Returns:

Type	Description
list[float]	list[float]: The dividers as a list of floats.

convert_body_water_from_kg_to_liters pydantic-validator

convert_body_water_from_kg_to_liters(v)

Convert total body water from kg to liters.

Parameters:

Name	Type	Description	Default
v	float	Total body water in kg.	required

Returns:

Name	Type	Description
float	float	Total body water in liters (1 kg water ≈ 1 liter).

get_percent_body_fat_descriptor

get_percent_body_fat_descriptor(percent_body_fat, body_fat_percent_dividers)

Get the body fat percent descriptor based on the percent body fat and dividers.

Parameters:

Name	Type	Description	Default
percent_body_fat	float	The percent body fat to check	required
body_fat_percent_dividers	list[float]	The dividers for the percent body fat	required

Returns:

Name	Type	Description
BodyFatPercentIndicator	BodyFatPercentIndicator	The body fat percent descriptor

get_relative_descriptor

get_relative_descriptor(in_body_value, in_body_dividers)

Get the relative descriptor for the InBody value.

Parameters:

Name	Type	Description	Default
in_body_value	float	The InBody value to check	required
in_body_dividers	list[float]	The dividers for the InBody value	required

Returns:

Name	Type	Description
AverageType	AverageType	The relative descriptor for the InBody value

get_body_fat_percent_dividers

get_body_fat_percent_dividers(age, gender)

Get the body fat percent dividers based on age and gender.

Converted more or less directly from the Java code in the OTF app.

Parameters:

Name	Type	Description	Default
age	int	The age of the person	required
gender	Literal['M', 'F']	The gender from the member details	required

Returns:

Type	Description
list[float]	list[float]: The body fat percent dividers

get_body_fat_percent_dividers_male

get_body_fat_percent_dividers_male(age)

Get the body fat percent dividers for males based on age.

Converted more or less directly from the Java code in the OTF app.

Parameters:

Name	Type	Description	Default
age	int	The age of the person	required

Returns:

Type	Description
list[float]	list[float]: The body fat percent dividers

get_body_fat_percent_dividers_female

get_body_fat_percent_dividers_female(age)

Get the body fat percent dividers for females based on age.

Converted more or less directly from the Java code in the OTF app.

Parameters:

Name	Type	Description	Default
age	int	The age of the person	required

Returns:

Type	Description
list[float]	list[float]: The body fat percent dividers