Account summary
get_account_summaryRetrieve key account balances—net liquidation, cash, buying power, and margin—for an Interactive Brokers account. Get headline figures or specific summary tags.
Instructions
Return an account's headline balances: net liquidation, cash, buying power, margin.
Headline fields (in `base_currency`): net_liquidation, total_cash_value, settled_cash,
buying_power, available_funds, excess_liquidity, equity_with_loan_value,
gross_position_value, init/maint margin requirement, sma, cushion (fraction), leverage
and day_trades_remaining (-1 = unlimited). `values` holds every summary row,
including per-currency ledger rows (CashBalance, UnrealizedPnL... with currency BASE
for converted totals). IBKR refreshes the summary about every 3 minutes, and right
after trades. No market-data subscription needed.
Errors: invalid_request lists the valid tags when a tag is unknown.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tags | No | Only return these tags in `values`, e.g. ['NetLiquidation', 'BuyingPower']. Omit for every row. The headline fields are always filled. | |
| account | No | IBKR account id, e.g. DU1234567. Omit to use the default account; list_accounts shows which accounts are allowed. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sma | No | Special memorandum account (Reg T). | |
| as_of | Yes | When this server read the values (UTC). | |
| values | No | Every summary row (or the ones matching tags), including per-currency rows. | |
| account | Yes | ||
| cushion | No | Excess liquidity / net liquidation, as a fraction (0.25 = 25%). | |
| leverage | No | Gross position value / net liquidation. | |
| buying_power | No | What can be bought on margin now. | |
| settled_cash | No | Settled cash (cash accounts). | |
| base_currency | No | Currency the headline amounts are in. | |
| available_funds | No | Equity with loan value minus initial margin. | |
| init_margin_req | No | Initial margin requirement. | |
| net_liquidation | No | Total account value (equity). | |
| excess_liquidity | No | Equity with loan value minus maintenance margin; <0 risks liquidation. | |
| maint_margin_req | No | Maintenance margin requirement. | |
| total_cash_value | No | Cash, including unsettled. | |
| day_trades_remaining | No | Day trades left under the pattern-day-trader rule; -1 means unlimited. | |
| gross_position_value | No | Absolute market value of all positions. | |
| equity_with_loan_value | No |