Skip to main content
WSS
This stream is available on the optionsPositions subscription. It provides your open option positions with mark price, margin, and PnL.

​
Snapshot vs. Delta

The emitOptionsPositions request returns a snapshot via optionsPositions. Once subscribed, optionsPositionsDelta messages carry changed positions in the same shape. A delta has no clientRequestId — that is what distinguishes the live push from a snapshot response.

​
Closed Positions Arrive as flat

When a position is closed, the delta reports it with side flat and qty 0. This is the only message that tells you the position is gone.
Handle flat explicitly: remove the position from your book when you receive it. A client that only switches on long and short will ignore the message and keep showing a position it no longer holds — no further delta and no snapshot will ever correct it, because the snapshot omits closed positions entirely.
flat only ever appears on a delta. The emitOptionsPositions snapshot returns open positions only, so a closed position is simply absent from it. See Position Metrics for how value, notionalValue, unrealizedPnl, and breakEvenPrice are derived.
market
type:string
required

A specific market (e.g. BTC-USDT) or ALL.

expiration
type:string
required

Contract expiration, e.g. 24JUN26. Requires market; omit to match every expiration.

strike
type:string
required

Strike price, e.g. 62000. Requires expiration; omit to match every strike.

type
type:string
required

C (call) or P (put). Requires strike; omit to match both.

Sec-WebSocket-Protocol
type:httpApiKey

Supply as authorization#<JWT> during the WebSocket handshake.

Emit Options Positions
type:object
Positions Snapshot
type:object

Response to emitOptionsPositions.

Position Delta
type:object

Pushed whenever your positions change; carries changed positions in the same shape as the snapshot. A delta has no clientRequestId — that is what distinguishes the live push from a snapshot response. A closed position arrives with side flat and qty 0; this is the only message that tells you the position is gone.