latestOpenAPI 3.1.02026-08-22181751733.6 KB

67f9f562c2c6

tradingAccounts

Summary Of Account Values

Provides a general overview of the account details such as balance values.

get/iserver/account/{accountId}/summary

Path parameters

accountIdstring required

Response

Provides a general overview of the account details such as balance values.

accountTypestring

Describes the unique account type. For standard individual accounts, an empty string is returned.

statusstring

If the account is currently non-tradeable, a status message will be dispalyed.

balancenumber double

Returns the total account balance.

SMAnumber double

Simple Moving Average of the account.

buyingPowernumber double

Total buying power available for the account.

availableFundsnumber double

The amount of equity you have available for trading. For both the Securities and Commodities segments, this is calculated as: Equity with Loan Value – Initial Margin.

excessLiquiditynumber double

The amount of cash in excess of the usual requirement in your account.

netLiquidationValuenumber double

The basis for determining the price of the assets in your account.

equityWithLoanValuenumber double

The basis for determining whether you have the necessary assets to either initiate or maintain security assets.

regTLoannumber double

The Federal Reserve Board regulation governing the amount of credit that broker dealers may extend to clients who borrow money to buy securities on margin.

securitiesGVPnumber double

Absolute value of the Long Stock Value + Short Stock Value + Long Option Value + Short Option Value + Fund Value.

totalCashValuenumber double

Cash recognized at the time of trade + futures P&L. This value reflects real-time currency positions, including:

  • Trades executed directly through the FX market.
  • Trades executed as a result of automatic IB conversions, which occur when you trade a product in a non-base currency.
  • Trades deliberately executed to close non-base currency positions using the FXCONV destination.
accruedInterestnumber double

Accrued interest is the interest accruing on a security since the previous coupon date. If a security is sold between two payment dates, the buyer usually compensates the seller for the interest accrued, either within the price or as a separate payment.

regTMarginnumber double

The initial margin requirements calculated under US Regulation T rules for both the securities and commodities segment of your account.

initialMarginnumber double

The available initial margin for the account.

maintenanceMarginnumber double

The available maintenance margin for the account.