OURA_API

Deno library to interact with v2 of the Oura API.

The library is also available for Node.js via a NPM package.


Example usage

Deno

Change the import URL to include the latest version number. Example: https://deno.land/x/oura_api@0.4.0/mod.ts

import { Oura, DateFormat } from "https://deno.land/x/oura_api/mod.ts";

// Replace 'YOUR_ACCESS_TOKEN' with your actual access token
const accessToken = "YOUR_ACCESS_TOKEN";
const ouraClient = new Oura(accessToken);

const startDate: DateFormat = "2023-01-01";
const endDate: DateFormat = "2023-01-10";

try {
  const dailyActivityData = await ouraClient.getDailyActivityDocuments(startDate, endDate);

  console.log(`Daily Activity Data: ${JSON.stringify(dailyActivityData, null, 4)}`);
} catch (error) {
  console.error(`Error fetching daily activity data: ${error}`);
}

Node.js

Install package.

npm install oura_api --save

Code example.

const Api = require('oura_api');
// Replace 'YOUR_ACCESS_TOKEN' with your actual access token
const accessToken = "YOUR_ACCESS_TOKEN";
const ouraClient = new Api.Oura(accessToken);

const startDate = "2023-01-01";
const endDate = "2023-01-10";


const example = async () => {
    try {
        const dailyActivityData = await ouraClient.getDailyActivityDocuments(startDate, endDate);
      
        console.log(`Daily Activity Data: ${JSON.stringify(dailyActivityData, null, 4)}`);
      } catch (error) {
        console.error(`Error fetching daily activity data: ${error}`);
      }
  };
  
  example();

Documentaion

Library and method documentation can be found at the Deno Land documentation page.

Included data scopes for v2 of the API.

Endpoint/Scope Status
Oura Base
Daily Activity Implemented
Daily Readiness Implemented
Daily Sleep Implemented
Daily Spo2 Implemented
Daily Stress Implemented
Enhanced Tag Implemented
Heart Rate Implemented
Personal Info Implemented
Rest Mode Period Implemented
Ring Configuration Implemented
Session Implemented
Sleep Implemented
Sleep Time Implemented
Tag DEPRICATED
Workout Implemented
Webhook Subscription
List subscription Implemented
Create subscription Implemented
Update subscription Implemented
Delete subscription Implemented
Renew subscription Implemented

Additional info concerning the webhook API

According to the API docs the webhooks enable you to receive near real-time Oura data updates and are the preferred way to receive the latest data from the Oura API.

I have not been able to fully verify this yet but the subscription workflow has been implemented.

Read the Webhook docs before atempting to use it.

Issues

Issues or questions concerning the library can be raised at the github repository page.

License

This project is licensed under the MIT License - see the LICENSE file for details.