Websocket Connection Config

Overview

The Websocket Connection Config endpoint provides the necessary configuration details for connecting a WebSocket client to the ProphetX service. This endpoint is essential for establishing a stable and secure WebSocket connection, allowing clients to receive real-time updates and notifications.

Endpoint Details

Endpoint: /partner/websocket/connection-config
Method: GET
Security: Requires a valid Bearer token for authentication.

Description

This endpoint returns the connection configuration required for WebSocket clients to connect to the ProphetX service. The configuration includes details such as the application ID, cluster, and key, which are used to authenticate and establish a connection with the WebSocket service powered by Pusher.

Use Cases

Real-Time Updates: Clients can subscribe to various channels to receive real-time updates on sports events, market liquidity, and play status.
Order Book Construction: By subscribing to specific channels, clients can construct and maintain an accurate order book.
Risk Management: Receive updates on matched plays to manage risk and exposure effectively.

Response

200 OK: Returns the connection configuration in JSON format.
400 Bad Request: Indicates a problem with the request parameters.
500 Internal Server Error: Indicates a server-side error.

Example Response

{
  "app_id": "your_app_id",
  "cluster": "your_cluster",
  "key": "your_key",
  "service": "pusher"
}

Additional Information

For more details on WebSocket events and use cases, refer to the ProphetX Service API WebSocket Use Cases and WebSocket Events documentation.