@lpezet/oura-ring-api-client

Oura Ring API Client

Typescript client for Oura Ring API. This is a restructuring of the code provided by Takahiro MITSUOKA.

You'll need to create a personal access token on Oura Ring to query their API.

import { 
    DailyActivityResponse, 
    HeartROuraApiV2Client, 
    PersonalInfoResponse } from '@lpezet/oura-ring-api-client';

const ouraApiV2Client = new OuraApiV2Client(process.env.OURA_PERSONAL_TOKEN || '');
const main = async () => {

    const dailyActivity:DailyActivityResponse = await ouraApiV2Client.dailyActivity();
    console.log(dailyActivity);
    
    const personalInfo:PersonalInfoResponse = await ouraApiV2Client.personalInfo();
    console.log(personalInfo);
};

main();

Table of Contents

Installation

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js. Node.js 14.0 or higher is required.

Installation is done using the npm install command:

$ npm install @lpezet/oura-ring-api-client

License

MIT

Publishing

To publish next version of oura-ring-api-client, run the following:

npm version patch
git push --tags origin master
npm run dist
npm publish --access public