private/get_cancel_on_disconnect

Read the current Cancel On Disconnect configuration.

• scope=connection (the default) returns the state for the current WebSocket connection and is available over WebSocket only. Over REST/HTTP it fails with 10030 (must_be_websocket_request), so HTTP clients must pass scope=account.
• scope=account returns the account setting, works over both WebSocket and REST/HTTP, and requires the account:read scope.

Scope: account:read (only for scope=account)

Try in API console

cURL

request

curl --request GET \
  --url https://test.deribit.com/api/v2/private/get_cancel_on_disconnect \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 220,
  "method": "private/get_cancel_on_disconnect",
  "params": {
    "scope": "account"
  }
}
'

200

response

{
  "jsonrpc": "2.0",
  "id": 220,
  "result": {
    "scope": "account",
    "enabled": false
  }
}

Query Parameters

scope · enum<string> · default: connection

Specifies if Cancel On Disconnect change should be applied/checked for the current connection or the account (default - connection)

NOTICE: Scope connection can be used only when working via Websocket.

Available options: connection, account

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · object · required

Hide child attributes

result. scope · enum<string> · required

Informs if Cancel on Disconnect was checked for the current connection or the account

Available options: connection, account

result. enabled · boolean · required

Current configuration status

Example:

true

id · integer

The id that was sent in the request