HypeRate Websocket API

Public-safe demos and documentation for the HypeRate WebSocket API (heart rate only).

• 🌐 Browser demo (GitHub Pages–ready)
• 🧩 Node.js / TypeScript demo
• 📘 API documentation (Markdown)
• 🔒 No API keys included

This repository is a developer reference & demo, not a full SDK.

---

Get an API Key

You can request an API key here:
👉 https://hyperate.io/api

---

Repository Structure

.
├─ web/        # Browser demo (public-safe, GitHub Pages)
├─ node-ts/    # Node.js / TypeScript demo
├─ docs/       # API documentation (Markdown)
├─ SECURITY.md
└─ .gitignore

---

Security Notice (Public Repository)

• API keys are never included
• Do not commit keys or paste them into issues or screenshots
• Browser demo stores credentials only locally (optional, via localStorage)

---

GitHub Pages

The browser demo can be safely deployed via GitHub Pages.

Users paste their API key locally — no credentials are shipped with this repo.

---

Documentation

• WebSocket API – Heart Rate Only