Sign InGet Started

Wearables

Apple Health Kit API

With the Apple Health Kit API you can connect to your health kit account and retrieve health data from your Apple Devices. Vital makes it easy to integrate with Apple health kit and retrieve health data.

Step 1

First steps to integrate with Apple HealthKit

Create a Vital account

The first step is to create an account with Vital. Once created head to the settings section, and click create API key to start.

Get API Key

Generate a Link Token

Use your API key to generate a link token. This token will be used to allow your users to connect their Apple HealthKit account.

Link Token Docs

Register Webhook URL

Once connected, register a webhook URL to start receive updates when new Apple HealthKit data is available. Data is harmonized and sent via JSON.

Read more on webhooks

Step 2

What data does Apple HealthKit provide?

All data from Apple HealthKit is provided in JSON format. Vital consists of three main schema types that it uses to push data to your webhook url. These schema types can be found here. You can filter these events to receive specific resource types, via webhook. The full list of available resources for Apple HealthKit can be found below.

  • activity

  • blood_oxygen

  • blood_pressure

  • body

  • caffeine

  • calories_active

  • calories_basal

  • distance

  • fat

  • floors_climbed

  • glucose

  • heartrate

  • hrv

  • hypnogram

  • mindfulness_minutes

  • profile

  • respiratory_rate

  • sleep

  • sleep_stream

  • steps

  • vo2_max

  • water

  • weight

  • workouts


Apple HealthKit Webhook Payloads

daily.data.activity.created

daily.data.blood_oxygen.created

daily.data.blood_pressure.created

daily.data.body.created

daily.data.caffeine.created

daily.data.calories_active.created

daily.data.calories_basal.created

daily.data.distance.created

daily.data.fat.created

daily.data.floors_climbed.created

daily.data.glucose.created

daily.data.heartrate.created

daily.data.hrv.created

daily.data.hypnogram.created

daily.data.mindfulness_minutes.created

daily.data.profile.created

daily.data.respiratory_rate.created

daily.data.sleep.created

daily.data.steps.created

daily.data.vo2_max.created

daily.data.water.created

daily.data.weight.created

daily.data.workouts.created

historical.data.activity.created

historical.data.blood_oxygen.created

historical.data.blood_pressure.created

historical.data.body.created

historical.data.caffeine.created

historical.data.calories_active.created

historical.data.calories_basal.created

historical.data.distance.created

historical.data.fat.created

historical.data.floors_climbed.created

historical.data.glucose.created

historical.data.heartrate.created

historical.data.hrv.created

historical.data.hypnogram.created

historical.data.mindfulness_minutes.created

historical.data.profile.created

historical.data.respiratory_rate.created

historical.data.sleep.created

historical.data.steps.created

historical.data.vo2_max.created

historical.data.water.created

historical.data.weight.created

historical.data.workouts.created

Step 3

Receiving Data via Webhooks

Apple HealthKit data is updated in real-time. Once a user connects their account, you will receive a webhook event with the data. You can also query the data via our API. New data in most cases for Apple HealthKit is provided in real-time. Vital guarantees all new data to be available within 15 mins of the data being recorded. A refresh for new Apple HealthKit data can also be requested via our refresh API.

View all Event Payloads
connection

Step 4

integrating-Apple HealthKit

Historical Harmonized Data

Apple HealthKit data is always standardized and harmonized using Vital's standardized schemas. This means you can query historical data for any user via HTTP requests and receive historical data prior to connecting devices using Vital. Full list of historical data and how much data is retrieved for Apple HealthKit can be found below.

Start fetching health data from wearables and lab tests.

SOC 2 Type I

hipaa-icon

HIPAA Certified

GDPR Ready

Product

WearablesLab TestsPricingDocsSupported DevicesBook a testADX instructions