Skip to main content

Open the WebSocket connection (HTTP/1.1 Upgrade).

GET 
/v1/ws

The Edge service speaks a small subscription-based protocol over WebSocket. The HTTP verb is GET with the standard Upgrade: websocket headers; after the upgrade, client and server exchange JSON frames.

See docs/exchange/api/services/websockets.md for the protocol (subscribe/unsubscribe/ping operations) and the complete list of channels (orderbook_delta, trade, candles, mark, market_lifecycle, fill, account).

Bearer authentication on the Upgrade request is optional but required for private channels (fill, account). Anonymous connections may subscribe to public channels only.

This OpenAPI operation exists for codegen visibility; the wire-frame schemas are not modelled in OpenAPI itself (consider AsyncAPI for that).

Request​

Responses​

Protocol switched to WebSocket. From here, exchange JSON frames per the protocol in docs/exchange/api/services/websockets.md.