Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/kingstinct/react-native-healthkit/llms.txt

Use this file to discover all available pages before exploring further.

HealthKit supports over 100 quantity type identifiers for tracking various health and fitness metrics. This page documents all available identifiers, organized by category.

Activity & Fitness

Steps & Distance

HKQuantityTypeIdentifierStepCount
Writeable
Number of steps taken. Unit: count
HKQuantityTypeIdentifierDistanceWalkingRunning
Writeable
Distance traveled while walking or running. Unit: m, ft, mi, km
HKQuantityTypeIdentifierDistanceCycling
Writeable
Distance traveled while cycling. Unit: m, ft, mi, km
HKQuantityTypeIdentifierDistanceWheelchair
Writeable
Distance traveled in a wheelchair. Unit: m, ft, mi, km
HKQuantityTypeIdentifierDistanceSwimming
Writeable
Distance traveled while swimming. Unit: m, ft, mi, km
HKQuantityTypeIdentifierDistanceDownhillSnowSports
Writeable
Distance traveled during downhill snow sports. Unit: m, ft, mi, km
HKQuantityTypeIdentifierDistanceCrossCountrySkiing
Writeable
Distance traveled while cross-country skiing. Unit: m, ft, mi, km
Available on iOS 18+
HKQuantityTypeIdentifierDistancePaddleSports
Writeable
Distance traveled during paddle sports. Unit: m, ft, mi, km
Available on iOS 18+
HKQuantityTypeIdentifierDistanceRowing
Writeable
Distance traveled while rowing. Unit: m, ft, mi, km
Available on iOS 18+
HKQuantityTypeIdentifierDistanceSkatingSports
Writeable
Distance traveled during skating sports. Unit: m, ft, mi, km
Available on iOS 18+

Energy & Activity Time

HKQuantityTypeIdentifierActiveEnergyBurned
Writeable
Active energy burned during activity. Unit: kcal, kJ, Cal
HKQuantityTypeIdentifierBasalEnergyBurned
Writeable
Basal (resting) energy burned. Unit: kcal, kJ, Cal
HKQuantityTypeIdentifierAppleExerciseTime
Read-only
Exercise time as measured by Apple Watch. Unit: min
HKQuantityTypeIdentifierAppleStandTime
Read-only
Stand time as measured by Apple Watch. Unit: min
HKQuantityTypeIdentifierAppleMoveTime
Writeable
Move time for users in wheelchair mode. Unit: min
Available on iOS 14.5+

Exercise Metrics

HKQuantityTypeIdentifierFlightsClimbed
Writeable
Number of flights of stairs climbed. Unit: count
HKQuantityTypeIdentifierPushCount
Writeable
Number of wheelchair pushes. Unit: count
HKQuantityTypeIdentifierSwimmingStrokeCount
Writeable
Number of swimming strokes. Unit: count
HKQuantityTypeIdentifierVO2Max
Writeable
Maximum oxygen consumption during exercise. Unit: mL/(kg·min)
HKQuantityTypeIdentifierNikeFuel
Writeable
Nike Fuel points earned. Unit: count

Running Metrics

HKQuantityTypeIdentifierRunningSpeed
Writeable
Running speed. Unit: m/s, km/h, mi/h
Available on iOS 16+
HKQuantityTypeIdentifierRunningPower
Writeable
Running power output. Unit: W
Available on iOS 16+
HKQuantityTypeIdentifierRunningStrideLength
Writeable
Running stride length. Unit: m, ft
Available on iOS 16+
HKQuantityTypeIdentifierRunningVerticalOscillation
Writeable
Vertical oscillation while running. Unit: cm, in
Available on iOS 16+
HKQuantityTypeIdentifierRunningGroundContactTime
Writeable
Ground contact time while running. Unit: ms
Available on iOS 16+

Cycling Metrics

HKQuantityTypeIdentifierCyclingSpeed
Writeable
Cycling speed. Unit: m/s, km/h, mi/h
Available on iOS 17+
HKQuantityTypeIdentifierCyclingPower
Writeable
Cycling power output. Unit: W
Available on iOS 17+
HKQuantityTypeIdentifierCyclingCadence
Writeable
Cycling cadence (pedal revolutions). Unit: count/min
Available on iOS 17+
HKQuantityTypeIdentifierCyclingFunctionalThresholdPower
Writeable
Functional threshold power for cycling. Unit: W
Available on iOS 17+

Other Sports

HKQuantityTypeIdentifierCrossCountrySkiingSpeed
Writeable
Cross-country skiing speed. Unit: m/s, km/h, mi/h
Available on iOS 18+
HKQuantityTypeIdentifierPaddleSportsSpeed
Writeable
Paddle sports speed. Unit: m/s, km/h, mi/h
Available on iOS 18+
HKQuantityTypeIdentifierRowingSpeed
Writeable
Rowing speed. Unit: m/s, km/h, mi/h
Available on iOS 18+

Workout Effort

HKQuantityTypeIdentifierPhysicalEffort
Writeable
Physical effort score. Unit: count
Available on iOS 17+
HKQuantityTypeIdentifierWorkoutEffortScore
Writeable
Workout effort score. Unit: count
Available on iOS 18+
HKQuantityTypeIdentifierEstimatedWorkoutEffortScore
Writeable
Estimated workout effort score. Unit: count
Available on iOS 18+

Body Measurements

HKQuantityTypeIdentifierBodyMass
Writeable
Body weight. Unit: kg, lb, st
HKQuantityTypeIdentifierBodyMassIndex
Writeable
Body mass index (BMI). Unit: count
HKQuantityTypeIdentifierBodyFatPercentage
Writeable
Body fat percentage. Unit: %
HKQuantityTypeIdentifierLeanBodyMass
Writeable
Lean body mass. Unit: kg, lb, st
HKQuantityTypeIdentifierHeight
Writeable
Height. Unit: m, cm, ft, in
HKQuantityTypeIdentifierWaistCircumference
Writeable
Waist circumference. Unit: m, cm, ft, in

Vital Signs

Heart

HKQuantityTypeIdentifierHeartRate
Writeable
Heart rate. Unit: count/min
HKQuantityTypeIdentifierRestingHeartRate
Writeable
Resting heart rate. Unit: count/min
HKQuantityTypeIdentifierWalkingHeartRateAverage
Read-only
Average heart rate while walking. Unit: count/min
Available on iOS 11+
HKQuantityTypeIdentifierHeartRateVariabilitySDNN
Writeable
Heart rate variability (SDNN). Unit: ms
Available on iOS 11+
HKQuantityTypeIdentifierHeartRateRecoveryOneMinute
Writeable
Heart rate recovery after one minute. Unit: count/min
Available on iOS 16+
HKQuantityTypeIdentifierAtrialFibrillationBurden
Read-only
Atrial fibrillation burden percentage. Unit: %
Available on iOS 16+

Blood Pressure

HKQuantityTypeIdentifierBloodPressureSystolic
Writeable
Systolic blood pressure. Unit: mmHg
HKQuantityTypeIdentifierBloodPressureDiastolic
Writeable
Diastolic blood pressure. Unit: mmHg

Respiratory

HKQuantityTypeIdentifierRespiratoryRate
Writeable
Respiratory rate. Unit: count/min
HKQuantityTypeIdentifierOxygenSaturation
Writeable
Blood oxygen saturation. Unit: %
HKQuantityTypeIdentifierPeripheralPerfusionIndex
Writeable
Peripheral perfusion index. Unit: %

Temperature

HKQuantityTypeIdentifierBodyTemperature
Writeable
Body temperature. Unit: degC, degF
HKQuantityTypeIdentifierBasalBodyTemperature
Writeable
Basal body temperature. Unit: degC, degF
HKQuantityTypeIdentifierAppleSleepingWristTemperature
Writeable
Sleeping wrist temperature (Apple Watch). Unit: degC, degF
Available on iOS 17+
HKQuantityTypeIdentifierWaterTemperature
Writeable
Water temperature. Unit: degC, degF
Available on iOS 16+

Laboratory & Clinical

Blood Glucose

HKQuantityTypeIdentifierBloodGlucose
Writeable
Blood glucose level. Unit: mg/dL, mmol/L
HKQuantityTypeIdentifierBloodKetones
Writeable
Blood ketone level. Unit: mmol/L
HKQuantityTypeIdentifierInsulinDelivery
Writeable
Insulin delivery amount. Unit: IU
Available on iOS 11+

Other Lab Values

HKQuantityTypeIdentifierBloodAlcoholContent
Writeable
Blood alcohol content. Unit: %
HKQuantityTypeIdentifierElectrodermalActivity
Writeable
Electrodermal activity (skin conductance). Unit: S (siemens)

Respiratory Function

HKQuantityTypeIdentifierForcedVitalCapacity
Writeable
Forced vital capacity. Unit: L
HKQuantityTypeIdentifierForcedExpiratoryVolume1
Writeable
Forced expiratory volume in 1 second (FEV1). Unit: L
HKQuantityTypeIdentifierPeakExpiratoryFlowRate
Writeable
Peak expiratory flow rate. Unit: L/min
HKQuantityTypeIdentifierInhalerUsage
Writeable
Number of inhaler puffs. Unit: count

Nutrition

Macronutrients

HKQuantityTypeIdentifierDietaryEnergyConsumed
Writeable
Dietary energy consumed. Unit: kcal, kJ, Cal
HKQuantityTypeIdentifierDietaryProtein
Writeable
Protein consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryCarbohydrates
Writeable
Carbohydrates consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryFiber
Writeable
Dietary fiber consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietarySugar
Writeable
Sugar consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryFatTotal
Writeable
Total fat consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryFatSaturated
Writeable
Saturated fat consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryFatMonounsaturated
Writeable
Monounsaturated fat consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryFatPolyunsaturated
Writeable
Polyunsaturated fat consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryCholesterol
Writeable
Cholesterol consumed. Unit: g, mg, μg

Vitamins

HKQuantityTypeIdentifierDietaryVitaminA
Writeable
Vitamin A consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryVitaminB6
Writeable
Vitamin B6 consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryVitaminB12
Writeable
Vitamin B12 consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryVitaminC
Writeable
Vitamin C consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryVitaminD
Writeable
Vitamin D consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryVitaminE
Writeable
Vitamin E consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryVitaminK
Writeable
Vitamin K consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryThiamin
Writeable
Thiamin (Vitamin B1) consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryRiboflavin
Writeable
Riboflavin (Vitamin B2) consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryNiacin
Writeable
Niacin (Vitamin B3) consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryFolate
Writeable
Folate consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryBiotin
Writeable
Biotin consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryPantothenicAcid
Writeable
Pantothenic acid consumed. Unit: g, mg, μg

Minerals

HKQuantityTypeIdentifierDietaryCalcium
Writeable
Calcium consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryIron
Writeable
Iron consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryMagnesium
Writeable
Magnesium consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryPhosphorus
Writeable
Phosphorus consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryPotassium
Writeable
Potassium consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietarySodium
Writeable
Sodium consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryZinc
Writeable
Zinc consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryIodine
Writeable
Iodine consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietarySelenium
Writeable
Selenium consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryCopper
Writeable
Copper consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryManganese
Writeable
Manganese consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryChromium
Writeable
Chromium consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryMolybdenum
Writeable
Molybdenum consumed. Unit: g, mg, μg
HKQuantityTypeIdentifierDietaryChloride
Writeable
Chloride consumed. Unit: g, mg, μg

Hydration & Other

HKQuantityTypeIdentifierDietaryWater
Writeable
Water consumed. Unit: mL, L, fl_oz_us, fl_oz_imp, cup_us, cup_imp
HKQuantityTypeIdentifierDietaryCaffeine
Writeable
Caffeine consumed. Unit: g, mg, μg

Mobility

HKQuantityTypeIdentifierWalkingSpeed
Writeable
Walking speed. Unit: m/s, km/h, mi/h
Available on iOS 14+
HKQuantityTypeIdentifierWalkingStepLength
Writeable
Walking step length. Unit: m, cm, ft, in
Available on iOS 14+
HKQuantityTypeIdentifierWalkingAsymmetryPercentage
Writeable
Walking asymmetry percentage. Unit: %
Available on iOS 14+
HKQuantityTypeIdentifierWalkingDoubleSupportPercentage
Writeable
Walking double support percentage. Unit: %
Available on iOS 14+
HKQuantityTypeIdentifierStairAscentSpeed
Writeable
Stair ascent speed. Unit: m/s, ft/s
Available on iOS 14+
HKQuantityTypeIdentifierStairDescentSpeed
Writeable
Stair descent speed. Unit: m/s, ft/s
Available on iOS 14+
HKQuantityTypeIdentifierSixMinuteWalkTestDistance
Writeable
Distance walked in six-minute walk test. Unit: m, ft, mi, km
Available on iOS 14+
HKQuantityTypeIdentifierAppleWalkingSteadiness
Read-only
Apple Walking Steadiness score. Unit: %
Available on iOS 15+

Environmental

HKQuantityTypeIdentifierUVExposure
Writeable
UV exposure index. Unit: count
HKQuantityTypeIdentifierTimeInDaylight
Writeable
Time spent in daylight. Unit: min
Available on iOS 17+
HKQuantityTypeIdentifierEnvironmentalAudioExposure
Writeable
Environmental audio exposure. Unit: dBASPL
Available on iOS 13+
HKQuantityTypeIdentifierHeadphoneAudioExposure
Writeable
Headphone audio exposure. Unit: dBASPL
Available on iOS 13+
HKQuantityTypeIdentifierEnvironmentalSoundReduction
Writeable
Environmental sound reduction (e.g., from hearing protection). Unit: dBASPL
Available on iOS 16+

Other Health Metrics

HKQuantityTypeIdentifierNumberOfTimesFallen
Writeable
Number of falls detected. Unit: count
HKQuantityTypeIdentifierNumberOfAlcoholicBeverages
Writeable
Number of alcoholic beverages consumed. Unit: count
Available on iOS 15+
HKQuantityTypeIdentifierUnderwaterDepth
Writeable
Underwater depth. Unit: m, ft
Available on iOS 16+
HKQuantityTypeIdentifierAppleSleepingBreathingDisturbances
Writeable
Sleeping breathing disturbances. Unit: count
Available on iOS 18+

Read-only vs Writeable

Most quantity types are writeable, meaning third-party apps can save data to them using saveQuantitySample(). However, some types are read-only and can only be written by Apple’s own apps and devices:
  • HKQuantityTypeIdentifierAppleExerciseTime
  • HKQuantityTypeIdentifierAppleStandTime
  • HKQuantityTypeIdentifierWalkingHeartRateAverage
  • HKQuantityTypeIdentifierAppleWalkingSteadiness
  • HKQuantityTypeIdentifierAtrialFibrillationBurden
The TypeScript types distinguish between these with QuantityTypeIdentifierWriteable and QuantityTypeIdentifierReadOnly.

iOS Version Availability

Some quantity types are only available on newer iOS versions:
  • iOS 11+: Heart rate variability, insulin delivery, walking heart rate average
  • iOS 13+: Environmental and headphone audio exposure
  • iOS 14+: Mobility metrics, six-minute walk test
  • iOS 14.5+: Apple Move Time
  • iOS 15+: Walking steadiness, number of alcoholic beverages
  • iOS 16+: Running metrics, heart rate recovery, underwater depth, water temperature, environmental sound reduction
  • iOS 17+: Cycling metrics, time in daylight, physical effort, sleeping wrist temperature
  • iOS 18+: Additional distance sports, workout effort scores, sleeping breathing disturbances
Use isObjectTypeAvailable() to check if a specific quantity type is available on the current device before requesting authorization or querying data.

Build docs developers (and LLMs) love