public/set_heartbeat

Signals the WebSocket connection to send and request heartbeats. Heartbeats can be used to detect stale connections.

When heartbeats have been set up, the API server will send heartbeat messages and test_request messages. Your software should respond to test_request messages by sending a /api/v2/public/test request. If your software fails to do so, the API server will immediately close the connection. If your account is configured to cancel on disconnect, any orders opened over the connection will be cancelled.

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

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/public/set_heartbeat \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 9098,
  "method": "public/set_heartbeat",
  "params": {
    "interval": 30
  }
}
'

200

{
  "jsonrpc": "2.0",
  "id": 1569,
  "result": "ok"
}

Query Parameters

interval · number · required

The heartbeat interval in seconds, but not less than 10

Example:

30

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · enum<string> · required

Result of method execution. ok in case of success

Available options: ok

id · integer

The id that was sent in the request