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":[
      "tradeStream",
      "orderBookStream"
    ]
  }
}

​
Response

{
    "data": {
        "activeSubscriptions": [
            "orderCreation",
            "tradeStream",
            "orderBookStream"
        ],
        "clientRequestId": "cfff0f58-8780-4cf2-b3d3-6439fed37304",
        "requestedSubscriptions": [
            "tradeStream",
            "orderBookStream"
        ]
    },
    "resultType": "subscribed"
}
FieldTypeDescription
data.activeSubscriptionsarrayAll currently active subscriptions after the operation
data.clientRequestIdstringThe request ID that was provided in the original request
data.requestedSubscriptionsarrayThe specific subscriptions that were requested to be added
resultTypestringAlways “subscribed” for subscribe responses

​
Allowed Subscription Values

Subscription ValueDescription
orderCreationOrder creation acknowledgements and validation feedback
tradeStreamReal-time trade updates and recent completed orders
orderBookStreamReal-time order book updates and snapshots

​
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