Ctrl+K

Get WebSocket connection

get/api/prime/trading/v1/ws

Establish a WebSocket connection to get real-time updates for order books and trade orders.

Request Body

Event subscription details
One of
type string required
The event type (e.g. "subscribe" or "unsubscribe")
channel string required
The subscription channel (e.g. "level2" for order books)
accountId string required
The ID of the account
productId string required
The ID of product. (e.g. "TBTC-TUSD*")

101 Response

One of
channel string
The channel name (e.g. "level2").
type string
The type of the response (e.g. "snapshot").
product string
The product name (e.g. "TBTC-TUSD*").
time string <date-time>
The timestamp of the snapshot.
bids array[array]
An array of bid levels [price, size].
string
asks array[array]
An array of ask levels [price, size].
string