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

Request

{
  "message":"unsubscribe",
  "content":{
    "clientRequestId":"245867a5-0de9-4542-a9da-724577ab4102",
    "subscriptions":[
      "trades",
      "publicTrades",
      "publicOrderBook"
    ]
  }
}
FieldTypeRequiredDescription
messagestringYesunsubscribe
content.clientRequestIdstringNoClient-generated UUID for correlation
content.subscriptionsarrayYesOne or more subscriptions to remove

Response

{
    "data": {
        "activeSubscriptions": [
            "orders"
        ],
        "clientRequestId": "245867a5-0de9-4542-a9da-724577ab4102",
        "requestedUnsubscriptions": [
            "trades",
            "publicTrades",
            "publicOrderBook"
        ]
    },
    "resultType": "unsubscribed"
}
FieldTypeRequiredDescription
data.activeSubscriptionsarrayYesRemaining active subscriptions after the operation
data.clientRequestIdstringNoClient-generated UUID for correlation
data.requestedUnsubscriptionsarrayYesThe specific subscriptions that were requested to be removed
resultTypestringYesunsubscribed

Behavior

  • Only active subscriptions are removed
  • Removing a non-active subscription is a no-op
  • Other subscriptions remain unaffected
  • Changes apply immediately
  • Safe to call repeatedly (idempotent)
  • Does not affect other connections
  • Does not require reconnecting