<!--
{
  "availability" : [
    "iOS: 14.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "SensorKit",
  "identifier" : "/documentation/SensorKit",
  "metadataVersion" : "0.1.0",
  "role" : "Framework",
  "symbol" : {
    "kind" : "Framework",
    "modules" : [
      "SensorKit"
    ],
    "preciseIdentifier" : "SensorKit"
  },
  "title" : "SensorKit"
}
-->

# SensorKit

Retrieve data and derived metrics from sensors on an iPhone, or paired Apple Watch.

## Overview

As the system gathers information using various sensors on a device, SensorKit enables an app to access select raw data, or metrics that the system processes from a sensor, such as:

- Steps information
- Accelerometer or rotation-rate data
- The configuration of a watch on the user’s wrist
- Ambient light in the physical environment
- Details about a user’s routine commute or travel

See [`SRSensor`](/documentation/SensorKit/SRSensor) for the complete list.

> Note:
> This framework ignores calls from Mac apps that you build with Mac Catalyst, and from compatible iPad and iPhone apps running in visionOS.

## Topics

### Essentials

  <doc://com.apple.documentation/documentation/Updates/SensorKit>

### Setup

[Configuring your project for sensor reading](/documentation/SensorKit/configuring-your-project-for-sensor-reading)

Add metadata to your app to attain system and user permission to access sensor data.

[`SRSensorReader`](/documentation/SensorKit/SRSensorReader)

An object that establishes user authorization and records data for a particular sensor.

### Authorization

  <doc://com.apple.documentation/documentation/BundleResources/Entitlements/com.apple.developer.sensorkit.reader.allow>

### Querying data

[`SRFetchRequest`](/documentation/SensorKit/SRFetchRequest)

An object that defines the criteria for a sample query.

[`SRFetchResult`](/documentation/SensorKit/SRFetchResult)

Recorded data that a sensor reader fetches.

### Interpreting data

[`SRAmbientLightSample`](/documentation/SensorKit/SRAmbientLightSample)

The amount of ambient light in the user’s environment.

[`SRDeviceUsageReport`](/documentation/SensorKit/SRDeviceUsageReport)

The frequency and relative duration that the user uses their device, particular Apple apps, or websites.

[`SRKeyboardMetrics`](/documentation/SensorKit/SRKeyboardMetrics)

The configuration of a device’s keyboard and its usage patterns.

[`SRMediaEvent`](/documentation/SensorKit/SRMediaEvent)

A user interaction with a media object, such as an image or a video.

[`SRMessagesUsageReport`](/documentation/SensorKit/SRMessagesUsageReport)

An object that describes the user’s Messages app activity over a period of time.

[`SRPhoneUsageReport`](/documentation/SensorKit/SRPhoneUsageReport)

An object that describes the user’s phone activity over a period of time.

[`SRVisit`](/documentation/SensorKit/SRVisit)

The user’s progress in their daily travel routine.

[`SRWristDetection`](/documentation/SensorKit/SRWristDetection)

The configuration of a watch on the wearer’s wrist.

### Deleting samples

[`SRDeletionRecord`](/documentation/SensorKit/SRDeletionRecord)

An object that describes the reason the framework deletes samples.

### Analyzing speech

[`SRSpeechMetrics`](/documentation/SensorKit/SRSpeechMetrics)

An object that represents metrics about a range of speech.

[`SRSpeechExpression`](/documentation/SensorKit/SRSpeechExpression)

An object that represents the metrics and voice analytics for a range of speech.

### Analyzing faces

[`SRFaceMetrics`](/documentation/SensorKit/SRFaceMetrics)

An object that represents metrics about the user’s face.

[`SR_ARKIT_SUPPORTED`](/documentation/SensorKit/SR_ARKIT_SUPPORTED)

A flag that indicates whether the ARKit framework is available in the SDK for the SensorKit framework.

### Recording wrist temperatures

[`SRWristTemperatureSession`](/documentation/SensorKit/SRWristTemperatureSession)

An object that represents wrist temperatures that a device records during a period of time.

[`SRWristTemperature`](/documentation/SensorKit/SRWristTemperature)

The temperature of the user’s wrist while the user sleeps.

### Recording ectrocardiogram data

[`SRElectrocardiogramSample`](/documentation/SensorKit/SRElectrocardiogramSample)

The sample electrocardiogram sensor data.

### Recording photoplethysmogram data

[`SRPhotoplethysmogramSample`](/documentation/SensorKit/SRPhotoplethysmogramSample)

The sample photoplethysmogram (PPG) sensor data.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)