Subscribing & Unsubscribing

Once connected and authenticated to the sFOX WebSocket API you can subscribe to various feeds by using the subscribe or unsubscribe command.

These commands should be JSON with the following properties:

Property
Type
Command

type

string

Command you are sending to the websocket (subscribe or unsubscribe)

feeds

string[]

List of the feeds that should be subscribed/unsubscribed to

const subscribeMsg = {
  type: 'subscribe',
  feeds: ['ticker.sfox.btcusd']
}
ws.send(JSON.stringify(subscribeMsg));

...

const unsubscribeMsg = {
  type: 'unsubscribe',
  feeds: ['ticker.sfox.btcusd']
}
ws.send(JSON.stringify(unsubscribeMsg))

Last updated