Skip to content
AF
Health Connect reference

TotalCaloriesBurnedRecord: Health Connect total calories burned data

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

TotalCaloriesBurnedRecord is Health Connect's total calories burned record — an Interval record in Google's Activity category. Its read permission is android.permission.health.READ_TOTAL_CALORIES_BURNED; its write permission is android.permission.health.WRITE_TOTAL_CALORIES_BURNED. It supports 1 aggregate metric (ENERGY_TOTAL). Mandatory fields per Google's table: endTime, energy, metadata and startTime.

What Google says TotalCaloriesBurnedRecord is

Total energy burned by the user (in kilocalories), including active & basal energy burned (BMR). Each record represents the total kilocalories burned over a time interval.

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

Class
androidx.health.connect.client.records.TotalCaloriesBurnedRecord
Google's category
Activity
Record type
Interval
Unit class
androidx.health.connect.client.units.Energy
Mandatory fields
endTimeenergymetadatastartTime
Added in (Jetpack)
1.1.0

Permissions

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

AccessPermission stringFramework reference
Readandroid.permission.health.READ_TOTAL_CALORIES_BURNEDAPI 34 · U Ext 7
Writeandroid.permission.health.WRITE_TOTAL_CALORIES_BURNEDAPI 34 · U Ext 7
AndroidManifest.xml
<uses-permission android:name="android.permission.health.READ_TOTAL_CALORIES_BURNED" />
<uses-permission android:name="android.permission.health.WRITE_TOTAL_CALORIES_BURNED" />
Kotlin — the same strings from the Jetpack helper
import androidx.health.connect.client.permission.HealthPermission
import androidx.health.connect.client.records.TotalCaloriesBurnedRecord

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

The 6 fields of TotalCaloriesBurnedRecord

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
endTimemandatoryInstant—End time of the record.
endZoneOffsetZoneOffset?—User experienced zone offset at endTime, 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.
energymandatoryEnergyValid range: 0-1000000 kcal.Energy in Energy unit. Required field. Valid range: 0-1000000 kcal.
metadatamandatoryMetadata—Set of common metadata associated with the written record.
startTimemandatoryInstant—Start time of the record.
startZoneOffsetZoneOffset?—User experienced zone offset at startTime, 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 TotalCaloriesBurnedRecord. The value type is the T in Google’s AggregateMetric<T> signature. Every aggregate metric across all records.

MetricValue typeGoogle’s description
TotalCaloriesBurnedRecord.ENERGY_TOTALEnergyMetric identifier to retrieve total energy 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 TotalCaloriesBurnedRecord in Kotlin

The shape of Google’s own read example, with TotalCaloriesBurnedRecord 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.TotalCaloriesBurnedRecord
import androidx.health.connect.client.request.ReadRecordsRequest
import androidx.health.connect.client.time.TimeRangeFilter
import java.time.Instant

suspend fun readTotalCaloriesBurned(
    client: HealthConnectClient,
    startTime: Instant,
    endTime: Instant,
): List<TotalCaloriesBurnedRecord> {
    val response = client.readRecords(
        ReadRecordsRequest(
            TotalCaloriesBurnedRecord::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.TotalCaloriesBurnedRecord
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 aggregateTotalCaloriesBurned(
    client: HealthConnectClient,
    startTime: Instant,
    endTime: Instant,
): Energy? {
    val response = client.aggregate(
        AggregateRequest(
            metrics = setOf(TotalCaloriesBurnedRecord.ENERGY_TOTAL),
            timeRangeFilter = TimeRangeFilter.between(startTime, endTime),
        )
    )
    // get() is declared as returning a nullable value.
    return response[TotalCaloriesBurnedRecord.ENERGY_TOTAL]
}

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

HealthKit counterpart

TotalCaloriesBurnedRecord sits in the verified cross-platform matrix’s Calories row, which groups HKQuantityTypeIdentifier.activeEnergyBurned, .basalEnergyBurned on Apple with ActiveCaloriesBurnedRecord, TotalCaloriesBurnedRecord 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: activeEnergyBurned, basalEnergyBurned.

Watch out: Modelled estimates, not measurements. Note the asymmetry: Apple splits active/basal, Android offers active and total — don't add active to total.

The metric on other platforms

This guide lists TotalCaloriesBurnedRecord 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 TotalCaloriesBurnedRecord need?
Google's Health Connect data-types table (read 2026-10-03) declares android.permission.health.READ_TOTAL_CALORIES_BURNED for reading TotalCaloriesBurnedRecord and android.permission.health.WRITE_TOTAL_CALORIES_BURNED for writing it, and says apps must declare permissions in the manifest before requesting them.
Which aggregate metrics does TotalCaloriesBurnedRecord support?
Google's Jetpack reference defines 1 on TotalCaloriesBurnedRecord: ENERGY_TOTAL (AggregateMetric<Energy>). Pass it in the metrics set of an AggregateRequest and read it back from the AggregationResult.
What values does TotalCaloriesBurnedRecord.energy accept?
Google's reference types energy as Energy. Its description reads: "Energy in Energy unit. Required field. Valid range: 0-1000000 kcal."
Is TotalCaloriesBurnedRecord an interval, instantaneous or series record?
Google's data-types table lists TotalCaloriesBurnedRecord as Interval, and defines that column as indicating "whether the data is recorded at an instant in time or over an interval". Its mandatory fields are endTime, energy, metadata and startTime.

Other Activity records

All Activity 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