Portfolio Margin Pro WebSocket Market Streams

Schemas

pmProAccountUpdate

Pushed every 5 seconds with account asset status.

e

string · enum

Event Type

Enum values:

PM_PRO_ACCOUNT_UPDATE

E

integer · int64

Event Time

Example: 1564745798939

u

string

uniMMR level

Example: 1.99999999

eq

string

Account equity in USD

Example: 30.23416728

ae

string

Actual equity without collateral rate in USD

Example: 30.23416728

im

string

Total initial margin in USD

Example: 20.6783833

mm

string

Total maintenance margin in USD

Example: 15.11708371

avb

string

Total available balance in USD

Example: 3.98972738

vmw

string

Virtual maxWithdraw amount in USD

Example: 3.98972738

risklevelchange

e

string · enum

Event Type

Enum values:

riskLevelChange

E

integer · int64

Event Time

Example: 1587727187525

u

string

uniMMR level

Example: 1.99999999

s

string

Risk level: MARGIN_CALL, REDUCE_ONLY, FORCE_LIQUIDATION

Example: MARGIN_CALL

eq

string

Account equity in USD value

Example: 30.23416728

ae

string

Actual equity without collateral rate in USD value

Example: 30.23416728

m

string

Total maintenance margin in USD value

Example: 15.11708371

User Data Stream Events

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · e="PM_PRO_ACCOUNT_UPDATE"
	type = object · e="riskLevelChange"

Properties for PM_PRO_ACCOUNT_UPDATE:

Pushed every 5 seconds with account asset status.

e

string · enum

Event Type

Enum values:

PM_PRO_ACCOUNT_UPDATE

E

integer · int64

Event Time

Example: 1564745798939

u

string

uniMMR level

Example: 1.99999999

eq

string

Account equity in USD

Example: 30.23416728

ae

string

Actual equity without collateral rate in USD

Example: 30.23416728

im

string

Total initial margin in USD

Example: 20.6783833

mm

string

Total maintenance margin in USD

Example: 15.11708371

avb

string

Total available balance in USD

Example: 3.98972738

vmw

string

Virtual maxWithdraw amount in USD

Example: 3.98972738

pmProAccountUpdate

Pushed every 5 seconds with account asset status.

e

string · enum

Event Type

Enum values:

PM_PRO_ACCOUNT_UPDATE

E

integer · int64

Event Time

Example: 1564745798939

u

string

uniMMR level

Example: 1.99999999

eq

string

Account equity in USD

Example: 30.23416728

ae

string

Actual equity without collateral rate in USD

Example: 30.23416728

im

string

Total initial margin in USD

Example: 20.6783833

mm

string

Total maintenance margin in USD

Example: 15.11708371

avb

string

Total available balance in USD

Example: 3.98972738

vmw

string

Virtual maxWithdraw amount in USD

Example: 3.98972738

risklevelchange

e

string · enum

Event Type

Enum values:

riskLevelChange

E

integer · int64

Event Time

Example: 1587727187525

u

string

uniMMR level

Example: 1.99999999

s

string

Risk level: MARGIN_CALL, REDUCE_ONLY, FORCE_LIQUIDATION

Example: MARGIN_CALL

eq

string

Account equity in USD value

Example: 30.23416728

ae

string

Actual equity without collateral rate in USD value

Example: 30.23416728

m

string

Total maintenance margin in USD value

Example: 15.11708371

User Data Stream Events

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · e="PM_PRO_ACCOUNT_UPDATE"
	type = object · e="riskLevelChange"

Properties for PM_PRO_ACCOUNT_UPDATE:

Pushed every 5 seconds with account asset status.

e

string · enum

Event Type

Enum values:

PM_PRO_ACCOUNT_UPDATE

E

integer · int64

Event Time

Example: 1564745798939

u

string

uniMMR level

Example: 1.99999999

eq

string

Account equity in USD

Example: 30.23416728

ae

string

Actual equity without collateral rate in USD

Example: 30.23416728

im

string

Total initial margin in USD

Example: 20.6783833

mm

string

Total maintenance margin in USD

Example: 15.11708371

avb

string

Total available balance in USD

Example: 3.98972738

vmw

string

Virtual maxWithdraw amount in USD

Example: 3.98972738