Intro

Welcome to the Pulsoid API documentation.

Pulsoid enables real-time heart rate data transmission from the peripherals(like BLE heart rate monitors, smartwatches, etc) to the Clients. Pulsoid API allows reading real-time heart rate data.

Users - are real people who stream their heart rate data via Pulsoid.

Clients - are applications that want to read Pulsoid users' data. The developer should create client credentials at pulsoid.net/ui/api-clients. Received client credentials include client_secret which should be stored securely and never shared.

To consumer Pulsoid API, the developer should obtain an authorization token. An authorization token is used in every API call. Obtaining the token can be challenging but we are here to help you :).

How to Obtain an Authorization Token

• For Personal Use: Manual Token Issuing is suitable and client credentials are not needed.

• For Websites: The Implicit Grant is suitable.

• For Desktop Applications: If handling deep links, the Implicit Grant is suitable.

• For Backend Servers: The Authorization Code Grant is recommended.

• For Plugins or Desktop Applications: Use OAuth 2 Device Authorization Flow.

• For Plugins or Desktop Applications: In case OAuth 2 Device Authorization Flow .

• For Enterprise Applications: To use Pulsoid for real-time heart rate data, contact us at [email protected] or on Discord.

• If you still have questions, ask them via [email protected] or on Discord.

JavaScript / TypeScript

If you are building a JavaScript or TypeScript application, use the official @pulsoid/socket library for real-time heart rate streaming. It handles WebSocket connections, auto-reconnection, and provides full TypeScript support with zero dependencies.

npm install @pulsoid/socket

import PulsoidSocket from '@pulsoid/socket';

const socket = PulsoidSocket.create('YOUR_TOKEN');

socket.on('heart-rate', (data) => {
  console.log(`${data.heartRate} BPM`);
});

await socket.connect();

See the GitHub repository for full documentation.

Recap

So, to integrate with Pulsoid you need to:

1. Create client credentials at pulsoid.net/ui/api-clients

2. Decide, what way of obtaining tokens is suitable for you

3. Use the API

FAQ