WebSocket
WebSocket Stream (Documentation Only)
Real-time market data streaming via WebSocket with channel subscriptions.
Connection
wss://api.hyperprop.com/md/ws/stream?token=JWT_TOKEN
Available Channels
ticker- Real-time trade pricesohlc- Real-time OHLC/candlestick barsorderbook- Best bid/ask updateslevel2- Level 2 depth (top 10 levels)
Client Messages (send to server)
Subscribe to a channel
{
"action": "subscribe",
"channel": "ticker",
"symbols": ["ES", "NQ"]
}
Unsubscribe from a channel
{ "action": "unsubscribe", "channel": "ticker" }
Ping (keepalive)
{ "action": "ping" }
Server Messages
Welcome (on connect)
{
"type": "Welcome",
"message": "Connected to Hyperprop Market Data WebSocket",
"authenticated": true,
"user_id": "uuid",
"available_channels": ["ticker", "ohlc", "orderbook", "level2"],
"entitlements": { "products": ["CME", "NYMEX"], "user_type": "non_professional" }
}
Subscribed (confirmation)
{ "type": "Subscribed", "channel": "ticker", "symbols": ["ES", "NQ"] }
Price (ticker channel)
{
"type": "Price",
"channel": "ticker",
"data": { "symbol": "ES", "contract": "ESH6", "price": 6010250000000, "size": 5, "side": "B" }
}
Bar (ohlc channel)
{
"type": "Bar",
"channel": "ohlc",
"data": { "symbol": "ES", "contract": "ESH6", "open": 6010000000000, "high": 6012500000000, "low": 6008750000000, "close": 6011250000000, "volume": 1234, "interval": 60 }
}
Pong (response to ping)
{ "type": "Pong", "timestamp": 1705123456000 }
Error
{ "type": "Error", "message": "Authentication required", "code": "AUTH_REQUIRED" }
Error Codes
| Code | Description |
|---|---|
AUTH_REQUIRED | No JWT token or invalid token |
ENTITLEMENT_DENIED | User not entitled to CME data |
INVALID_CHANNEL | Unknown channel name |
GET
WebSocket Stream (Documentation Only)
Query Parameters
JWT authentication token
Response
WebSocket upgrade successful
Related topics
Real-time event stream (WebSocket)Rate limits & quotasReal-time WebSocket for trading eventsPartner integrationsIntroduction