API ReferenceWebSocket API
Market Stream
Live price ticks over WebSocket.
Alpha Version
The Ostium Builder Service is in Alpha. API endpoints, specifications, and builder URLs may change without notice. Use with caution in production environments.
Endpoint
ws(s)://<host>/v1/market/stream
Tick Payload
Messages are raw JSON ticks:
{
"feed_id": "BTC-USD",
"bid": 42495.1,
"mid": 42500.2,
"ask": 42505.3,
"isMarketOpen": true,
"isDayTradingClosed": false,
"secondsToToggleIsDayTradingClosed": 0,
"from": "USD",
"to": "BTC",
"timestampSeconds": 1738080000
}Error Messages
If the upstream stream disconnects or is misconfigured, the service may emit an error message such as:
{ "type": "error", "message": "Upstream disconnected" }Notes
- The stream is a direct proxy of live market data.
- No authentication is required.