Skip to main content
This stream provides your account balance, margin usage, and PnL. Issue an emitOptionsAccountSummary request to receive the current summary; this also subscribes you to ongoing optionsAccountSummary updates — there is no separate subscribe value.

Account Summary Request

Request

{
  "message": "emitOptionsAccountSummary",
  "content": {
    "clientRequestId": "4cc68b60-ed2d-42aa-a21e-cb5486f8fd1a"
  }
}
FieldTypeRequiredDescription
messagestringYesemitOptionsAccountSummary
content.clientRequestIdstringNoClient-generated UUID for correlation
The account summary spans your whole account — there is no market filter.

Response

{
  "resultType": "optionsAccountSummary",
  "data": {
    "accountBalance": "19611.7711628",
    "availableBalance": "10779.4531133985",
    "totalEquity": "19755.1769719",
    "marginUsed": "8975.7238585015",
    "initialMargin": "8975.7238585015",
    "initialMarginRatio": "0.4543479347853313",
    "maintenanceMargin": "1170.2238585015",
    "maintenanceMarginRatio": "0.0592363136086323",
    "withdrawableBalance": "10636.0473042985",
    "unrealizedPnl": "143.4058091",
    "pnl": "158.080282",
    "fees": "37.0449692",
    "volume": "13551.78",
    "statusCode": 200,
    "clientRequestId": "9bbfd749-1a4b-45d3-9b57-63472a3c5711"
  }
}
FieldTypeRequiredDescription
resultTypestringYesoptionsAccountSummary
data.accountBalancestringYesTotal account balance
data.availableBalancestringYesBalance available for new orders
data.totalEquitystringYesTotal account equity (account balance plus unrealized PnL)
data.marginUsedstringYesMargin currently in use
data.initialMarginstringYesInitial margin requirement across open positions
data.initialMarginRatiostringYesInitial margin as a fraction of total equity
data.maintenanceMarginstringYesMaintenance margin requirement across open positions
data.maintenanceMarginRatiostringYesMaintenance margin as a fraction of total equity
data.withdrawableBalancestringYesBalance available to withdraw
data.unrealizedPnlstringYesUnrealized PnL across open positions
data.pnlstringYesCumulative realized PnL
data.feesstringYesCumulative fees
data.volumestringYesCumulative traded volume
data.statusCodenumberYes200
data.clientRequestIdstringNoClient-generated UUID for correlation
After the initial response, optionsAccountSummary messages are pushed automatically as your balance, margin, and PnL change.