https://github.com/morinokami/oura-js

https://github.com/morinokami/oura-js

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/morinokami/oura-js
• Owner: morinokami
• License: mit
• Created: 2021-12-11T06:32:09.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-16T08:23:30.000Z (almost 3 years ago)
• Last Synced: 2024-11-15T00:16:39.974Z (about 1 month ago)
• Language: TypeScript
• Size: 180 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Oura.js

[Oura Cloud API](https://cloud.ouraring.com/docs/) client with types.

## Installation

```sh

$ npm install oura-js

```

## Usage

```js

import { Oura } from 'oura-js'

// Access Token: https://cloud.ouraring.com/docs/authentication

const token = 'MY_ACCESS_TOKEN'

const oura = new Oura(token)

console.log(await oura.sleep({ start: '2021-12-10' }))

```

## API

API | Data

--- | ---

`userInfo` | [Personal Info](https://cloud.ouraring.com/docs/personal-info)

`sleep` | [Sleep](https://cloud.ouraring.com/docs/sleep)

`activity` | [Actibity](https://cloud.ouraring.com/docs/activity)

`readiness` | [Readiness](https://cloud.ouraring.com/docs/readiness)

`bedtime` | [Ideal Bedtime](https://cloud.ouraring.com/docs/bedtime)

## Development Status

Status | HTTP Method | Endpoint | API

--- | --- | --- | ---

⚡ | GET | /v1/userinfo | `userInfo`

⚡ | GET | /v1/sleep | `sleep`

⚡ | GET | /v1/activity | `activity`

⚡ | GET | /v1/readiness | `readiness`

⚡ | GET | /v1/bedtime | `bedtime`