Ping
Cloud-API and Go Gateway provide a WebSocket ping request that can be used to measure the latency from the endpoint and to keep the WebSocket connection alive.
REQUEST
Method: ping
Parameters: None
Examples
wscat -c wss://api.blxrbdn.com/ws --header "Authorization: <YOUR-AUTHORIZATION-HEADER>"
> {"id": 1, "method": "ping", "params": null}
< ......
wscat -c ws://127.0.0.1:28333/ws --header "Authorization: <YOUR-AUTHORIZATION-HEADER>"
> {"id": 1, "method": "ping", "params": null}
< ......
We assume that the Gateway IP is 127.0.0.1 with ws port 28333
RESPONSE
Result Fields
Result Field
Description
pong
The UTC time (in microsecond format) that WS server receives ping request.
Example
{
"jsonrpc": "2.0",
"id": "1",
"result": {
"pong": "2021-10-20 17:53:54.950292"
}
}
Last updated