npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

oura_api

v1.0.2

Published

ŌURA Cloud API. Interact with v2 of the Oura API using Personal Access Tokens, OAuth2, or the Sandbox environment. Includes support for the Webhook subscriptions.

Downloads

138

Readme

OURA_API

Interact with v2 of the Oura API using Personal Access Tokens, OAuth2, or the Sandbox environment.

Available as:

  • ESM module: JSR
  • CommonJS module: NPM

⚡️ Quickstart

Installation

# Deno
deno add @pinta365/oura-api

# Bun
bunx jsr add @pinta365/oura-api

# Node.js
npx jsr add @pinta365/oura-api

# NPM (CommonJS)
npm install oura_api --save

Basic Usage (ESM)

import { Oura } from "@pinta365/oura-api";

const accessToken = "YOUR_PERSONAL_ACCESS_TOKEN";
const oura = new Oura(accessToken);

const personalInfo = await oura.getPersonalInfo();
console.log(personalInfo);

Basic Usage (CommonJS)

const { Oura } = require("oura_api");
// ... (same as above)

See the examples folder for more detailed implementations.

🧪 Sandbox Environment (Testing)

The Oura API's sandbox environment (Docs) is perfect for development. It provides sample data so you don't need a real Oura account to test your application.

const ouraSandboxClient = new Oura({ useSandbox: true });
// ...Make API calls with `ouraSandboxClient`

🔑 OAuth2 Support

Our library simplifies OAuth2 authentication with these functions:

  • generateAuthUrl(scopes: string[], state?: string): string

    • Generates the authorization URL for the user.
  • async exchangeCodeForToken(code: string): Promise<OAuth2TokenResponse>

    • Exchanges the received authorization code for access and refresh tokens.
  • async refreshAccessToken(suppliedRefreshToken: string): Promise<OAuth2TokenResponse>

    • Refreshes an expired access token.
  • async revokeAccessToken(accessToken: string): Promise<boolean>

    • Revokes the specified access token.

Example Usage (Simplified) See the examples folder for a basic implementation using Hono.

import { OuraOAuth } from "@pinta365/oura-api";

const oura = new OuraOAuth({
    clientId: "YOUR_CLIENT_ID",
    clientSecret: "YOUR_CLIENT_SECRET",
    redirectUri: "http://localhost:8000/callback",
});

// 1. Generate the authorization URL
const authUrl = oura.generateAuthUrl(["personal"]);

// 2. Redirect the user to `authUrl`
// ... (Implementation in your web application)

// 3. In your callback route, exchange the code for tokens
app.get("/callback", async (c) => {
    const code = c.req.query("code");
    const tokens = await oura.exchangeCodeForToken(code);

    // ... Store tokens securely and use the access_token for API calls
});

📑 Documentation

Included data scopes for v2 of the API.

| Endpoint/Scope | Status | | :------------------------------------------------------------------------------- | :---------- | | Oura Base docs | | | Daily Activity | Implemented | | Daily Cardiovascular Age | Implemented | | Daily Readiness | Implemented | | Daily Resilience | 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 | DEPRECATED | | Vo2 Max | Implemented | | Workout | Implemented | | Webhook Subscription docs | | | List subscription | Implemented | | Create subscription | Implemented | | Update subscription | Implemented | | Delete subscription | Implemented | | Renew subscription | Implemented |

Additional info concerning the webhook API

Webhooks enable near real-time Oura data updates and are recommended for getting the latest information. The subscription workflow is implemented in this library – see the Webhook docs for details.

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

🐞 Issues

Please report any issues or questions on the GitHub repository.

📄 License

MIT License - see the LICENSE file.