Class O2WebSocket

WebSocket client for O2 Exchange real-time data streams.

Use via O2Client.streamDepth, O2Client.streamOrders, etc. for the simplest interface, or create a standalone instance for advanced use cases.

Example

import { O2WebSocket, TESTNET } from "@o2exchange/sdk";

const ws = new O2WebSocket({ config: TESTNET });
await ws.connect();
for await (const update of ws.streamDepth(marketId, "10")) {
  console.log(update);
}
ws.disconnect();

Index

Constructors

constructor

Methods

connect disconnect isConnected isTerminated streamBalances streamDepth streamLifecycle streamNonce streamOrders streamTrades unsubscribeBalances unsubscribeDepth unsubscribeNonce unsubscribeOrders unsubscribeTrades

Constructors

constructor

new O2WebSocket(options: O2WebSocketOptions): O2WebSocket
Parameters
- options: O2WebSocketOptions
Returns O2WebSocket
- Defined in src/websocket.ts:128

Methods

connect

connect(): Promise<void>
Connect to the WebSocket server.

Returns Promise<void>
- Defined in src/websocket.ts:139

disconnect

disconnect(): void
Disconnect from the WebSocket server.

Signals all active generators to stop before closing the connection, so consumers are unblocked immediately even if the close handshake is slow.

Returns void
- Defined in src/websocket.ts:201

isConnected

isConnected(): boolean
Check if connected.

Returns boolean
- Defined in src/websocket.ts:238

isTerminated

isTerminated(): boolean
Check if permanently terminated (max reconnect attempts exhausted or disconnected).

Returns boolean
- Defined in src/websocket.ts:243

streamBalances

streamBalances(identities: Identity[]): AsyncGenerator<BalanceUpdate>
Subscribe to balance updates. Returns an AsyncGenerator yielding BalanceUpdate messages.
Parameters
- identities: Identity[]
Returns AsyncGenerator<BalanceUpdate>
- Defined in src/websocket.ts:382

streamDepth

streamDepth(
marketId: string,
precision: DepthPrecision,
): AsyncGenerator<DepthUpdate>
Subscribe to order book depth updates.
Parameters
- marketId: string
  The market ID (hex string).
- precision: DepthPrecision
  A validated DepthPrecision created via depthPrecision(level) where level is 1–18. The high-level O2Client.streamDepth creates this automatically from a plain number.
Returns AsyncGenerator<DepthUpdate>
An async generator yielding DepthUpdate messages.
- Defined in src/websocket.ts:347

streamLifecycle

streamLifecycle(): AsyncGenerator<ConnectionEvent>
Stream WebSocket connection lifecycle events.

Yields ConnectionEvent objects whenever the connection state changes. Use this to detect reconnects and re-sync state from the REST API — messages received during the disconnect window are lost.

Returns AsyncGenerator<ConnectionEvent>
Example
```
for await (const event of ws.streamLifecycle()) {
  if (event.state === "reconnected") {
    const balances = await client.getBalances(account);
    // ... rebuild local state ...
  } else if (event.state === "closed") {
    break;
  }
}
```
- Defined in src/websocket.ts:268

streamNonce

streamNonce(identities: Identity[]): AsyncGenerator<NonceUpdate>
Subscribe to nonce updates. Returns an AsyncGenerator yielding NonceUpdate messages.
Parameters
- identities: Identity[]
Returns AsyncGenerator<NonceUpdate>
- Defined in src/websocket.ts:391

streamOrders

streamOrders(identities: Identity[]): AsyncGenerator<OrderUpdate>
Subscribe to order updates. Returns an AsyncGenerator yielding OrderUpdate messages.
Parameters
- identities: Identity[]
Returns AsyncGenerator<OrderUpdate>
- Defined in src/websocket.ts:364

streamTrades

streamTrades(marketId: string): AsyncGenerator<TradeUpdate>
Subscribe to trade updates. Returns an AsyncGenerator yielding TradeUpdate messages.
Parameters
- marketId: string
Returns AsyncGenerator<TradeUpdate>
- Defined in src/websocket.ts:373

unsubscribeBalances

unsubscribeBalances(identities: Identity[]): void
Unsubscribe from balance updates.
Parameters
- identities: Identity[]
Returns void
- Defined in src/websocket.ts:417

unsubscribeDepth

unsubscribeDepth(marketId: string): void
Unsubscribe from depth updates for a market.
Parameters
- marketId: string
Returns void
- Defined in src/websocket.ts:399

unsubscribeNonce

unsubscribeNonce(identities: Identity[]): void
Unsubscribe from nonce updates.
Parameters
- identities: Identity[]
Returns void
- Defined in src/websocket.ts:423

unsubscribeOrders

unsubscribeOrders(): void
Unsubscribe from order updates.

Returns void
- Defined in src/websocket.ts:405

unsubscribeTrades

unsubscribeTrades(marketId: string): void
Unsubscribe from trade updates for a market.
Parameters
- marketId: string
Returns void
- Defined in src/websocket.ts:411

Class O2WebSocket

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns O2WebSocket

Methods

connect

Returns Promise<void>

disconnect

Returns void

isConnected

Returns boolean

isTerminated

Returns boolean

streamBalances

Parameters

Returns AsyncGenerator<BalanceUpdate>

streamDepth

Parameters

Returns AsyncGenerator<DepthUpdate>

streamLifecycle

Returns AsyncGenerator<ConnectionEvent>

Example

streamNonce

Parameters

Returns AsyncGenerator<NonceUpdate>

streamOrders

Parameters

Returns AsyncGenerator<OrderUpdate>

streamTrades

Parameters

Returns AsyncGenerator<TradeUpdate>

unsubscribeBalances

Parameters

Returns void

unsubscribeDepth

Parameters

Returns void

unsubscribeNonce

Parameters

Returns void

unsubscribeOrders

Returns void

unsubscribeTrades

Parameters

Returns void

Settings

On This Page