Last updated
Edit

ping

[Source]

The ping command returns an acknowledgement, so that clients can test the connection status and latency.

Request Format

An example of the request format:

  1. WebSocket
  2. JSON-RPC
  3. Commandline
{
    "id": 1,
    "command": "ping"
}

Try it! >

The request includes no parameters.

Response Format

An example of a successful response:

  1. WebSocket
  2. JSON-RPC
{
    "id": 1,
    "result": {},
    "status": "success",
    "type": "response"
}

The response follows the standard format, with a successful result containing no fields. The client can measure the round-trip time from request to response as latency.

Possible Errors