Options WebSocket Market Streams

Schemas

accountUpdate

e

string · enum

Event Type

Enum values:

ACCOUNT_UPDATE

E

integer · int64

Event Time

Example: 1762914568643

T

integer · int64

Transaction Time

Example: 1762914568619

eq

string

Account equity in USDT

Example: 10000371.61462086

aeq

string

Account adjusted equity in USDT

Example: 10000475.51032086

b

string

Account wallet balance in USDT

Example: 10000475.51032086

m

string

Position value

Example: -103.89570000

u

string

Unrealized PnL

Example: 16.10430000

i

string

Initial margin in USDT

Example: 32354.38562539

M

string

Maintenance margin in USDT

Example: 6089.28766956

balancePositionUpdate

e

string · enum

Event Type

Enum values:

BALANCE_POSITION_UPDATE

E

integer · int64

Event Time

Example: 1762917544216

T

integer · int64

Transaction Time

Example: 1762917544206

m

string · enum

Event reason type

Enum values:

DEPOSIT

WITHDRAW

ORDER

Example: ORDER

object[]

Balances

object[]

Positions

greekUpdate

e

string · enum

Event Type

Enum values:

GREEK_UPDATE

E

integer · int64

Event Time

Example: 1762917544216

T

integer · int64

Transaction Time

Example: 1762917544216

object[]

listenKeyExpired

e

string · enum

Event Type

Enum values:

listenKeyExpired

E

string

Event Time

Example: 1736996475556

listenKey

string

Example: WsCMN0a4KHUPTQuX6IUnqEZfB1inxmv1qR4kbf1LuEjur5VdbzqvyxqG9TSjVVxv

orderTradeUpdate

e

string · enum

Event Type

Enum values:

ORDER_TRADE_UPDATE

E

integer · int64

Event Time

Example: 1568879465651

T

integer · int64

Transaction Time

Example: 1568879465650

object

riskLevelChange

e

string · enum

Event Type

Enum values:

RISK_LEVEL_CHANGE

E

integer · int64

Event Time

Example: 1587727187525

s

string · enum

Risk level. This feature only applies to VIP and Market Maker accounts. Risk level is re-evaluated on: funds transfer, trade fill, option expiry.

Enum values:

NORMAL

REDUCE_ONLY

Example: REDUCE_ONLY

mb

string

Margin balance

Example: 1534.11708371

mm

string

Maintenance margin

Example: 254789.11708371

User Data Stream Events

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · e="ACCOUNT_UPDATE"
	type = object · e="BALANCE_POSITION_UPDATE"
	type = object · e="GREEK_UPDATE"
	type = object · e="listenKeyExpired"
	type = object · e="ORDER_TRADE_UPDATE"
	type = object · e="RISK_LEVEL_CHANGE"

Properties for ACCOUNT_UPDATE:

e

string · enum

Event Type

Enum values:

ACCOUNT_UPDATE

E

integer · int64

Event Time

Example: 1762914568643

T

integer · int64

Transaction Time

Example: 1762914568619

eq

string

Account equity in USDT

Example: 10000371.61462086

aeq

string

Account adjusted equity in USDT

Example: 10000475.51032086

b

string

Account wallet balance in USDT

Example: 10000475.51032086

m

string

Position value

Example: -103.89570000

u

string

Unrealized PnL

Example: 16.10430000

i

string

Initial margin in USDT

Example: 32354.38562539

M

string

Maintenance margin in USDT

Example: 6089.28766956

accountUpdate

e

string · enum

Event Type

Enum values:

ACCOUNT_UPDATE

E

integer · int64

Event Time

Example: 1762914568643

T

integer · int64

Transaction Time

Example: 1762914568619

eq

string

Account equity in USDT

Example: 10000371.61462086

aeq

string

Account adjusted equity in USDT

Example: 10000475.51032086

b

string

Account wallet balance in USDT

Example: 10000475.51032086

m

string

Position value

Example: -103.89570000

u

string

Unrealized PnL

Example: 16.10430000

i

string

Initial margin in USDT

Example: 32354.38562539

M

string

Maintenance margin in USDT

Example: 6089.28766956

balancePositionUpdate

e

string · enum

Event Type

Enum values:

BALANCE_POSITION_UPDATE

E

integer · int64

Event Time

Example: 1762917544216

T

integer · int64

Transaction Time

Example: 1762917544206

m

string · enum

Event reason type

Enum values:

DEPOSIT

WITHDRAW

ORDER

Example: ORDER

object[]

Balances

object[]

Positions

riskLevelChange

e

string · enum

Event Type

Enum values:

RISK_LEVEL_CHANGE

E

integer · int64

Event Time

Example: 1587727187525

s

string · enum

Risk level. This feature only applies to VIP and Market Maker accounts. Risk level is re-evaluated on: funds transfer, trade fill, option expiry.

Enum values:

NORMAL

REDUCE_ONLY

Example: REDUCE_ONLY

mb

string

Margin balance

Example: 1534.11708371

mm

string

Maintenance margin

Example: 254789.11708371

User Data Stream Events

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · e="ACCOUNT_UPDATE"
	type = object · e="BALANCE_POSITION_UPDATE"
	type = object · e="GREEK_UPDATE"
	type = object · e="listenKeyExpired"
	type = object · e="ORDER_TRADE_UPDATE"
	type = object · e="RISK_LEVEL_CHANGE"

Properties for ACCOUNT_UPDATE:

e

string · enum

Event Type

Enum values:

ACCOUNT_UPDATE

E

integer · int64

Event Time

Example: 1762914568643

T

integer · int64

Transaction Time

Example: 1762914568619

eq

string

Account equity in USDT

Example: 10000371.61462086

aeq

string

Account adjusted equity in USDT

Example: 10000475.51032086

b

string

Account wallet balance in USDT

Example: 10000475.51032086

m

string

Position value

Example: -103.89570000

u

string

Unrealized PnL

Example: 16.10430000

i

string

Initial margin in USDT

Example: 32354.38562539

M

string

Maintenance margin in USDT

Example: 6089.28766956