> This page is for TWS API. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://ibkrcampus.com/docs/llms.txt. # Account Summary ## Introduction The initial invocation of `reqAccountSummary` will result in a list of all requested values being returned, and then every three minutes those values which have changed will be returned. The update frequency of 3 minutes is the same as the TWS Account Window and cannot be changed. --- ## Requesting Account Summary `EClient.reqAccountSummary(reqId, group, tags)` Requests a specific account's summary. This method will subscribe to the account summary as presented in the TWS' Account Summary tab. Customers can specify the data received by using a specific tags value. See the [Account Summary Tags](#account-summary-tags) section for available options. Alternatively, many languages offer the import of `AccountSummaryTags` with a method to retrieve all tag values. > **Warning** > > Only **two** active summary subscriptions are allowed at a time. **`reqId`** `int` The unique request identifier. --- **`group`** `string` Set to `"All"` to return account summary data for all accounts, or set to a specific Advisor Account Group name that has already been created in TWS Global Configuration. --- **`tags`** `string` A comma separated list with the [desired tags](#account-summary-tags). --- \ #### Python ```python self.reqAccountSummary(9001, "All", AccountSummaryTags.AllTags) ``` #### Java ```java client.reqAccountSummary(9001, "All", "AccountType,NetLiquidation,TotalCashValue,SettledCash,AccruedCash,BuyingPower,EquityWithLoanValue,PreviousEquityWithLoanValue,GrossPositionValue,ReqTEquity,ReqTMargin,SMA,InitMarginReq,MaintMarginReq,AvailableFunds,ExcessLiquidity,Cushion,FullInitMarginReq,FullMaintMarginReq,FullAvailableFunds,FullExcessLiquidity,LookAheadNextChange,LookAheadInitMarginReq ,LookAheadMaintMarginReq,LookAheadAvailableFunds,LookAheadExcessLiquidity,HighestSeverity,DayTradesRemaining,Leverage"); ``` #### C++ ```cpp m_pClient->reqAccountSummary(9001, "All", AccountSummaryTags::getAllTags()); ``` #### C\# ```csharp client.reqAccountSummary(9001, "All", AccountSummaryTags.GetAllTags()); ``` #### VB.NET ```vbnet client.reqAccountSummary(9001, "All", AccountSummaryTags.GetAllTags()) ``` --- ## Account Summary Tags | Tag | Description | | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | AccountType | Identifies the IB account structure | | NetLiquidation | The basis for determining the price of the assets in your account. Total cash value + stock value + options value + bond value | | TotalCashValue | Total cash balance recognized at the time of trade + futures PNL | | SettledCash | Cash recognized at the time of settlement – purchases at the time of trade – commissions – taxes – fees | | AccruedCash | Total accrued cash value of stock, commodities and securities | | BuyingPower | Buying power serves as a measurement of the dollar value of securities that one may purchase in a securities account without depositing additional funds | | EquityWithLoanValue | Forms the basis for determining whether a client has the necessary assets to either initiate or maintain security positions. Cash + stocks + bonds + mutual funds | | PreviousEquityWithLoanValue | Marginable Equity with Loan value as of 16:00 ET the previous day | | GrossPositionValue | The sum of the absolute value of all stock and equity option positions | | RegTEquity | Regulation T equity for universal account | | RegTMargin | Regulation T margin for universal account | | SMA | Special Memorandum Account: Line of credit created when the market value of securities in a Regulation T account increase in value | | InitMarginReq | Initial Margin requirement of whole portfolio | | MaintMarginReq | Maintenance Margin requirement of whole portfolio | | AvailableFunds | This value tells what you have available for trading | | ExcessLiquidity | This value shows your margin cushion, before liquidation | | Cushion | Excess liquidity as a percentage of net liquidation value | | FullInitMarginReq | Initial Margin of whole portfolio with no discounts or intraday credits | | FullMaintMarginReq | Maintenance Margin of whole portfolio with no discounts or intraday credits | | FullAvailableFunds | Available funds of whole portfolio with no discounts or intraday credits | | FullExcessLiquidity | Excess liquidity of whole portfolio with no discounts or intraday credits | | LookAheadNextChange | Time when look-ahead values take effect | | LookAheadInitMarginReq | Initial Margin requirement of whole portfolio as of next period's margin change | | LookAheadMaintMarginReq | Maintenance Margin requirement of whole portfolio as of next period's margin change | | LookAheadAvailableFunds | This value reflects your available funds at the next margin change | | LookAheadExcessLiquidity | This value reflects your excess liquidity at the next margin change | | HighestSeverity | A measure of how close the account is to liquidation | | DayTradesRemaining | The Number of Open/Close trades a user could put on before Pattern Day Trading is detected. A value of "-1" means that the user can put on unlimited day trades. | | Leverage | GrossPositionValue / NetLiquidation | | \$LEDGER | Single flag to relay all cash balance tags\*, only in base currency. | | \$LEDGER:CURRENCY | Single flag to relay all cash balance tags\*, only in the specified currency. | | \$LEDGER:ALL | Single flag to relay all cash balance tags\* in all currencies. | --- ## Receiving Account Summary ### EWrapper.accountSummary `EWrapper.accountSummary(reqId, account, tag, value, currency)` Receives the account information. This method will receive the account information just as it appears in the TWS' Account Summary Window. **`reqId`** `int` The request's unique identifier. --- **`account`** `string` The account id. --- **`tag`** `string` The account's attribute being received. --- **`value`** `string` The account's attribute's value. --- **`currency`** `string` The currency on which the value is expressed. --- \ #### Python ```python def accountSummary(self, reqId: int, account: str, tag: str, value: str,currency: str): print("AccountSummary. ReqId:", reqId, "Account:", account,"Tag: ", tag, "Value:", value, "Currency:", currency) ``` #### Java ```java @Override public void accountSummary(int reqId, String account, String tag, String value, String currency) { System.out.println(EWrapperMsgGenerator.accountSummary(reqId, account, tag, value, currency)); } ``` #### C++ ```cpp void TestCppClient::accountSummary( int reqId, const std::string& account, const std::string& tag, const std::string& value, const std::string& currency) { printf( "Acct Summary. ReqId: %d, Account: %s, Tag: %s, Value: %s, Currency: %s\n", reqId, account.c_str(), tag.c_str(), value.c_str(), currency.c_str()); } ``` #### C\# ```csharp public virtual void accountSummary(int reqId, string account, string tag, string value, string currency) { Console.WriteLine("Acct Summary. ReqId: " + reqId + ", Acct: " + account + ", Tag: " + tag + ", Value: " + value + ", Currency: " + currency); } ``` #### VB.NET ```vbnet Public Sub accountSummary(reqId As Integer, account As String, tag As String, value As String, currency As String) Implements IBApi.EWrapper.accountSummary Console.WriteLine("AccountSummary - ReqId [" & reqId & "] Account [" & account & "] Tag [" & tag & "] Value [" & value & "] Currency [" & currency & "]") End Sub ``` ### EWrapper.accountSummaryEnd `EWrapper.accountSummaryEnd(reqId)` Notifies when all the accounts' information has been received. **`reqId`** `string` The request's identifier. --- \ #### Python ```python def accountSummaryEnd(self, reqId: int): print("AccountSummaryEnd. ReqId:", reqId) ``` #### Java ```java @Override public void accountSummaryEnd(int reqId) { System.out.println("Account Summary End. Req Id: " + EWrapperMsgGenerator.accountSummaryEnd(reqId)); } ``` #### C++ ```cpp void TestCppClient::accountSummaryEnd( int reqId) { printf( "AccountSummaryEnd. Req Id: %d\n", reqId); } ``` #### C\# ```csharp public virtual void accountSummaryEnd(int reqId) { Console.WriteLine("AccountSummaryEnd. Req Id: "+reqId+"\n"); } ``` #### VB.NET ```vbnet Public Sub accountSummaryEnd(reqId As Integer) Implements IBApi.EWrapper.accountSummaryEnd Console.WriteLine("AccountSummaryEnd - ReqId [" & reqId & "]") End Sub ``` --- ## Cancel Account Summary `EClient.cancelAccountSummary(reqId)` Once the subscription to account summary is no longer needed, it can be cancelled via the `EClient.cancelAccountSummary` method. **`reqId`** `int` The identifier of the previously performed account request. --- \ #### Python ```python self.cancelAccountSummary(9001) ``` #### Java ```java client.cancelAccountSummary(9001); ``` #### C++ ```cpp m_pClient->cancelAccountSummary(9001); ``` #### C\# ```csharp client.cancelAccountSummary(9001); ``` #### VB.NET ```vbnet client.cancelAccountSummary(9001) ```