Skip to main content

GetAccountSummary

Returns the live realized and unrealized P&L summary for a specific account. Required reading before any write operation that could affect risk.

PropertyValue
Required scopemcp:read
RiskNone. Read-only.
Side effectsNone.

When an agent should use it​

  • Before any order placement, cancel, flatten, or strategy deploy.
  • At the start of a pre-trade or pre-session risk brief.
  • After a position change to verify the new state.

When an agent should not use it​

  • For high-frequency state checks. Use GetWatermarks instead for daily extremes.

Parameters​

{ "account": "Sim101" }

Response shape​

{
  "account": "Sim101",
  "realized_pnl": 240.75,
  "unrealized_pnl": -55.00,
  "buying_power": 24500.00,
  "cash_value": 50000.00,
  "currency": "USD"
}

Field names follow NT8 account-summary conventions. Different brokers may expose additional keys.

Example user prompt​

Before I do anything, call GetAccountSummary for APEX1234 and GetWatermarks
for the same account. Tell me realized and unrealized P&L for the day and
how close I am to my daily loss room.

Example tool call​

{ "name": "GetAccountSummary", "arguments": { "account": "APEX1234" } }

Common errors​

SymptomLikely causeFix
account_not_foundTypo or disconnected account.Call ListAccounts first.
addon_disconnectedNT8 add-on side is down.Open NT8 and reconnect.

Safe workflow placement​

Required state read before any of: PlaceOrder, Change, Cancel*, Flatten*, Reverse*, DeployStrategy, StartStrategy.