Skip to content

Oura API

Jump to bottom
pgalko edited this page Mar 20, 2022 · 2 revisions

Create and Setup Oura API application

You will need to register your Athlete_Data_Warehouse application with Oura, and get the Client ID and Client Secret to be able to authenticate via OAuth2 and download user data from Oura.

Once your application is registered with Oura input the client ID, client secret, auth URL and token URL into work_dir/config/settings.ini before you run the application for the first time. The details will be encrypted upon application's first run and clear text settings.ini deleted.

[oura]
oura_client_id = XZ2115RFR57EN6D
oura_client_secret = BYW47BOKU4YLO4434UQX4HTLDFBJ5ZLJ
oura_auth_url = https://cloud.ouraring.com/oauth/authorize
oura_token_url = https://api.ouraring.com/oauth/token
  • Basic info about the API

The Oura API makes it easy to access data generated by the Oura Ring. To use the Oura API, you need an Oura account and an API application. This documentation is for the Oura API V1. Click here:https://cloud.ouraring.com/v2/docs to view documentation for the Oura API V2, which includes additional data types and functionality. For more information on rate limiting see the V2 documentation here:https://cloud.ouraring.com/v2/docs.

The current timeline to sunset the Oura API V1 is early 2023. We are not planning any updates—outside of required maintenance—to the Oura API V1 moving forward. A migration guide for users to transition from V1 to V2 of the Oura API will be available in February 2022.

  • How to Create an account

  1. Create an Oura account If you don't already have one.
    Create an Oura account using the Oura iOS or Android application. Use the same account to sign-in to https://cloud.ouraring.com.

  2. Create an API application.
    If you want to use the Oura API to pull data from multiple users, you'll need to register a new OAuth2 application under API Applications. Go to https://cloud.ouraring.com/oauth/applications and click on "New Application" button.

  3. A registered OAuth application is assigned a unique Client ID and Client Secret. Fill in the rest of the details as per the below screenshot.

image

By default, API Applications have a ten user limit. If you want to release your application to a wider audience, your application needs to be approved. Once you have finished developing your application, you can submit it for review from the application's page.

Clone this wiki locally