private/logout

This method provides a clean way to close WebSocket connections while preserving active orders when Cancel On Disconnect (COD) is enabled.

Use Cases:

• Clean Shutdown: Properly close WebSocket connections during application shutdown or restart
• Order Preservation: Close connections without triggering order cancellations when COD is enabled
• Session Management: Invalidate tokens to ensure security when closing connections
• Maintenance Operations: Temporarily disconnect for system maintenance without affecting trading positions

Cancel On Disconnect (COD) Behavior:

When Cancel On Disconnect is enabled for your connection, this method provides a safe way to close the connection without triggering automatic order cancellations. This is different from other disconnection scenarios:

• Graceful logout (this method): Orders are NOT cancelled, even if COD is enabled
• Unexpected disconnection: Orders are cancelled if COD is enabled
• Inactivity timeout: Orders are cancelled if COD is enabled
• Heartbeat failure: Orders are cancelled if COD is enabled

This distinction allows you to perform planned disconnections (e.g., for maintenance, updates, or reconnection) while preserving your active orders.

WebSocket Only:

This method is designed exclusively for WebSocket connections. Attempting to use it via REST/HTTP will result in a 400 error response.

Note: This method has no response. The WebSocket connection is closed immediately after the request is processed.

Gracefully terminate the current WebSocket connection and optionally invalidate all tokens associated with the session

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/logout \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "private/logout",
  "params": {
    "access_token": "1529453804065.h2QrBgvn.oS36pCOmuK9EX7954lzCSkUioEtTMg7F5ShToM0ZfYlqU05OquXkQIe2_DDEkPhzmoPp1fBp0ycXShR_0jf-SMSXEdVqxLRWuOw-_StG5BMjToiAl27CbHY4P92MPhlMblTOtTImE81-5dFdyDVydpBwmlfKM3OSQ39kulP9bbfw-2jhyegOL0AgqJTY_tj554oHCQFTbq0A0ZWukukmxL2yu6iy34XdzaJB26Igy-3UxGBMwFu53EhjKBweh7xyP2nDm57-wybndJMtSyTGDXH3vjBVclo1iup5yRP",
    "invalidate_token": true
  }
}
'

Query Parameters

invalidate_token · boolean

Token Invalidation: By default, all tokens created during the current session are invalidated when you call this method. You can control this behavior using this parameter:

• invalidate_token=true (default): All session tokens are invalidated, requiring re-authentication for new connections
• invalidate_token=false: Tokens remain valid, allowing you to reconnect using the same authentication

Response

200

Connection closed