The Oura API v2

For frequently asked questions (FAQs) about the Oura API v2, check out this article.

With heroic efforts in 2016, Oura Chief Technology Officer (CTO) Teemu Kurppa created the Oura API v1 in a matter of weeks. The Oura API v1 has lived an effective life and it was time for an upgrade to realize our vision: make the Oura API the easiest and most valuable wearable API for partners.

In January 2022, we released version 2 (i.e. v2) of the Oura API to build toward this vision. The Oura API v2 takes advantage of modernized data architecture, permitting stronger security, greater scalability, new functionality, greater performance, and more data endpoints.

With the Oura API v2, new data endpoints are available. In the initial release, we add new data scopes that are not available through the Oura API v1, including: 

  1. Daytime Heart Rate. The Oura Ring Generation 3 brings daytime heart rate measurement and now you can pull those readings from Oura into your user experience.
  2. Workouts. Information about the growing list of workouts that help inform how the user is training and exercising.
  3. Sessions. Details on how users engage with guided and unguided sessions in the Oura App, including the user’s biometric trends during the sessions.
  4. Tags. Tags include activities, environment factors, symptoms, emotions, and other aspects that provide broader context into what’s happening with users beyond the objective data generated by the Oura Ring.

For more details about the Oura API v2 data scopes: read the API documentation.

New data scopes will be sequentially added to the Oura API v2 as we finish a data architecture upgrade in phases. This will include the addition of the Sleep scope and Readiness scope shortly after the initial release.

We’re always improving, making the Oura Ring the easiest and most valuable wearable to integrate. Beyond new data, we’ll also offer enhanced functionality to enable new use cases using Oura data. For instance, we plan to eventually offer webhooks to enable more real-time delivery of data and a sandbox environment so you don’t need an Oura Ring to start experimenting with the Oura API.

Have any ideas for how else we can improve the Oura API? Need guidance on how to get started? Let us know at: api-support@ouraring.com.

The Oura API v1 will continue to be supported for at least a year after the release of the Oura API v2 in January 2022. Oura will provide a clear, simple path for partners to upgrade from v1 to v2. Get started today by reading the Oura API v2 documentation and by completing an API application.

Difference Between the Oura API v1 and v2

The Oura API v2 takes advantage of modernized data architecture, permitting stronger security, greater scalability, new functionality, greater performance, and more data endpoints.

Data Endpoints

Table 1 below summarizes the key data differences between the Oura API v1 and the Oura API v2. For full details, read the API documentation for v1 and v2.

Data Scope

Examples of Data Endpoints

Oura API v1

Oura API v2

Readiness

Readiness Score

Contributors to Readiness Score

Yes

Coming soon

Sleep

Sleep Score

Total Sleep Time

Sleep Stages

Heart Rate (during sleep)

Heart Rate Variability (during sleep)

Temperature deviation

Respiratory Rate (during sleep)

Others

Yes

Coming soon

Bedtime

Ideal bedtime window

Yes

Coming soon

Activity

Activity Score

Steps

METs

Inactivity

Others

Yes

Yes

Personal Info

Age

Email

Height

Weight

Yes

Yes

Heart Rate

Time-series heart rate data, including daytime HR for Oura Ring Generation 3

No

Yes

Sessions

HR and HRV trends during sessions

Type of session

Timing of session

No

Yes

Tags

Tags entered from the Oura App

No

Yes

Workouts

Type of workout

Duration of workout

Intensity of workout

No

Yes

Table 1: Data scopes available in the v1 and v2 of the Oura API

Note: Oura users must have updated to a recent version of the Oura mobile app to support new data types that are available through the Oura API v2.

Note: The Oura API v1 will continue to be supported for at least a year after the release of the Oura API v2 in January 2022. Oura will provide a clear, simple path for partners to upgrade from v1 to v2.

Authentication

The Oura API v2 uses the same OAuth system as the Oura API v1. Existing clients will have access to both the Oura API v1 and the Oura API v2 through their existing keys.

Unlike the Oura API v1, the Oura API v2 access tokens must be included in the request header and cannot be included as a query string parameter.

The Future

Our vision is to make The Oura API the easiest and most valuable wearable API for partners. To realize this vision, we will continually improve the functionality and increase the available data endpoints.

Was this article helpful? 24 out of 31 found this helpful
Back to the Top