Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/kingstinct/react-native-healthkit/llms.txt

Use this file to discover all available pages before exploring further.

React Native bindings for HealthKit with full TypeScript and Promise support covering about any kind of data. Keeping TypeScript mappings as close as possible to HealthKit - both in regards to naming and serialization.
This library is iOS-only and requires a physical device or simulator running iOS. HealthKit is not available on Android. For Android alternatives, see react-native-health-connect.

Key features

Full TypeScript support

Type-safe mappings to HealthKit APIs with complete IDE autocomplete

100+ quantity types

Steps, energy burnt, blood glucose, heart rate, and more

React Hooks

Declarative data fetching and subscriptions with hooks

HealthKit anchor queries

Efficient data synchronization with change tracking

Background delivery

Real-time change notifications and background updates

Workouts & correlations

Support for 75+ workout types, electrocardiograms, and clinical data

Supported data types

Data TypesQuerySaveSubscribeExamples
100+ Quantity TypesSteps, energy burnt, blood glucose etc..
63 Category TypesSleep analysis, mindful sessions etc..
75+ Workout Activity TypesSwimming, running, table tennis etc..
Correlation TypesFood and blood pressure
Document TypesCDA documents exposed as Base64 data
Clinical Records⚠️⚠️Lab results in FHIR JSON format

Quick navigation

Installation

Get started with Expo or bare React Native setup

Quickstart

Build your first HealthKit integration in minutes

Authorization

Learn how to request and manage HealthKit permissions

Data Types

Explore quantity types, category types, and more

Performance

Built on react-native-nitro-modules for optimal performance with direct Swift-to-JavaScript bindings.

Disclaimer

This library is provided as-is without any warranty and is not affiliated with Apple in any way. The data might be incomplete or inaccurate.

Build docs developers (and LLMs) love