# Spike API

## Docs

- [Authentication](https://docs.spikeapi.com/api-docs/authentication.md): Authentication process
- [Configuration](https://docs.spikeapi.com/api-docs/configuration.md): Essential application settings for API integration
- [Errors](https://docs.spikeapi.com/api-docs/errors.md): Handling of REST API error responses
- [API Overview](https://docs.spikeapi.com/api-docs/overview.md): Spike API is designed for developers who want to seamlessly connect their applications to user health data from multiple providers. Below is a high-level guide to the main parts of the integration process. Each section links to detailed documentation.
- [Provider Integration](https://docs.spikeapi.com/api-docs/provider_integration.md): Integration with providers
- [Querying Data](https://docs.spikeapi.com/api-docs/query_options_comparison.md): Comparison of Query Options for Developers
- [Release Notes](https://docs.spikeapi.com/api-docs/releases.md): Release notes for the Spike API.
- [Webhooks](https://docs.spikeapi.com/api-docs/webhooks.md): To receive data updates, configure a webhook endpoint via the admin console. After each data update from the provider, a webhook event will be sent to your endpoint.
- [Analyze Nutrition Image](https://docs.spikeapi.com/api-reference/analyze-nutrition-image.md): ##### Upload a food image and analyze the nutritional content.
- [Analyze Nutrition Facts Label](https://docs.spikeapi.com/api-reference/analyze-nutrition-label.md): ##### Upload an image of a nutritional facts label to analyze it.
- [Delete Integration](https://docs.spikeapi.com/api-reference/delete-integration.md): Delete an integration with a provider.
- [Delete Nutrition Record](https://docs.spikeapi.com/api-reference/delete-nutrition-record.md): ##### Delete a nutrition report record by ID.
- [Get Lab Report](https://docs.spikeapi.com/api-reference/get-lab-report.md): Retrieve a lab report by record ID.
- [Get Nutrition Record](https://docs.spikeapi.com/api-reference/get-nutrition-record.md): Retrieve a nutrition record by ID.
- [List Lab Reports](https://docs.spikeapi.com/api-reference/list-lab-reports.md): Retrieve a list of lab reports by the time range.
- [List Nutrition Records](https://docs.spikeapi.com/api-reference/list-nutrition-records.md): Retrieve a list of nutrition records by the time range.
- [Modify Nutrition Record](https://docs.spikeapi.com/api-reference/modify-nutrition-record.md): ##### Change the portion size for a nutrition record by ID.
- [Get Provider Record](https://docs.spikeapi.com/api-reference/query-provider-record-by-id.md): This endpoint allows you to query a single provider record with metrics by ID. It supports including sample data based on time series and provider-specific metrics in the response.
- [List Provider Records](https://docs.spikeapi.com/api-reference/query-provider-records-list.md): 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.
- [Get Sleep](https://docs.spikeapi.com/api-reference/query-sleep-by-id.md): This endpoint returns sleep data including different sleep stages that represent the various phases of sleep a person goes through during a sleep cycle. Each stage is characterized by distinct physiological and neurological patterns.
- [List Sleeps](https://docs.spikeapi.com/api-reference/query-sleep-list.md): This endpoint returns sleep data including different sleep stages that represent the various phases of sleep a person goes through during a sleep cycle. Each stage is characterized by distinct physiological and neurological patterns.
- [Daily Statistics](https://docs.spikeapi.com/api-reference/query-statistics-daily.md): This endpoint returns daily statistics calculated based on the data available for a specific time period. The data is aggregated for each day based on the user's local timezone.
- [Interval Statistics](https://docs.spikeapi.com/api-reference/query-statistics-interval.md): This endpoint returns statistics calculated based on the data available for a specific time period. The data is aggregated according to the time interval specified in your request, allowing you to see trends and patterns over time.
- [Time Series](https://docs.spikeapi.com/api-reference/query-timeseries.md): This endpoint returns a time series for a given metric with automatic merge strategy selection. The system chooses the optimal merge method based on metric characteristics to ensure the best data quality without manual configuration.
- [Get Workout](https://docs.spikeapi.com/api-reference/query-workout-by-id.md): This endpoint returns detailed information about a single workout by its activity ID. It provides comprehensive workout data including all available metrics, breakdowns, and associated data points for the specified activity.
- [List Workouts](https://docs.spikeapi.com/api-reference/query-workouts-list.md): This endpoint returns a list of workouts for a user, including various types of physical activities and exercises. Workouts represent structured physical activities that can be tracked and analyzed for fitness and health purposes.
- [Replace Nutrition Record](https://docs.spikeapi.com/api-reference/replace-nutrition-record.md): ##### Replace an existing nutrition record.
- [Upload Lab Report](https://docs.spikeapi.com/api-reference/upload-lab-report.md): Upload and process a base64 encoded document.
- [Upload Nutrition Record](https://docs.spikeapi.com/api-reference/upload-nutrition-record.md): ##### Upload a manually created nutrition record
- [User Information](https://docs.spikeapi.com/api-reference/user-info.md): Get information about the current user.
- [User Properties](https://docs.spikeapi.com/api-reference/user-properties.md): Get information about the current user.
- [Lab Reports Asynchronous Processing](https://docs.spikeapi.com/lab-reports/async.md): Handle lab report analysis with asynchronous processing and real-time webhook notifications
- [Lab Reports API Implementation Guide](https://docs.spikeapi.com/lab-reports/implementation.md): Complete code examples and integration patterns for the Lab Reports API
- [Lab Reports Overview](https://docs.spikeapi.com/lab-reports/overview.md): Upload lab report documents and receive detailed structured analysis powered by AI.
- [Desktop Chat Clients](https://docs.spikeapi.com/mcp-docs/desktop_clients.md): Local testing setup for exploring Spike MCP capabilities through desktop chat clients.
- [Integration Guide](https://docs.spikeapi.com/mcp-docs/implementation.md): Complete implementation examples for integrating Spike's MCP server with AI providers
- [MCP Overview](https://docs.spikeapi.com/mcp-docs/overview.md): Overview of the Spike MCP server and how to use it
- [MCP Tools](https://docs.spikeapi.com/mcp-docs/tools.md): Tools available in the MCP server
- [Nutrition AI Asynchronous Processing](https://docs.spikeapi.com/nutrition-ai/async.md): Handle nutrition analysis with asynchronous processing and real-time webhook notifications
- [Nutrition AI Implementation Guide](https://docs.spikeapi.com/nutrition-ai/implementation.md): Complete code examples and integration patterns for the Nutrition API
- [Nutrition AI Overview](https://docs.spikeapi.com/nutrition-ai/overview.md): Overview of the Spike Nutrition AI service and how to use it
- [Introduction](https://docs.spikeapi.com/overview.md): Get started with Spike API - your gateway to health and fitness data integration
- [Android SDK Backfill](https://docs.spikeapi.com/sdk-docs/android/backfill.md): Backfill historical data from Google Health Connect.
- [Android SDK Background Delivery](https://docs.spikeapi.com/sdk-docs/android/background-delivery.md): Background delivery ensures that data updates are sent to your backend via webhooks, even when the application is in the background or closed.
- [Android SDK Changelog](https://docs.spikeapi.com/sdk-docs/android/changelog.md): A changelog documenting version updates and changes of Spike SDK for Android platform.
- [Android SDK Logging](https://docs.spikeapi.com/sdk-docs/android/logging.md): Getting logs for troubleshooting and debugging from Spike SDK for Android platform.
- [Android SDK Nutrition AI](https://docs.spikeapi.com/sdk-docs/android/nutrition-ai.md): Analyze food images and retrieve nutritional information using AI-powered analysis in your Android app.
- [Android SDK Overview](https://docs.spikeapi.com/sdk-docs/android/overview.md): Overview of SDK-based integrations with health platforms including common principles, integration creation process, and data extraction methods for mobile health data management.
- [Android SDK Setup](https://docs.spikeapi.com/sdk-docs/android/setup.md): This document provides a setup guide of the Spike SDK for Android platform.
- [Android SDK Usage Guide](https://docs.spikeapi.com/sdk-docs/android/usage-guide.md): Start getting Spike data in 3 steps using Spike SDK for Android platform.
- [Android SDK for Samsung Health](https://docs.spikeapi.com/sdk-docs/android/usage-guide-shd.md): Start getting Spike data in 3 steps using Spike SDK for Samsung Health Data on Android platform.
- [Flutter SDK Background Delivery](https://docs.spikeapi.com/sdk-docs/flutter/background-delivery.md): Background delivery ensures that data updates are sent to your backend via webhooks, even when the application is in the background or closed.
- [Flutter SDK Changelog](https://docs.spikeapi.com/sdk-docs/flutter/changelog.md): A changelog documenting version updates and changes of Spike SDK for Flutter platform.
- [Flutter SDK Logging](https://docs.spikeapi.com/sdk-docs/flutter/logging.md): Getting logs for troubleshooting and debugging from Spike SDK for Flutter platform.
- [Flutter SDK Nutrition AI](https://docs.spikeapi.com/sdk-docs/flutter/nutrition-ai.md): Analyze food images and retrieve nutritional information using AI-powered analysis in your Flutter app.
- [Flutter SDK Overview](https://docs.spikeapi.com/sdk-docs/flutter/overview.md): Overview of SDK-based integrations with health platforms including common principles, integration creation process, and data extraction methods for mobile health data management.
- [Flutter SDK Setup](https://docs.spikeapi.com/sdk-docs/flutter/setup.md): This document provides a setup guide of the Spike SDK for Flutter platform.
- [Flutter SDK Usage Guide](https://docs.spikeapi.com/sdk-docs/flutter/usage-guide.md): Start getting Spike data in 3 steps using Spike SDK for Flutter platform.
- [Flutter SDK for Samsung Health](https://docs.spikeapi.com/sdk-docs/flutter/usage-guide-shd.md): Start getting Spike data in 3 steps using Spike SDK for Samsung Health Data on Flutter platform.
- [iOS SDK Backfill](https://docs.spikeapi.com/sdk-docs/ios/backfill.md): Backfill historical data from Apple HealthKit.
- [iOS SDK Background Delivery](https://docs.spikeapi.com/sdk-docs/ios/background-delivery.md): Background delivery ensures that data updates are sent to your backend via webhooks, even when the application is in the background or closed.
- [iOS SDK Changelog](https://docs.spikeapi.com/sdk-docs/ios/changelog.md): A changelog documenting version updates and changes of Spike SDK for iOS platform.
- [iOS SDK Logging](https://docs.spikeapi.com/sdk-docs/ios/logging.md): Getting logs for troubleshooting and debugging from Spike SDK for iOS platform.
- [iOS SDK Nutrition AI](https://docs.spikeapi.com/sdk-docs/ios/nutrition-ai.md): Analyze food images and retrieve nutritional information using AI-powered analysis in your iOS app.
- [iOS SDK Overview](https://docs.spikeapi.com/sdk-docs/ios/overview.md): Overview of SDK-based integrations with health platforms including common principles, integration creation process, and data extraction methods for mobile health data management.
- [iOS SDK Setup](https://docs.spikeapi.com/sdk-docs/ios/setup.md): This document provides a setup guide of the Spike SDK for iOS platform.
- [iOS SDK Usage Guide](https://docs.spikeapi.com/sdk-docs/ios/usage-guide.md): Start getting Spike data in 3 steps using Spike SDK for iOS platform.
- [React Native SDK Background Delivery](https://docs.spikeapi.com/sdk-docs/react-native/background-delivery.md): Background delivery ensures that data updates are sent to your backend via webhooks, even when the application is in the background or closed.
- [React Native SDK Changelog](https://docs.spikeapi.com/sdk-docs/react-native/changelog.md): A changelog documenting version updates and changes of Spike SDK for React Native platform.
- [React Native SDK Logging](https://docs.spikeapi.com/sdk-docs/react-native/logging.md): Getting logs for troubleshooting and debugging from Spike SDK for React Native platform.
- [React Native SDK Nutrition AI](https://docs.spikeapi.com/sdk-docs/react-native/nutrition-ai.md): Analyze food images and retrieve nutritional information using AI-powered analysis in your React Native app.
- [React Native SDK Overview](https://docs.spikeapi.com/sdk-docs/react-native/overview.md): Overview of SDK-based integrations with health platforms including common principles, integration creation process, and data extraction methods for mobile health data management.
- [React Native SDK Plugin Expo](https://docs.spikeapi.com/sdk-docs/react-native/plugin-expo.md): Using Expo plugin with Spike SDK for React Native in your project.
- [React Native SDK Setup](https://docs.spikeapi.com/sdk-docs/react-native/setup.md): This document provides a setup guide of the Spike SDK for React Native platform.
- [React Native SDK Usage Guide](https://docs.spikeapi.com/sdk-docs/react-native/usage-guide.md): Start getting Spike data in 3 steps using Spike SDK for React Native platform.
- [React Native SDK for Samsung Health](https://docs.spikeapi.com/sdk-docs/react-native/usage-guide-shd.md): Start getting Spike data in 3 steps using Spike SDK for Samsung Health Data on React Native platform.
- [Activity Types and Tags](https://docs.spikeapi.com/technical-references/activity_matrix.md): This document provides a comprehensive overview of all activities, detailing their tags and descriptions. The table below summarizes the key features supported by each activity.
- [Application Configuration](https://docs.spikeapi.com/technical-references/application_configuration.md): Configure your Spike API application settings in the admin console
- [Backfill of Historical Data](https://docs.spikeapi.com/technical-references/backfill.md): Comprehensive guide to backfill mechanisms for retrieving historical health data across different providers and platforms.
- [Metric Types and Units](https://docs.spikeapi.com/technical-references/metrics_matrix.md): This document provides a comprehensive overview of all metrics, detailing their providers, descriptions, units, and number of decimals for output precision. The table below summarizes the key features supported by each metric.
- [Nutritional Fields](https://docs.spikeapi.com/technical-references/nutritional_fields.md): The API supports analysis of 29 comprehensive nutritional fields, organized into macronutrients and micronutrients.
- [Supported Providers](https://docs.spikeapi.com/technical-references/provider_matrix.md): This document provides a comprehensive overview of all providers, detailing their capabilities. The list below summarizes the key features supported by each provider.
- [Statistic Types and Methods](https://docs.spikeapi.com/technical-references/statistics_matrix.md): This document provides a comprehensive overview of all statistics, detailing their methods, metrics, units, precision, and descriptions. The table below summarizes the key features supported by each statistic.

## OpenAPI Specs

- [openapi](https://docs.spikeapi.com/api-reference/openapi.json)