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

​
Request

{
  "message": "unsubscribe",
  "content": {
    "clientRequestId": "b21f0f58-8780-4cf2-b3d3-6439fed37304",
    "subscriptions": ["publicOrderBook"]
  }
}
FieldTypeRequiredDescription
messagestringYesunsubscribe
content.clientRequestIdstringNoClient-generated UUID for correlation
content.subscriptionsarrayYesOne or more subscriptions to remove

​
Response

{
  "resultType": "unsubscribed",
  "data": {
    "activeSubscriptions": ["orders", "optionsPositions", "optionsOpenOrders"],
    "requestedUnsubscriptions": ["publicOrderBook"],
    "clientRequestId": "b21f0f58-8780-4cf2-b3d3-6439fed37304",
    "statusCode": 200
  }
}
FieldTypeRequiredDescription
resultTypestringYesunsubscribed
data.activeSubscriptionsarrayYesAll currently active subscriptions after the operation
data.requestedUnsubscriptionsarrayYesThe subscriptions requested to be removed
data.clientRequestIdstringNoClient-generated UUID for correlation
data.statusCodenumberYes200

​
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