Skip to content
AF
Health Connect reference

WeightRecord: Health Connect weight data

Read from Google’s documentation on 2026-10-03 · Google’s reference page last updated 2026-06-24

WeightRecord is Health Connect's weight record — an Instantaneous record in Google's Body Measurement category. Its read permission is android.permission.health.READ_WEIGHT; its write permission is android.permission.health.WRITE_WEIGHT. It supports 3 aggregate metrics (WEIGHT_AVG, WEIGHT_MAX and WEIGHT_MIN). Mandatory fields per Google's table: metadata, time and weight.

What Google says WeightRecord is

Captures the user's weight.

See Mass for supported units.

Quoted from Google’s WeightRecord Jetpack reference, last updated 2026-06-24, read 2026-10-03.

Class
androidx.health.connect.client.records.WeightRecord
Google's category
Body Measurement
Record type
Instantaneous
Unit class
none named in Google's table
Mandatory fields
metadatatimeweight
Added in (Jetpack)
1.1.0

Permissions

The exact strings Google’s data-types table declares for WeightRecord. Google’s page: “Before requesting any permissions, your app must declare them in the manifest.”

AccessPermission stringFramework reference
Readandroid.permission.health.READ_WEIGHTAPI 34 · U Ext 7
Writeandroid.permission.health.WRITE_WEIGHTAPI 34 · U Ext 7
AndroidManifest.xml
<uses-permission android:name="android.permission.health.READ_WEIGHT" />
<uses-permission android:name="android.permission.health.WRITE_WEIGHT" />
Kotlin — the same strings from the Jetpack helper
import androidx.health.connect.client.permission.HealthPermission
import androidx.health.connect.client.records.WeightRecord

val permissions = setOf(
    HealthPermission.getReadPermission(WeightRecord::class),
    HealthPermission.getWritePermission(WeightRecord::class),
)

The 4 fields of WeightRecord

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.

FieldTypeAllowed rangeGoogle’s description
metadatamandatoryMetadata—Set of common metadata associated with the written record.
timemandatoryInstant—Time the record happened.
weightmandatoryMassValid range: 0-1000 kilograms.User's weight in kilograms. Required field. Valid range: 0-1000 kilograms.
zoneOffsetZoneOffset?—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 WeightRecord. The value type is the T in Google’s AggregateMetric<T> signature. Every aggregate metric across all records.

MetricValue typeGoogle’s description
WeightRecord.WEIGHT_AVGMassMetric identifier to retrieve the average weight from androidx.health.connect.client.aggregate.AggregationResult.
WeightRecord.WEIGHT_MAXMassMetric identifier to retrieve the maximum weight from androidx.health.connect.client.aggregate.AggregationResult.
WeightRecord.WEIGHT_MINMassMetric identifier to retrieve the minimum weight 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 WeightRecord in Kotlin

The shape of Google’s own read example, with WeightRecord and its names filled in. Get the client with HealthConnectClient.getOrCreate(context) after checking getSdkStatus.

readRecords
import androidx.health.connect.client.HealthConnectClient
import androidx.health.connect.client.records.WeightRecord
import androidx.health.connect.client.request.ReadRecordsRequest
import androidx.health.connect.client.time.TimeRangeFilter
import java.time.Instant

suspend fun readWeight(
    client: HealthConnectClient,
    startTime: Instant,
    endTime: Instant,
): List<WeightRecord> {
    val response = client.readRecords(
        ReadRecordsRequest(
            WeightRecord::class,
            timeRangeFilter = TimeRangeFilter.between(startTime, endTime),
        )
    )
    // One page of up to pageSize records (default 1000); follow
    // response.pageToken for the rest.
    return response.records
}
aggregate
import androidx.health.connect.client.HealthConnectClient
import androidx.health.connect.client.records.WeightRecord
import androidx.health.connect.client.request.AggregateRequest
import androidx.health.connect.client.time.TimeRangeFilter
import java.time.Instant
import androidx.health.connect.client.units.Mass

suspend fun aggregateWeight(
    client: HealthConnectClient,
    startTime: Instant,
    endTime: Instant,
): Mass? {
    val response = client.aggregate(
        AggregateRequest(
            metrics = setOf(WeightRecord.WEIGHT_AVG),
            timeRangeFilter = TimeRangeFilter.between(startTime, endTime),
        )
    )
    // get() is declared as returning a nullable value.
    return response[WeightRecord.WEIGHT_AVG]
}

Setting up the client, the permission flow and Play Console declaration: integrating Health Connect step by step.

HealthKit counterpart

WeightRecord 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 WeightRecord 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 WeightRecord need?
Google's Health Connect data-types table (read 2026-10-03) declares android.permission.health.READ_WEIGHT for reading WeightRecord and android.permission.health.WRITE_WEIGHT for writing it, and says apps must declare permissions in the manifest before requesting them.
Which aggregate metrics does WeightRecord support?
Google's Jetpack reference defines 3 on WeightRecord: WEIGHT_AVG (AggregateMetric<Mass>), WEIGHT_MAX (AggregateMetric<Mass>) and WEIGHT_MIN (AggregateMetric<Mass>). Pass them in the metrics set of an AggregateRequest and read each back from the AggregationResult.
What values does WeightRecord.weight accept?
Google's reference types weight as Mass. Its description reads: "User's weight in kilograms. Required field. Valid range: 0-1000 kilograms."
Is WeightRecord an interval, instantaneous or series record?
Google's data-types table lists WeightRecord 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 metadata, time and weight.

Other Body Measurement records

All Body Measurement records →

Sources checked

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.

← All Health Connect records · Every permission string