Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/oura_api/mod.ts

Typescript project to interact with v2 of the Oura Ring API
Latest
import * as ouraApi from "https://deno.land/x/oura_api@1.0.1/mod.ts";

Classes

Base class for the Oura API. Class containing all the methods to access the Oura API with a personal access token.

Base class for the OuraOAuth API. Class containing all the methods to access the Oura API with OAuth2 Authentication.

Base class for the Oura Webhook Subscription API Class containing all the methods to access the Oura Webhook Subscription API with a client id and client secret.

Interfaces

Holds details about daily activity metrics tracked by the Oura ring.

Represents a daily cardiovasculare age. Cardiovascular Age is an estimate of the health of your cardiovascular system in relation to your actual age.

Represents daily readiness metrics provided by the Oura ring.

Represents daily resilience metrics provided by the Oura ring.

Represents a recorded activity session tracked by the Oura ring.

Holds detailed sleep metrics tracked by the Oura ring.

Represents daily blood oxygen saturation (SpO2) data.

Represents daily strees summary

Provides details about a deleted webhook subscription.

Provides details about a deleted webhook subscription.

Represents an extended, multi-day tag with optional comments.

Represents a single heart rate measurement.

Represents the personal information of an Oura user.

Represents a period of time identified by the Oura ring as being in "rest mode".

Stores information about an Oura ring's configuration.

Represents sample of data

Holds a comprehensive set of sleep metrics provided by the Oura ring within a given timeframe. A user can have multiple sleep periods per day.

Represents Oura's recommendation about optimal bedtime for a given day.

Represents a single Oura webhook subscription.

Represents a simple note or annotation ("tag") associated with a day. Note: Tag is deprecated. We recommend transitioning to Enhanced Tag.

Represents a VO2 Max measurement VO2 Max is a measure of the maximum volume of oxygen that an individual can use during intense exercise.

Represents a workout tracked by the Oura ring.

Type Aliases

Union of possible of daily stress summaries

Represents the various types of data objects that can be monitored by Oura webhook subscriptions.

Represents a date format string as expected by the Oura API.

Represents the possible event types that can trigger an Oura webhook notification.

Union of Heart Rate sources

Union of possible of daily stress summaries

Union of possible of ring hardware generations

Union of possible of ring hardware generations

Union of possible OAuthScopes

Union of possible ring colour

Union of possible of ring designs

Union of possible of ring hardware generations