Overview

Use the WebSocket API for market streams and private account updates.

Endpoints

Environment	URL
Production	`wss://pulse.obsdn.trade/ws`
Staging	`wss://pulse.staging.obsdn.trade/ws`

Quick Start

# Using wscat
wscat -c wss://pulse.obsdn.trade/ws

const ws = new WebSocket("wss://pulse.obsdn.trade/ws")

ws.onopen = () => {
  ws.send(
    JSON.stringify({
      op: "sub",
      channel: "ticker",
      params: { market: "BTC-PERP" },
    })
  )
}

ws.onmessage = (event) => {
  console.log(JSON.parse(event.data))
}

Message Model

{
  "op": "sub",
  "channel": "CHANNEL_NAME",
  "params": { "market": "MARKET_ID" }
}

Unsubscribe

{
  "op": "unsub",
  "channel": "CHANNEL_NAME",
  "params": { "market": "MARKET_ID" }
}

The params field is channel-specific. Market channels use { "market": "BTC-PERP" }, the oracle channel uses { "asset": "BTC" }, and private user channels require no params.

Auth (for private channels)

Send before subscribing to any private channel.

{
  "op": "auth",
  "params": {
    "key": "your_api_key",
    "timestamp": "1734567890",
    "signature": "your_signature"
  }
}

The signature is computed as base64(HMAC-SHA256(api_secret, "${api_key},${timestamp}")) — standard base64 encoding.

timestamp is a Unix time in seconds (string) and must be within ±60 seconds of server time, otherwise the auth message is rejected.

import { createHmac } from "node:crypto"

const timestamp = Math.floor(Date.now() / 1000).toString()
const signature = createHmac("sha256", apiSecret).update(`${apiKey},${timestamp}`).digest("base64")

Heartbeat

The server accepts ping messages and responds with a pong. Send a ping every 10 seconds to keep the connection alive. Close and reconnect if no response is received within 3 seconds.

{ "op": "ping" }

{ "type": "pong" }

Subscribed Confirmation

After a successful subscription, the server sends:

{
  "type": "subscribed",
  "channel": "CHANNEL_NAME",
  "params": { "market": "BTC-PERP" }
}

The params field echoes back the subscription parameters (omitted if no params were provided).

Channel Summary

Channel	Auth	`params`	Snapshot	Updates
`book`	No	`{ market }`	Yes	Yes
`trade`	No	`{ market }` (optional)	No	Yes
`ticker`	No	`{ market }`	Yes	Yes
`oracle`	No	`{ asset }`	Yes	Yes
`order`	Yes	None	Yes	Yes
`position`	Yes	None	Yes	Yes
`portfolio`	Yes	None	Yes	Yes

Connection Guidance

Implement automatic reconnect with exponential backoff.
Resubscribe to all channels after reconnect.
Process messages in-order per channel/market stream.
Validate order book checksums and resubscribe on mismatch.
Send ping every 10 seconds; reconnect if pong is not received within 3 seconds.