BasalMetabolicRateRecord: Health Connect basal metabolic rate data
Read from Google’s documentation on 2026-10-03 · Google’s reference page last updated 2026-06-24
BasalMetabolicRateRecord is Health Connect's basal metabolic rate record — an Instantaneous record in Google's Body Measurement category. Its read permission is android.permission.health.READ_BASAL_METABOLIC_RATE; its write permission is android.permission.health.WRITE_BASAL_METABOLIC_RATE. It supports 1 aggregate metric (BASAL_CALORIES_TOTAL). Mandatory fields per Google's table: basalMetabolicRate, metadata and time.
What Google says BasalMetabolicRateRecord is
Captures the BMR of a user. Each record represents the energy a user would burn if at rest all day, based on their height and weight.
Quoted from Google’s BasalMetabolicRateRecord Jetpack reference, last updated 2026-06-24, read 2026-10-03.
- Class
androidx.health.connect.client.records.BasalMetabolicRateRecord- Google's category
- Body Measurement
- Record type
- Instantaneous
- Unit class
androidx.health.connect.client.units.Power- Mandatory fields
basalMetabolicRatemetadatatime- Added in (Jetpack)
1.1.0
Permissions
The exact strings Google’s data-types table declares for BasalMetabolicRateRecord. Google’s page: “Before requesting any permissions, your app must declare them in the manifest.”
| Access | Permission string | Framework reference |
|---|---|---|
| Read | android.permission.health.READ_BASAL_METABOLIC_RATE | API 34 · U Ext 7 |
| Write | android.permission.health.WRITE_BASAL_METABOLIC_RATE | API 34 · U Ext 7 |
<uses-permission android:name="android.permission.health.READ_BASAL_METABOLIC_RATE" />
<uses-permission android:name="android.permission.health.WRITE_BASAL_METABOLIC_RATE" />import androidx.health.connect.client.permission.HealthPermission
import androidx.health.connect.client.records.BasalMetabolicRateRecord
val permissions = setOf(
HealthPermission.getReadPermission(BasalMetabolicRateRecord::class),
HealthPermission.getWritePermission(BasalMetabolicRateRecord::class),
)The 4 fields of BasalMetabolicRateRecord
Types and descriptions as Google’s reference prints them. The range column quotes Google’s own range annotation or sentence; a dash means Google states none, which is not the same as no validation.
| Field | Type | Allowed range | Google’s description |
|---|---|---|---|
basalMetabolicRatemandatory | Power | Valid range: 0-10000 kcal/day. | Basal metabolic rate, in Power unit. Required field. Valid range: 0-10000 kcal/day. |
metadatamandatory | Metadata | — | Set of common metadata associated with the written record. |
timemandatory | Instant | — | Time the record happened. |
zoneOffset | ZoneOffset? | — | User experienced zone offset at time, or null if unknown. Providing these will help history aggregations results stay consistent should user travel. Queries with user experienced time filters will assume system current zone offset if the information is absent. |
Aggregate metrics
The AggregateMetric constants Google defines on BasalMetabolicRateRecord. The value type is the T in Google’s AggregateMetric<T> signature. Every aggregate metric across all records.
| Metric | Value type | Google’s description |
|---|---|---|
| BasalMetabolicRateRecord.BASAL_CALORIES_TOTAL | Energy | Metric identifier to retrieve the total basal calories burned from androidx.health.connect.client.aggregate.AggregationResult. |
Google’s read-data guide: “For cumulative types like StepsRecord, use aggregate() instead of readRecords() to avoid double counting from multiple sources and improve accuracy.” and “The aggregation API also contains logic to handle duplicate records, and lessens the chances of rate limiting.”
Read BasalMetabolicRateRecord in Kotlin
The shape of Google’s own read example, with BasalMetabolicRateRecord and its names filled in. Get the client with HealthConnectClient.getOrCreate(context) after checking getSdkStatus.
import androidx.health.connect.client.HealthConnectClient
import androidx.health.connect.client.records.BasalMetabolicRateRecord
import androidx.health.connect.client.request.ReadRecordsRequest
import androidx.health.connect.client.time.TimeRangeFilter
import java.time.Instant
suspend fun readBasalMetabolicRate(
client: HealthConnectClient,
startTime: Instant,
endTime: Instant,
): List<BasalMetabolicRateRecord> {
val response = client.readRecords(
ReadRecordsRequest(
BasalMetabolicRateRecord::class,
timeRangeFilter = TimeRangeFilter.between(startTime, endTime),
)
)
// One page of up to pageSize records (default 1000); follow
// response.pageToken for the rest.
return response.records
}import androidx.health.connect.client.HealthConnectClient
import androidx.health.connect.client.records.BasalMetabolicRateRecord
import androidx.health.connect.client.request.AggregateRequest
import androidx.health.connect.client.time.TimeRangeFilter
import java.time.Instant
import androidx.health.connect.client.units.Energy
suspend fun aggregateBasalMetabolicRate(
client: HealthConnectClient,
startTime: Instant,
endTime: Instant,
): Energy? {
val response = client.aggregate(
AggregateRequest(
metrics = setOf(BasalMetabolicRateRecord.BASAL_CALORIES_TOTAL),
timeRangeFilter = TimeRangeFilter.between(startTime, endTime),
)
)
// get() is declared as returning a nullable value.
return response[BasalMetabolicRateRecord.BASAL_CALORIES_TOTAL]
}Setting up the client, the permission flow and Play Console declaration: integrating Health Connect step by step.
HealthKit counterpart
BasalMetabolicRateRecord sits in the verified cross-platform matrix’s Body composition row, which groups HKQuantityTypeIdentifier.bodyMass, .bodyFatPercentage, .leanBodyMass, .bodyMassIndex on Apple with WeightRecord, BodyFatRecord, LeanBodyMassRecord, BoneMassRecord, BodyWaterMassRecord, BasalMetabolicRateRecord on Android. The row groups the metric; it does not pair each Android record with one Apple type.
The Apple types in that row on the HealthKit reference: bodyMass, bodyFatPercentage, leanBodyMass, bodyMassIndex.
Watch out: The store holds it, but something has to write it — usually a smart scale or manual entry. Body fat is a bioimpedance estimate.
The metric on other platforms
This guide lists BasalMetabolicRateRecord beside the types on the other platforms this site covers whose own descriptions name the same metric, each quoted, with how each one is read.
Questions
- What permission does BasalMetabolicRateRecord need?
- Google's Health Connect data-types table (read 2026-10-03) declares android.permission.health.READ_BASAL_METABOLIC_RATE for reading BasalMetabolicRateRecord and android.permission.health.WRITE_BASAL_METABOLIC_RATE for writing it, and says apps must declare permissions in the manifest before requesting them.
- Which aggregate metrics does BasalMetabolicRateRecord support?
- Google's Jetpack reference defines 1 on BasalMetabolicRateRecord: BASAL_CALORIES_TOTAL (AggregateMetric<Energy>). Pass it in the metrics set of an AggregateRequest and read it back from the AggregationResult.
- What values does BasalMetabolicRateRecord.basalMetabolicRate accept?
- Google's reference types basalMetabolicRate as Power. Its description reads: "Basal metabolic rate, in Power unit. Required field. Valid range: 0-10000 kcal/day."
- Is BasalMetabolicRateRecord an interval, instantaneous or series record?
- Google's data-types table lists BasalMetabolicRateRecord as Instantaneous, and defines that column as indicating "whether the data is recorded at an instant in time or over an interval". Its mandatory fields are basalMetabolicRate, metadata and time.
Other Body Measurement records
Sources checked
- Google — BasalMetabolicRateRecord (Jetpack reference) — last updated 2026-06-24 · read 2026-10-03
- Google — Health Connect data types · read 2026-10-03
- Google — HealthPermissions (framework reference) · read 2026-10-03
- Google — Read raw data (Health Connect guide) · read 2026-10-03
Google’s descriptions are quoted for identification; the page layout, the capsule and the cross-platform pairing are AIFitnessAPI’s. Generated from Google’s pages by a script, not typed by hand — the same data is behind every page in the Health Connect reference.