StepsRecord: Health Connect steps data

What Google says StepsRecord is

Captures the number of steps taken since the last reading. Each step is only reported once so records shouldn't have overlapping time. The start time of each record should represent the start of the interval in which steps were taken.

The start time must be equal to or greater than the end time of the previous record. Adding all of the values together for a period of time calculates the total number of steps during that period.

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

Class

androidx.health.connect.client.records.StepsRecord

Google's category

Activity

Record type

Interval

Unit class

none named in Google's table

Mandatory fields

countendTimemetadatastartTime

Added in (Jetpack)

1.1.0

Same table row as

StepsCadenceRecord

Permissions

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

• READ_STEPS and WRITE_STEPS are also declared for StepsCadenceRecord in Google’s table.

<uses-permission android:name="android.permission.health.READ_STEPS" />
<uses-permission android:name="android.permission.health.WRITE_STEPS" />

import androidx.health.connect.client.permission.HealthPermission
import androidx.health.connect.client.records.StepsRecord

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

The 6 fields of StepsRecord

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.

Aggregate metrics

The AggregateMetric constants Google defines on StepsRecord. The value type is the T in Google’s AggregateMetric<T> signature. Every aggregate metric across all records.

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 StepsRecord in Kotlin

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

suspend fun readSteps(
    client: HealthConnectClient,
    startTime: Instant,
    endTime: Instant,
): List<StepsRecord> {
    val response = client.readRecords(
        ReadRecordsRequest(
            StepsRecord::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.StepsRecord
import androidx.health.connect.client.request.AggregateRequest
import androidx.health.connect.client.time.TimeRangeFilter
import java.time.Instant

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

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

HealthKit counterpart

The metric on other platforms

This guide lists StepsRecord 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.

• Step Counting API: How to Get Step Data

Questions

What permission does StepsRecord need?

Google's Health Connect data-types table (read 2026-10-03) declares android.permission.health.READ_STEPS for reading StepsRecord and android.permission.health.WRITE_STEPS for writing it, and says apps must declare permissions in the manifest before requesting them. READ_STEPS and WRITE_STEPS are also declared for StepsCadenceRecord.

Which aggregate metrics does StepsRecord support?

Google's Jetpack reference defines 1 on StepsRecord: COUNT_TOTAL (AggregateMetric<Long>). Pass it in the metrics set of an AggregateRequest and read it back from the AggregationResult.

What values does StepsRecord.count accept?

Google's reference types count as Long, annotated @IntRange(from = 1, to = 1000000). Its description reads: "Count. Required field. Valid range: 1-1000000."

Is StepsRecord an interval, instantaneous or series record?

Google's data-types table lists StepsRecord 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 count, endTime, metadata and startTime.