Integrating with Spike API
API Reference: User Management
API Reference: Querying Data
API Reference: Nutrition AI
API Reference: Lab Reports
Release Notes
List Provider Records
Copy
curl --request GET \
--url https://app-api.spikeapi.com/v3/queries/provider_records \
--header 'Authorization: Bearer <token>'Copy
{
"records": [
{
"modified_at": "2023-11-07T05:31:56Z",
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_at_timestamp": "2023-11-07T05:31:56Z",
"activity_id": "<string>",
"activity_tags": [
"on_foot"
],
"activity_type": "other",
"duration": 123,
"end_at_timestamp": "2023-11-07T05:31:56Z",
"input_method": "unknown",
"is_source_aggregated": true,
"metrics": {
"air_temperature": 123,
"air_temperature_max": 123,
"air_temperature_min": 123,
"ascent": 123,
"basal_body_temperature": 123,
"basal_body_temperature_max": 123,
"basal_body_temperature_min": 123,
"bedtime_duration": 123,
"blood_pressure_diastolic": 123,
"blood_pressure_diastolic_max": 123,
"blood_pressure_diastolic_min": 123,
"blood_pressure_systolic": 123,
"blood_pressure_systolic_max": 123,
"blood_pressure_systolic_min": 123,
"body_bone_mass": 123,
"body_fat": 123,
"body_fat_max": 123,
"body_fat_min": 123,
"body_mass_index": 123,
"body_temperature": 123,
"body_temperature_max": 123,
"body_temperature_min": 123,
"breathing_rate": 123,
"breathing_rate_max": 123,
"breathing_rate_min": 123,
"cadence": 123,
"cadence_max": 123,
"cadence_min": 123,
"calories_burned": 123,
"calories_burned_active": 123,
"calories_burned_basal": 123,
"calories_intake": 123,
"descent": 123,
"distance": 123,
"distance_cycling": 123,
"distance_running": 123,
"distance_swimming": 123,
"distance_walking": 123,
"distance_wheelchair": 123,
"duration_active": 123,
"ecg_rri": 123,
"ecg_voltage": 123,
"elevation": 123,
"elevation_gain": 123,
"elevation_loss": 123,
"elevation_max": 123,
"elevation_min": 123,
"floors_climbed": 123,
"glucose": 123,
"heartrate": 123,
"heartrate_max": 123,
"heartrate_min": 123,
"heartrate_resting": 123,
"heartrate_resting_max": 123,
"heartrate_resting_min": 123,
"heartrate_zone0_duration": 123,
"heartrate_zone1_duration": 123,
"heartrate_zone2_duration": 123,
"heartrate_zone3_duration": 123,
"heartrate_zone4_duration": 123,
"heartrate_zone5_duration": 123,
"height": 123,
"hrv_rmssd": 123,
"hrv_sdnn": 123,
"latitude": 123,
"longitude": 123,
"pace": 123,
"skin_temperature": 123,
"skin_temperature_max": 123,
"skin_temperature_min": 123,
"sleep_breathing_rate": 123,
"sleep_breathing_rate_max": 123,
"sleep_breathing_rate_min": 123,
"sleep_duration": 123,
"sleep_duration_awake": 123,
"sleep_duration_deep": 123,
"sleep_duration_light": 123,
"sleep_duration_nap": 123,
"sleep_duration_rem": 123,
"sleep_efficiency": 123,
"sleep_interruptions": 123,
"sleep_latency": 123,
"sleep_score": 123,
"sleep_skin_temperature_deviation": 123,
"speed": 123,
"speed_max": 123,
"speed_min": 123,
"spo2": 123,
"spo2_max": 123,
"spo2_min": 123,
"steps": 123,
"swimming_distance_per_stroke": 123,
"swimming_lengths": 123,
"vo2max": 123,
"wakeup_latency": 123,
"weight": 123
},
"provider_local_date": "2023-12-25",
"provider_slug": "<string>",
"provider_source": "apple_healthkit_sample",
"provider_source_type": "provider_summary",
"provider_specific_metrics": {
"garmin": {
"overall_sleep_score_qualifier_key": "<string>",
"overall_sleep_score_value": 123,
"time_offset_stress_level_values": "<string>"
},
"huawei": {
"sleep_score": 123
},
"oura": {
"sleep_score": 123
},
"polar": {
"sleep_score": 123
},
"suunto": {
"sleep_quality_score": 123
},
"whoop": {
"sleep_consistency_percentage": 123,
"sleep_performance_percentage": 123
},
"withings": {
"sleep_score": 123
}
},
"samples": {
"durations": [
123
],
"offsets": [
123
],
"values": {
"air_temperature": [
123
],
"air_temperature_max": [
123
],
"air_temperature_min": [
123
],
"ascent": [
123
],
"basal_body_temperature": [
123
],
"basal_body_temperature_max": [
123
],
"basal_body_temperature_min": [
123
],
"bedtime_duration": [
123
],
"blood_pressure_diastolic": [
123
],
"blood_pressure_diastolic_max": [
123
],
"blood_pressure_diastolic_min": [
123
],
"blood_pressure_systolic": [
123
],
"blood_pressure_systolic_max": [
123
],
"blood_pressure_systolic_min": [
123
],
"body_bone_mass": [
123
],
"body_fat": [
123
],
"body_fat_max": [
123
],
"body_fat_min": [
123
],
"body_mass_index": [
123
],
"body_temperature": [
123
],
"body_temperature_max": [
123
],
"body_temperature_min": [
123
],
"breathing_rate": [
123
],
"breathing_rate_max": [
123
],
"breathing_rate_min": [
123
],
"cadence": [
123
],
"cadence_max": [
123
],
"cadence_min": [
123
],
"calories_burned": [
123
],
"calories_burned_active": [
123
],
"calories_burned_basal": [
123
],
"calories_intake": [
123
],
"descent": [
123
],
"distance": [
123
],
"distance_cycling": [
123
],
"distance_running": [
123
],
"distance_swimming": [
123
],
"distance_walking": [
123
],
"distance_wheelchair": [
123
],
"duration_active": [
123
],
"ecg_rri": [
123
],
"ecg_voltage": [
123
],
"elevation": [
123
],
"elevation_gain": [
123
],
"elevation_loss": [
123
],
"elevation_max": [
123
],
"elevation_min": [
123
],
"floors_climbed": [
123
],
"glucose": [
123
],
"heartrate": [
123
],
"heartrate_max": [
123
],
"heartrate_min": [
123
],
"heartrate_resting": [
123
],
"heartrate_resting_max": [
123
],
"heartrate_resting_min": [
123
],
"heartrate_zone0_duration": [
123
],
"heartrate_zone1_duration": [
123
],
"heartrate_zone2_duration": [
123
],
"heartrate_zone3_duration": [
123
],
"heartrate_zone4_duration": [
123
],
"heartrate_zone5_duration": [
123
],
"height": [
123
],
"hrv_rmssd": [
123
],
"hrv_sdnn": [
123
],
"latitude": [
123
],
"longitude": [
123
],
"pace": [
123
],
"skin_temperature": [
123
],
"skin_temperature_max": [
123
],
"skin_temperature_min": [
123
],
"sleep_breathing_rate": [
123
],
"sleep_breathing_rate_max": [
123
],
"sleep_breathing_rate_min": [
123
],
"sleep_duration": [
123
],
"sleep_duration_awake": [
123
],
"sleep_duration_deep": [
123
],
"sleep_duration_light": [
123
],
"sleep_duration_nap": [
123
],
"sleep_duration_rem": [
123
],
"sleep_efficiency": [
123
],
"sleep_interruptions": [
123
],
"sleep_latency": [
123
],
"sleep_score": [
123
],
"sleep_skin_temperature_deviation": [
123
],
"speed": [
123
],
"speed_max": [
123
],
"speed_min": [
123
],
"spo2": [
123
],
"spo2_max": [
123
],
"spo2_min": [
123
],
"steps": [
123
],
"swimming_distance_per_stroke": [
123
],
"swimming_lengths": [
123
],
"vo2max": [
123
],
"wakeup_latency": [
123
],
"weight": [
123
]
}
},
"source": {
"device_manufacturer": "<string>",
"device_model": "<string>",
"device_product": "<string>",
"device_version": "<string>",
"source_bundle_identifier": "<string>",
"source_os_version": "<string>",
"source_product": "<string>",
"source_version": "<string>"
},
"user_time_offset_minutes": 123
}
],
"from_timestamp": "2023-11-07T05:31:56Z",
"to_timestamp": "2023-11-07T05:31:56Z"
}List Provider Records
This endpoint allows you to query provider records with metrics, optionally filtering by providers. It supports filtering by UTC timestamp range and providers, and includes provider-specific metrics in the response.
The response includes records with raw data from providers transformed into the unified data model, each possibly including:
- base information (start, end, duration, user time offset, input method, source provider, etc.)
- metrics (base and provider-specific)
- activity information such as activity ID, type, and tags
- activity breakdown into laps, sessions, etc.
- sleeps with sample data
All timestamps in both request and response are in the UTC timezone.
List Provider Records
Copy
curl --request GET \
--url https://app-api.spikeapi.com/v3/queries/provider_records \
--header 'Authorization: Bearer <token>'Copy
{
"records": [
{
"modified_at": "2023-11-07T05:31:56Z",
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_at_timestamp": "2023-11-07T05:31:56Z",
"activity_id": "<string>",
"activity_tags": [
"on_foot"
],
"activity_type": "other",
"duration": 123,
"end_at_timestamp": "2023-11-07T05:31:56Z",
"input_method": "unknown",
"is_source_aggregated": true,
"metrics": {
"air_temperature": 123,
"air_temperature_max": 123,
"air_temperature_min": 123,
"ascent": 123,
"basal_body_temperature": 123,
"basal_body_temperature_max": 123,
"basal_body_temperature_min": 123,
"bedtime_duration": 123,
"blood_pressure_diastolic": 123,
"blood_pressure_diastolic_max": 123,
"blood_pressure_diastolic_min": 123,
"blood_pressure_systolic": 123,
"blood_pressure_systolic_max": 123,
"blood_pressure_systolic_min": 123,
"body_bone_mass": 123,
"body_fat": 123,
"body_fat_max": 123,
"body_fat_min": 123,
"body_mass_index": 123,
"body_temperature": 123,
"body_temperature_max": 123,
"body_temperature_min": 123,
"breathing_rate": 123,
"breathing_rate_max": 123,
"breathing_rate_min": 123,
"cadence": 123,
"cadence_max": 123,
"cadence_min": 123,
"calories_burned": 123,
"calories_burned_active": 123,
"calories_burned_basal": 123,
"calories_intake": 123,
"descent": 123,
"distance": 123,
"distance_cycling": 123,
"distance_running": 123,
"distance_swimming": 123,
"distance_walking": 123,
"distance_wheelchair": 123,
"duration_active": 123,
"ecg_rri": 123,
"ecg_voltage": 123,
"elevation": 123,
"elevation_gain": 123,
"elevation_loss": 123,
"elevation_max": 123,
"elevation_min": 123,
"floors_climbed": 123,
"glucose": 123,
"heartrate": 123,
"heartrate_max": 123,
"heartrate_min": 123,
"heartrate_resting": 123,
"heartrate_resting_max": 123,
"heartrate_resting_min": 123,
"heartrate_zone0_duration": 123,
"heartrate_zone1_duration": 123,
"heartrate_zone2_duration": 123,
"heartrate_zone3_duration": 123,
"heartrate_zone4_duration": 123,
"heartrate_zone5_duration": 123,
"height": 123,
"hrv_rmssd": 123,
"hrv_sdnn": 123,
"latitude": 123,
"longitude": 123,
"pace": 123,
"skin_temperature": 123,
"skin_temperature_max": 123,
"skin_temperature_min": 123,
"sleep_breathing_rate": 123,
"sleep_breathing_rate_max": 123,
"sleep_breathing_rate_min": 123,
"sleep_duration": 123,
"sleep_duration_awake": 123,
"sleep_duration_deep": 123,
"sleep_duration_light": 123,
"sleep_duration_nap": 123,
"sleep_duration_rem": 123,
"sleep_efficiency": 123,
"sleep_interruptions": 123,
"sleep_latency": 123,
"sleep_score": 123,
"sleep_skin_temperature_deviation": 123,
"speed": 123,
"speed_max": 123,
"speed_min": 123,
"spo2": 123,
"spo2_max": 123,
"spo2_min": 123,
"steps": 123,
"swimming_distance_per_stroke": 123,
"swimming_lengths": 123,
"vo2max": 123,
"wakeup_latency": 123,
"weight": 123
},
"provider_local_date": "2023-12-25",
"provider_slug": "<string>",
"provider_source": "apple_healthkit_sample",
"provider_source_type": "provider_summary",
"provider_specific_metrics": {
"garmin": {
"overall_sleep_score_qualifier_key": "<string>",
"overall_sleep_score_value": 123,
"time_offset_stress_level_values": "<string>"
},
"huawei": {
"sleep_score": 123
},
"oura": {
"sleep_score": 123
},
"polar": {
"sleep_score": 123
},
"suunto": {
"sleep_quality_score": 123
},
"whoop": {
"sleep_consistency_percentage": 123,
"sleep_performance_percentage": 123
},
"withings": {
"sleep_score": 123
}
},
"samples": {
"durations": [
123
],
"offsets": [
123
],
"values": {
"air_temperature": [
123
],
"air_temperature_max": [
123
],
"air_temperature_min": [
123
],
"ascent": [
123
],
"basal_body_temperature": [
123
],
"basal_body_temperature_max": [
123
],
"basal_body_temperature_min": [
123
],
"bedtime_duration": [
123
],
"blood_pressure_diastolic": [
123
],
"blood_pressure_diastolic_max": [
123
],
"blood_pressure_diastolic_min": [
123
],
"blood_pressure_systolic": [
123
],
"blood_pressure_systolic_max": [
123
],
"blood_pressure_systolic_min": [
123
],
"body_bone_mass": [
123
],
"body_fat": [
123
],
"body_fat_max": [
123
],
"body_fat_min": [
123
],
"body_mass_index": [
123
],
"body_temperature": [
123
],
"body_temperature_max": [
123
],
"body_temperature_min": [
123
],
"breathing_rate": [
123
],
"breathing_rate_max": [
123
],
"breathing_rate_min": [
123
],
"cadence": [
123
],
"cadence_max": [
123
],
"cadence_min": [
123
],
"calories_burned": [
123
],
"calories_burned_active": [
123
],
"calories_burned_basal": [
123
],
"calories_intake": [
123
],
"descent": [
123
],
"distance": [
123
],
"distance_cycling": [
123
],
"distance_running": [
123
],
"distance_swimming": [
123
],
"distance_walking": [
123
],
"distance_wheelchair": [
123
],
"duration_active": [
123
],
"ecg_rri": [
123
],
"ecg_voltage": [
123
],
"elevation": [
123
],
"elevation_gain": [
123
],
"elevation_loss": [
123
],
"elevation_max": [
123
],
"elevation_min": [
123
],
"floors_climbed": [
123
],
"glucose": [
123
],
"heartrate": [
123
],
"heartrate_max": [
123
],
"heartrate_min": [
123
],
"heartrate_resting": [
123
],
"heartrate_resting_max": [
123
],
"heartrate_resting_min": [
123
],
"heartrate_zone0_duration": [
123
],
"heartrate_zone1_duration": [
123
],
"heartrate_zone2_duration": [
123
],
"heartrate_zone3_duration": [
123
],
"heartrate_zone4_duration": [
123
],
"heartrate_zone5_duration": [
123
],
"height": [
123
],
"hrv_rmssd": [
123
],
"hrv_sdnn": [
123
],
"latitude": [
123
],
"longitude": [
123
],
"pace": [
123
],
"skin_temperature": [
123
],
"skin_temperature_max": [
123
],
"skin_temperature_min": [
123
],
"sleep_breathing_rate": [
123
],
"sleep_breathing_rate_max": [
123
],
"sleep_breathing_rate_min": [
123
],
"sleep_duration": [
123
],
"sleep_duration_awake": [
123
],
"sleep_duration_deep": [
123
],
"sleep_duration_light": [
123
],
"sleep_duration_nap": [
123
],
"sleep_duration_rem": [
123
],
"sleep_efficiency": [
123
],
"sleep_interruptions": [
123
],
"sleep_latency": [
123
],
"sleep_score": [
123
],
"sleep_skin_temperature_deviation": [
123
],
"speed": [
123
],
"speed_max": [
123
],
"speed_min": [
123
],
"spo2": [
123
],
"spo2_max": [
123
],
"spo2_min": [
123
],
"steps": [
123
],
"swimming_distance_per_stroke": [
123
],
"swimming_lengths": [
123
],
"vo2max": [
123
],
"wakeup_latency": [
123
],
"weight": [
123
]
}
},
"source": {
"device_manufacturer": "<string>",
"device_model": "<string>",
"device_product": "<string>",
"device_version": "<string>",
"source_bundle_identifier": "<string>",
"source_os_version": "<string>",
"source_product": "<string>",
"source_version": "<string>"
},
"user_time_offset_minutes": 123
}
],
"from_timestamp": "2023-11-07T05:31:56Z",
"to_timestamp": "2023-11-07T05:31:56Z"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Start time of the query range in UTC, inclusive
Examples:
"2006-01-02T15:04:05"
"2006-01-02T15:04:05Z"
End time of the query range in UTC, non-inclusive
Examples:
"2006-01-02T15:04:05"
"2006-01-02T15:04:05Z"
Available options:
strava, health_connect, fitbit, garmin, huawei, dexcom, whoop, withings, suunto, apple, freestyle_libre, oura, polar, coros, ultrahuman, samsung_health_data, luna Include metrics
Available options:
heartrate_max, heartrate_min, heartrate_zone0_duration, heartrate_zone1_duration, heartrate_zone2_duration, heartrate_zone3_duration, heartrate_zone4_duration, heartrate_zone5_duration, heartrate, heartrate_resting, heartrate_resting_min, heartrate_resting_max, hrv_rmssd, hrv_sdnn, elevation_max, elevation_min, elevation_gain, elevation_loss, ascent, descent, calories_burned_active, calories_burned_basal, calories_burned, calories_intake, steps, floors_climbed, distance, distance_walking, distance_cycling, distance_running, distance_wheelchair, distance_swimming, speed, speed_max, speed_min, air_temperature_max, air_temperature, air_temperature_min, spo2, spo2_max, spo2_min, breathing_rate, breathing_rate_min, breathing_rate_max, longitude, latitude, elevation, duration_active, swimming_lengths, swimming_distance_per_stroke, sleep_efficiency, sleep_duration, sleep_duration_deep, sleep_duration_light, sleep_duration_rem, sleep_duration_awake, bedtime_duration, sleep_interruptions, sleep_duration_nap, sleep_score, sleep_breathing_rate, sleep_breathing_rate_min, sleep_breathing_rate_max, sleep_latency, wakeup_latency, cadence, cadence_min, cadence_max, pace, body_mass_index, weight, height, vo2max, body_temperature, body_temperature_max, body_temperature_min, basal_body_temperature, basal_body_temperature_max, basal_body_temperature_min, skin_temperature, skin_temperature_max, skin_temperature_min, sleep_skin_temperature_deviation, ecg_voltage, ecg_rri, body_fat, body_fat_min, body_fat_max, blood_pressure_systolic, blood_pressure_systolic_min, blood_pressure_systolic_max, blood_pressure_diastolic, blood_pressure_diastolic_min, blood_pressure_diastolic_max, body_bone_mass, glucose Include provider specific metrics such as unique sleep score
⌘I