2.6 KiB
2.6 KiB
Documentation Index
Fetch the complete documentation index at: https://docs.polymarket.com/llms.txt Use this file to discover all available pages before exploring further.
Real Time Data Socket
Overview
The Polymarket Real-Time Data Socket (RTDS) is a WebSocket-based streaming service that provides real-time updates for comments and crypto prices.
Official RTDS TypeScript client (`real-time-data-client`).Connection Details
- WebSocket URL:
wss://ws-live-data.polymarket.com - Protocol: WebSocket
- Data Format: JSON
Authentication
Some user-specific streams may require gamma_auth:
address: User wallet address
Connection Management
The WebSocket connection supports:
- Dynamic Subscriptions: Without disconnecting from the socket users can add, remove and modify topics and filters they are subscribed to.
- Ping/Pong: You should send PING messages (every 5 seconds ideally) to maintain connection
Available Subscription Types
Only the subscription types documented below are supported.
The RTDS currently supports the following subscription types:
- Crypto Prices - Real-time cryptocurrency price updates
- Comments - Comment-related events including reactions
Message Structure
All messages received from the WebSocket follow this structure:
{
"topic": "string",
"type": "string",
"timestamp": "number",
"payload": "object"
}
topic: The subscription topic (e.g., "crypto_prices", "comments")type: The message type/event (e.g., "update", "reaction_created")timestamp: Unix timestamp in millisecondspayload: Event-specific data object
Subscription Management
Subscribe to Topics
To subscribe to data streams, send a JSON message with this structure:
{
"action": "subscribe",
"subscriptions": [
{
"topic": "topic_name",
"type": "message_type",
"filters": "optional_filter_string",
"gamma_auth": {
"address": "wallet_address"
}
}
]
}
Unsubscribe from Topics
To unsubscribe from data streams, send a similar message with "action": "unsubscribe".
Error Handling
- Connection errors will trigger automatic reconnection attempts
- Invalid subscription messages may result in connection closure
- Authentication failures will prevent successful subscription to protected topics