Skip to content
oura-toolkit

TypeScript

The TypeScript SDK is the generated client published as @oura-toolkit/api plus the hand-written @oura-toolkit/auth companion — versioned in lockstep with the toolkit and published on every release tag.

Install

Section titled “Install”
Terminal window
npm install @oura-toolkit/api @oura-toolkit/auth

Usage sketch

Section titled “Usage sketch”

The client is auth-agnostic — construct it with a base URL and attach your Bearer token, then call the generated operation for daily sleep:

import { Configuration, DefaultApi } from "@oura-toolkit/api";


const api = new DefaultApi(
  new Configuration({
    basePath: "https://api.ouraring.com",
    accessToken: process.env.OURA_ACCESS_TOKEN,
  }),
);


const sleep = await api.dailySleep({ startDate: "2026-06-01", endDate: "2026-06-07" });
for (const day of sleep.data) console.log(day.day, day.score);

Exact class and method names come from the generated client — browse the API reference for the operations and models. The generated code is marked generated; regenerate it from the spec rather than editing by hand.