--- title: "Retrieve Account Summary" method: GET path: "/accounts/{accountID}/summary" tags: ["Accounts"] deprecated: true --- # Retrieve Account Summary `GET /accounts/{accountID}/summary` ## Request - Base URL: `https://bo-api.drivewealth.io/back-office` - URL: `https://bo-api.drivewealth.io/back-office/accounts/{accountID}/summary` - Auth: HTTP bearer > **Deprecated.** Retrieves an Account Summary details by accountID. The full Account Summary API is now deprecated. Instead, use the individual APIs for retrieving the Account's Positions, Transactions, or Orders separately. ## Path parameters - `accountID` string, required: ![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==) The user's unique account identifier. ## Response `200` Retrieving Account Summary details by accountID was Successful. - SummaryRes - `accountSummary` object - `accountID` string: ![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==) The user's unique account identifier. - `accountNo` string: ![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==) The user's unique account number, that is human readable. - `tradingType` 'CASH' | 'MARGIN': The type of trading the account will participate in. - `lastUpdated` string: Time of last update. - `cash` Cash (unresolved $ref) - `margin` MarginObj - `marginRequirement` 0.5 | 1: Leverage amounts. 0.5 = 2:1 Leverage. 1 = 1:1 Leverage - `longMarketValue` number: A real-time dollar value of current holdings. - `debitBalance` number: Real-time dollar value of debt; positive dollar amount is a debit balance, negative dollar amount is a credit balance. - `equity` number: Real-time dollar value of equity; calculated as longMarketValue – debitBalance. - `equityFraction` number: Equity as a fraction of long market value; calculated as equity ÷ longMarketValue. - `equityRequired` number: Minimum equity required to stay above a HOUSE margin call. If the account is in a margin call this field will not appear here, but instead appear in the marginCall object. - `accruedInterest` number: Real-time dollar value of interest accrued on the account's margin debit balance that has not yet been billed. - `bodDTBP` number, nullable: Deprecated. The Day Trading Buying Power (DTBP) in dollars at the beginning of day. - `patternDayTrader` boolean: Deprecated. True when the account is designated as a Pattern Day Trader. - `restricted` boolean: Account becomes restricted (set to true) if equity is less than 50% of long market value (this is essentially a warning, at 30% the account will be in HOUSE margin call). - `daySMA` number: Current Special Memorandum Account (SMA) balance for the day; starts from the beginning-of-day SMA and is adjusted for deposits and withdrawals (dollar for dollar) and buys and sells (50% of trade value). - `rtExcessEquity` number: Deprecated. Equity in excess of equityRequired calculated in real time (more is good). When the Reg T calculation applies to the account, use maintenanceExcess instead. - `maintenanceExcess` number: Dollar amount of equity in excess of the account's maintenance margin requirement; calculated as equity minus the greater of the FINRA and house maintenance requirements. A negative value indicates a maintenance deficiency. - `effectiveSMA` number: The SMA amount actually available for buying power. When the Reg T calculation applies to the account, the lesser of daySMA and maintenanceExcess; otherwise, the lesser of daySMA and rtExcessEquity. - `noBuyingPowerReason` string: Indicates why the account currently has no buying power: MIN_MARGIN_EQUITY_NOT_MET (equity below $2,000 with a debit balance), EFFECTIVE_SMA_ZERO (effectiveSMA is $0), HOUSE_CALL or EXCHANGE_CALL (equityFraction below the house or exchange equity requirement), or RESTING_ORDERS_WILL_TRIGGER_HOUSE_MARGIN_CALL (filling resting orders at current prices would trigger a house margin call). - `marginCall` object: An open (unsatisfied) official margin call on the account, sourced from end-of-day processing. The calls array within this object can contain more than one call if multiple call types are open simultaneously; a call is removed once it is marked satisfied. - `restingOrders` number: Total dollar value committed in resting orders that reduces the effectiveSMA - `equity` object - `equityValue` number, double: The current total market value of the account's open equity positions. - `equityPositions` EquityPositionsObj[] - `symbol` string, nullable: The ticker symbol of the Instrument. Debt Instruments and Global Mutual Funds do not have symbols and are referred to buy their `instrumentID` or `ISIN`. - `instrumentID` string, uuid: A unique ID created by DriveWealth to identify a specific instrument. - `ISIN` string: An `International Securities Identification Number` (ISIN) uniquely identifies a security. Its structure is defined in ISO 6166. ISINs are commonly used when an Instrument does not have a `symbol`, such as Debt Instruments and Global Mutual Funds. - `instrumentType` 'EQUITY' | 'ALTERNATIVE_ASSET' | 'MUTUAL_FUND' | 'DEBT' | 'OPTION' | 'CRYPTO': The classification of the instrument. - `openQty` number: Quantity of shares owned by the account. - `costBasis` number: Cost basis of the position. - `marketValue` number: Current market value of the position. - `side` 'B': In this case, Side distinguishes the type of position. This will always return 'long'(B). - `priorClose` number: The prior closing price of the security. - `availableForTradingQty` number: The quantity of the security available for sale. - `avgPrice` number: The average price of the position. - `mktPrice` number: The current market price of the position. - `unrealizedPL` number: Unrealized profit and loss for position. - `unrealizedDayPLPercent` number: Unrealized day profit and loss for position in percent. - `unrealizedDayPL` number: Unrealized day profit and loss for position. - `orders` OrdersObj[]: An array of pending orders. - `orderID` string: A unique DriveWealth order identifier created when an order is placed. - `orderNo` string: A unique, human-readable DriveWealth order number. - `createdWhen` string - `symbol` string, nullable: The ticker symbol of the Instrument. Debt Instruments and Global Mutual Funds do not have symbols and are referred to buy their `instrumentID` or `ISIN`. - `cumQty` number: The amount of shares currently being transacted; larger orders may execute in chunks. - `orderStatus` 'NEW' | 'FILLED' | 'PARTIAL_FILL' | 'PENDING_CANCEL' | 'CANCELED' | 'REJECTED': The current status of the order. - `orderType` 'MARKET' | 'LIMIT' | 'STOP' | 'STOP_LIMIT' | 'MARKET_IF_TOUCHED': The type of the Order. - `orderQty` number: The amount of the instrument in shares. - `isoTimeRestingOrderExpires` string: The time when the limit order expires. - `limitPrice` number: The price set for the limit order. - `side` 'B' | 'S' | 'BUY_OPEN' | 'BUY_CLOSE' | 'SELL_OPEN' | 'SELL_CLOSE': The side of the order. - `orderCashAmt` number: The amount of cash requested for an order (fractional shares only). - `stopPrice` number: The stop price of a limit order. - `transactions` TransactionSumObj[]: An array of account transactions - `orderID` string: A unique DriveWealth order identifier created when an order is placed. - `orderNo` string: A unique, human-readable DriveWealth order number. - `createdWhen` string - `symbol` string, nullable: The ticker symbol of the Instrument. Debt Instruments and Global Mutual Funds do not have symbols and are referred to buy their `instrumentID` or `ISIN`. - `cumQty` number: The amount of shares currently being transacted; larger orders may execute in chunks. - `orderStatus` 'NEW' | 'FILLED' | 'PARTIAL_FILL' | 'PENDING_CANCEL' | 'CANCELED' | 'REJECTED': The current status of the order. - `orderType` 'MARKET' | 'LIMIT' | 'STOP' | 'STOP_LIMIT' | 'MARKET_IF_TOUCHED': The type of the Order. - `orderQty` number: The amount of the instrument in shares. - `isoTimeRestingOrderExpires` string: The time when the limit order expires. - `limitPrice` number: The price set for the limit order. - `side` 'B' | 'S' | 'BUY_OPEN' | 'BUY_CLOSE' | 'SELL_OPEN' | 'SELL_CLOSE': The side of the order. - `orderCashAmt` number: The amount of cash requested for an order (fractional shares only). - `stopPrice` number: The stop price of a limit order. - `realizedPL` number: Realized profit and loss for position. - `executedWhen` string: The time when the transaction was executed. - `updatedWhen` string: NEEDS DESCRIPTION - `updatedReason` string: A reason for the update. - `commissions` number: Commission for the transaction if applicable. - `commissionDesc` string: A short description about the commission. --- [API](https://skmtc.dev/drivewealth/apis/core-apis.md) - [All operations](https://skmtc.dev/drivewealth/apis/core-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/drivewealth/apis/core-apis/revisions/daf4a0d7b01a?raw)