Skip to main content
See rate limit applied to this WebSocket request.

​
Unique Client Request ID

For the current WebSocket request, you can optionally include a unique client request ID in the request body. The same client request ID will be found in the response and is used to match the response to the request. The client request ID must be a UUID.

​
Cross-Leverage Multiplier

We use a cross-leverage approach in our trading platform. This means leverage is applied at the account level rather than the market or trade level. Despite the fact that the update leverage request is sent to a specific market, the leverage change will apply to all markets in the account. The currently supported leverage values are 1, 2, 3, 4, and 5. If the leverage has never been set for the account, it will default to 1.

​
Acknowledgment And Confirmation

When you update the leverage, you will first receive a response to acknowledge that the request has been received. Then you will receive another response to confirm that the leverage has been successfully updated. There are two differences between these two responses:
AcknowledgmentConfirmation
Bodyleverage update in progress, pending approvalleverage updated successfully
Status Code202200

​
URL

This stream can be subscribed per market and you will need to pass in the market in the URL query. See below.

​
Query params

​
market
string
required
Example value: ETH-USD. To get all supported markets, call /api/v1/markets endpoint.

​
Headers

See Authorization section on how to retrieve authorization token. Once token is received, set Sec-WebSocket-Protocol headers in the WebSocket handshake request or on connect().
​
Sec-WebSocket-Protocol
string
required
Example value (authorization token) :
authorization#eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdGFnaW5nLmZ1bmdpYmxlLnh5eiIsInN1YiI6ImQxM2I1MzBmLWFmNzMtNDBmOS04ZjhlLWVkNzk1OTU3YTU3ZiIsImF1ZCI6WyJzdGFnaW5nLWFwcC5mdW5naWJsZS54eXoiXSwiZXhwIjoxNzAzMzA1NzQwLCJpYXQiOjE3MDMzMDM5NDB9.vsHe4G_yEkRfz8XNoTKcX83udA-LUysWD4q80wfCC8k

{
  "message": "updateLeverage",
  "content": {
    "clientRequestId": "0835bf3e-4a20-41f0-908d-8213f2b7a285",
    "leverage": "1"
  }
}

// Request received successfully
{
  "resultType": "updateLeverage",
  "data": {
    "statusCode": 202,
    "body": "leverage update in progress, pending approval",
    "clientRequestId": "0835bf3e-4a20-41f0-908d-8213f2b7a285"
  },
  "connectionId": "KNal9ekeCYcCIBA="
}
⌘I