Skip to main content
This request adds one or more streams to the current WebSocket connection.

Request

{
  "message":"subscribe",
  "content":{
    "clientRequestId":"cfff0f58-8780-4cf2-b3d3-6439fed37304",
    "subscriptions":[
      "trades",
      "publicTrades",
      "publicOrderBook"
    ]
  }
}
FieldTypeRequiredDescription
messagestringYessubscribe
content.clientRequestIdstringNoClient-generated UUID for correlation
content.subscriptionsarrayYesOne or more subscriptions to add

Response

{
    "data": {
        "activeSubscriptions": [
            "orders",
            "trades",
            "publicTrades",
            "publicOrderBook"
        ],
        "clientRequestId": "cfff0f58-8780-4cf2-b3d3-6439fed37304",
        "requestedSubscriptions": [
            "trades",
            "publicTrades",
            "publicOrderBook"
        ]
    },
    "resultType": "subscribed"
}
FieldTypeRequiredDescription
data.activeSubscriptionsarrayYesAll currently active subscriptions after the operation
data.clientRequestIdstringNoClient-generated UUID for correlation
data.requestedSubscriptionsarrayYesThe specific subscriptions that were requested to be added
resultTypestringYessubscribed

Allowed Subscription Values

Subscription ValueDescription
ordersOrder creation and cancellation requests and notifications
tradesReal-time trade updates for your account
publicTradesReal-time trade updates and snapshots for subscribed markets
publicOrderBookReal-time order book updates and snapshots for subscribed markets

Behavior

  • Only new subscriptions are added to the connection
  • Re-subscribing to an already active subscription is a no-op
  • Existing subscriptions remain unaffected
  • Changes apply immediately
  • Safe to call repeatedly (idempotent)
  • Does not affect other connections
  • Does not require reconnecting