Accounts API

Overview

This API retrieves the current account balance and related details for a specified account.

Description

This API returns detailed balance information for a specified account for the current user. The information returned includes account type, option level, and details on up to four balances - account balance, margin account balance, day trade balance, and cash account balance.

HTTP Method: GET

Live URL

                    https://api.etrade.com/v1/accounts/{accountIdKey}/balance?instType={instType}&realTimeNAV=true
                

Sandbox URL

                    https://apisb.etrade.com/v1/accounts/{accountIdKey}/balance?instType={instType}&realTimeNAV=true
                

Request

Property Type Required? Description Allowable Values
accountType query no The registered account type AMMCHK, ARO, BCHK, BENFIRA, BENFROTHIRA, BENF_ESTATE_IRA, BENF_MINOR_IRA, BENF_ROTH_ESTATE_IRA, BENF_ROTH_MINOR_IRA, BENF_ROTH_TRUST_IRA, BENF_TRUST_IRA, BRKCD, BROKER, CASH, C_CORP, CONTRIBUTORY, COVERDELL_ESA, CONVERSION_ROTH_IRA, CREDITCARD, COMM_PROP, CONSERVATOR, CORPORATION, CSA, CUSTODIAL, DVP, ESTATE, EMPCHK, EMPMMCA, ETCHK, ETMMCHK, HEIL, HELOC, INDCHK, INDIVIDUAL, INDIVIDUAL_K, INVCLUB, INVCLUB_C_CORP, INVCLUB_LLC_C_CORP, INVCLUB_LLC_PARTNERSHIP, INVCLUB_LLC_S_CORP, INVCLUB_PARTNERSHIP, INVCLUB_S_CORP, INVCLUB_TRUST, IRA_ROLLOVER, JOINT, JTTEN, JTWROS, LLC_C_CORP, LLC_PARTNERSHIP, LLC_S_CORP, LLP, LLP_C_CORP, LLP_S_CORP, IRA, IRACD, MONEY_PURCHASE, MARGIN, MRCHK, MUTUAL_FUND, NONCUSTODIAL, NON_PROFIT, OTHER, PARTNER, PARTNERSHIP, PARTNERSHIP_C_CORP, PARTNERSHIP_S_CORP, PDT_ACCOUNT, PM_ACCOUNT, PREFCD, PREFIRACD, PROFIT_SHARING, PROPRIETARY, REGCD, ROTHIRA, ROTH_INDIVIDUAL_K, ROTH_IRA_MINORS, SARSEPIRA, S_CORP, SEPIRA, SIMPLE_IRA, TIC, TRD_IRA_MINORS, TRUST, VARCD, VARIRACD, INVALID
instType query yes The account institution type for which the balance or information is requested BROKERAGE
realTimeNAV query no Default is false. If true, fetches real time balance
accountIdKey path yes The unique account key. Retrievable by calling the List Accounts API.

Response

Status Code Reason Response Model Error Code
200 Successful operation. BalanceResponse
400 Invalid account. 7001
400 Invalid institution type. 7002
400 Please enter valid account key. 102
400 User does not have access on this account. 253
400 Account key does not belong to user. 100
Property Type Description Possible Values
accountId string The account ID for which the balance is requested
institutionType string The account institution type for which the balance or information is requested BROKERAGE, GLOBALTRADING, NONUS, STOCKPLAN, LENDING, HELOC, HEIL, ONTRACK, GENPACT, AUTO, AUTOLOAN, BETA, LOYALTY, SBASKET, CC_BALANCETRANSFER, GENPACT_LEAD, GANIS, MORTGAGE, EXTERNAL, FUTURES, VISA, RJO, WDBH, INVALID
asOfDate integer (int64) The effective date in UTC
accountType string The registered account type AMMCHK, ARO, BCHK, BENFIRA, BENFROTHIRA, BENF_ESTATE_IRA, BENF_MINOR_IRA, BENF_ROTH_ESTATE_IRA, BENF_ROTH_MINOR_IRA, BENF_ROTH_TRUST_IRA, BENF_TRUST_IRA, BRKCD, BROKER, CASH, C_CORP, CONTRIBUTORY, COVERDELL_ESA, CONVERSION_ROTH_IRA, COMM_PROP, CONSERVATOR, CORPORATION, CSA, CUSTODIAL, DVP, ESTATE, EMPCHK, EMPMMCA, ETCHK, ETMMCHK, HEIL, HELOC, INDCHK, INDIVIDUAL, INDIVIDUAL_K, INVCLUB, INVCLUB_C_CORP, INVCLUB_LLC_C_CORP, INVCLUB_LLC_PARTNERSHIP, INVCLUB_LLC_S_CORP, INVCLUB_PARTNERSHIP, INVCLUB_S_CORP, INVCLUB_TRUST, IRA_ROLLOVER, JOINT, JTTEN, JTWROS, LLC_C_CORP, LLC_PARTNERSHIP, LLC_S_CORP, LLP, LLP_C_CORP, LLP_S_CORP, IRA, IRACD, MONEY_PURCHASE, MARGIN, MRCHK, MUTUAL_FUND, NONCUSTODIAL, NON_PROFIT, OTHER, PARTNER, PARTNERSHIP, PARTNERSHIP_C_CORP, PARTNERSHIP_S_CORP, PDT_ACCOUNT, PM_ACCOUNT, PREFCD, PREFIRACD, PROFIT_SHARING, PROPRIETARY, REGCD, ROTHIRA, ROTH_INDIVIDUAL_K, ROTH_IRA_MINORS, SARSEPIRA, S_CORP, SEPIRA, SIMPLE_IRA, TIC, TRD_IRA_MINORS, TRUST, VARCD, VARIRACD, INVALID
optionLevel string The option approval level of the account, expressed as a level 1 through 4 value NO_OPTIONS, LEVEL_1, LEVEL_2, LEVEL_3, LEVEL_4
accountDescription string The description of the account
quoteMode integer (int32) The quote type indicator, either real-time or delayed
dayTraderStatus string The user's status as a day trader
accountMode string The account mode indicating the account's special privileges as a cash account, a margin account, and so on
accountDesc string The description of the account for which the balance is requested
openCalls array[OpenCalls] The open calls
cash Cash Designates that account is a cash account
margin Margin Designates that account is a margin account
lending Lending Designates that account is a lending account
computedBalance ComputedBalance Designates the computed balance of the account
Property Type Description Possible Values
fundsForOpenOrdersCash number The funds reserved for open orders
moneyMktBalance number The current cash balance of the money market or sweep deposit account
Property Type Description Possible Values
cashAvailableForInvestment number The cash available for investments
cashAvailableForWithdrawal number The cash available for withdrawal
totalAvailableForWithdrawal number The total amount available for withdrawal
netCash number The net cash balance
cashBalance number The current cash balance
settledCashForInvestment number The settled cash for investments
unSettledCashForInvestment number The unsettled cash for investments
fundsWithheldFromPurchasePower number The funds withheld from the purchasing power
fundsWithheldFromWithdrawal number The funds withheld from withdrawal
marginBuyingPower number The margin account buying power
cashBuyingPower number The cash account buying power
dtMarginBuyingPower number The day trader margin account buying power
dtCashBuyingPower number The day trader cash account buying power
marginBalance number The margin account balance
shortAdjustBalance number The short adjusted balance
regtEquity number The Regulation T equity
regtEquityPercent number The Regulation T equity percentage
accountBalance number The current account balance
openCalls OpenCalls The open calls
realTimeValues RealTimeValues The real time values
portfolioMargin PortfolioMargin The total margin for the portfolio
Property Type Description Possible Values
currentBalance number The current balance on lent funds
creditLine number The lent funds current credit line
outstandingBalance number The outstanding balance on the lent funds
minPaymentDue number The minimum balance due on the payback of the lent funds
amountPastDue number The amount past due on the payback of the lent funds
availableCredit number The available credit on the lent funds
ytdInterestPaid number The year-to-date interest paid on the lent funds
lastYtdInterestPaid number The last year-to-date interest paid on the lent funds
paymentDueDate integer (int64) The payment due date on the lent funds
lastPaymentReceivedDate integer (int64) The date of last payment received on the lent funds
paymentReceivedMtd number The month-to-date total of payments received on lent funds
Property Type Description Possible Values
dtCashOpenOrderReserve number The margin account cash open order reserve
dtMarginOpenOrderReserve number The margin account margin open order reserve
Property Type Description Possible Values
minEquityCall number The minimum equity call
fedCall number The federal call
cashCall number The cash call
houseCall number The house call
Property Type Description Possible Values
dtCashOpenOrderReserve number The margin account cash open order reserve
dtMarginOpenOrderReserve number The margin account margin open order reserve
liquidatingEquity number The liquidating equity
houseExcessEquity number The house excess equity
totalHouseRequirement number The total house requirement
excessEquityMinusRequirement number The excess equity minus the portfolio requirement
totalMarginRqmts number The total margin requirements
availExcessEquity number The available excess equity
excessEquity number The excess equity
openOrderReserve number The open order reserve
fundsOnHold number The funds on hold
Property Type Description Possible Values
totalAccountValue number The total account value
netMv number The net market value
netMvLong number The long net market value
netMvShort number The short net market value
totalLongValue number The total long value

Example

Request

https://api.etrade.com/v1/accounts/vsnhtF7d9jXxBy6HyaAC4vQ/balance?instType=BROKERAGE&accountType=CASH&realTimeNAV=true
                

Response

                    
<?xml version="1.0" encoding="UTF-8"?>
<BalanceResponse>
   <accountId>83564979</accountId>
   <accountType>PDT_ACCOUNT</accountType>
   <optionLevel>LEVEL_4</optionLevel>
   <accountDescription>KRITHH TT</accountDescription>
   <quoteMode>6</quoteMode>
   <dayTraderStatus>PDT_MIN_EQUITY_RES_1XK</dayTraderStatus>
   <accountMode>PDT ACCOUNT</accountMode>
   <Cash>
      <fundsForOpenOrdersCash>0</fundsForOpenOrdersCash>
      <moneyMktBalance>0</moneyMktBalance>
   </Cash>
   <Computed>
      <cashAvailableForInvestment>0</cashAvailableForInvestment>
      <netCash>93921.44</netCash>
      <cashBalance>93921.44</cashBalance>
      <settledCashForInvestment>0</settledCashForInvestment>
      <unSettledCashForInvestment>0</unSettledCashForInvestment>
      <fundsWithheldFromPurchasePower>0</fundsWithheldFromPurchasePower>
      <fundsWithheldFromWithdrawal>0</fundsWithheldFromWithdrawal>
      <marginBuyingPower>0</marginBuyingPower>
      <cashBuyingPower>93921.44</cashBuyingPower>
      <dtMarginBuyingPower>0</dtMarginBuyingPower>
      <dtCashBuyingPower>0</dtCashBuyingPower>
      <shortAdjustBalance>0</shortAdjustBalance>
      <regtEquity>0</regtEquity>
      <regtEquityPercent>0</regtEquityPercent>
      <accountBalance>0</accountBalance>
   </Computed>
   <Margin>
      <dtCashOpenOrderReserve>0</dtCashOpenOrderReserve>
      <dtMarginOpenOrderReserve>0</dtMarginOpenOrderReserve>
   </Margin>
</BalanceResponse>