Real-Time Data

WebSocket endpoint connection information

Retrieve connection details and protocol documentation for the real-time data WebSocket endpoint.

The WebSocket endpoint itself is at /api/v1/rt/ws and is not shown in the OpenAPI schema because WebSocket routes are not part of the OpenAPI specification. This endpoint provides the protocol documentation instead.

get/api/v1/rt/ws/info

Request

Response

WebSocket protocol documentation

urlstring required
protocolstring required
descriptionstring required
subscribe_messageobject required
unsubscribe_messageobject required
binary_formatstring required
json_formatobject required

Changes

No recorded changes to this operation across all 1 revision of this API.