Account Summary

Get account details for a particular account.

❗️

Separate Endpoints Also Available

The Account Summary provides a combination of cash, order, transaction, and position details. For latency purposes, primarily utilize the endpoints that offer these data points, and limit usage of Account Summary to situations where all of these data points are needed.

Results Explained

Attribute

Type

Description

accountID

string

Account ID

accountNo

string

Account number.

tradingType

string

Type of Account. Options:

  • "CASH" - Cash
  • "MARGIN" - Margin

lastUpdated

string

Time of last update.

cash

object

Object of cash available in the account.

cash.cashAvailableForTrade

number

Cash amount available for trading (aka buying power).

cash.cashAvailableForWithdrawal

number

Cash amount available for withdrawal.

cash.cashBalance

number

Current overall cash balance.

cash.cashSettlement

array

Array of objects that contain T+2 dates and the cash settling on each day.

cash.cashSettlement.utcTime

string

Time that cash is settling from a purchase or a sale.

cash.cashSettlement.cash

number

Amount of cash settling on a particular day.

margin

object

Object of margin calculations

margin.marginRequirement

number

Options:

  • 0.5 (2:1 leverage)
  • 1 (1:1 leverage)

margin.longMarketValue

number

Long market value - real-time $ value of current holdings

margin.debitBalance

number

Real-time $ value of debt; positive $ is a debit balance, negative $ is a credit balance

margin.equity

number

Real-time $ value of equity; calculated as longMarketValuedebitBalance

margin.equityFraction

number

Equity as a fraction of long market value; calculated as equity ÷ longMarketValue

margin.equityRequired

number

Minimum equity required to stay above a HOUSE margin call. If the account is in a margin call (HOUSE or EXCHANGE) this field will not appear here, but instead appear in the marginCall object

margin.restricted

boolean

Account becomes restricted (set to true) if equity is less than 50% of long market value (this is essentially a warning, at 35% the account will be in HOUSE margin call)

margin.daySMA

number

Current SMA using traditional calculations – Start with beginning of day SMA and update with deposits and withdrawals as well as stock buys and sells during the day. Deposits increase and withdrawals decrease SMA dollar for dollar. Buys increase and sells decrease SMA by 50% of trade $ value

margin.rtExcessEquity

number

Equity in excess of equityRequired calculated in real time (more is good)

margin.effectiveSMA

number

The lower of margin.daySMA and margin.rtExcessEquity. This is risk protection for the customer as well as DriveWealth. Using only margin.daySMA for lending on margin has the disadvantage that the SMA can become inflated if the market drops from start of day. If customers were to use their entire daySMA to buy stock on a day when the market drops, they are immediately placed into a HOUSE CALL. The margin.rtExcessEquity prevents that from happening by lending them only a (reduced) amount that would place them above a HOUSE margin call. That is the risk protection provided to both parties

margin.noBuyingPowerReason

string

Reason indicating why the user has no buying power:

  • MIN_MARGIN_EQUITY_NOT_MET - margin.equity is less than $2,000 and margin.debitBalance is greater than $0
  • EFFECTIVE_SMA_ZERO - SMA is $0
  • HOUSE_CALL - margin.equityfFaction is less than 35% (required house equity)
  • EXCHANGE_CALL - margin.equityfFaction is less than 25% (required exchange equity)
  • RESTING_ORDERS_WILL_TRIGGER_HOUSE_MARGIN_CALL - Market dropped after resting orders were placed, and will trigger house call if filled

margin.marginCall

object

Object of margin call calculations. Will only appear if noBuyingPowerReason is equal to MIN_MARGIN_EQUITY_NOT_MET or HOUSE_CALL or EXCHANGE_CALL

margin.marginCall.marginCallType

string

Options:

  • "EQUITY"
  • "HOUSE"
  • "EXCHANGE"

margin.marginCall.marginCallTriggerType

string

Options:

  • "ACCT_MAINT"

margin.marginCall.equityRequired

number

Minimum required equity to bring the account above a house margin call

margin.marginCall.callAmount

number

Minimum $ amount to be deposited in the account to bring the account above a house margin or equity call

margin. restingOrders

numbers

Total $ value committed in resting orders that reduces the effectiveSMA

equity

array

Array of position in the account.

equity.equityValue

number

Current total market value of the account's open positions.

equity.equityPositions

array

Array of current positions.

equity.equityPositions.symbol

Instrument symbol.

equity.equityPositions.instrumentID

string

Instrument ID.

equity.equityPositions.openQty

number

Quantity of shares owned.

equity.equityPositions.costBasis

number

Cost basis of position.

equity.equityPositions.marketValue

number

Current market value of position.

equity.equityPositions.side

string

Side of position: "B" - Buy or "S" - Sell.

equity.equityPositions.priorClose

number

Prior close price for this instrument.

equity.equityPositions.availableForTradingQty

number

Quantity available for sale.

equity.equityPositions.avgPrice

number

Average price of position.

equity.equityPositions.mktPrice

number

Current market price of position.

equity.equityPositions.unrealizedPL

number

Unrealized profit and loss for position.

equity.equityPositions.unrealizedDayPLPercent

number

Unrealized day profit and loss for position in percent.

equity.equityPositions.unrealizedDayPL

number

Unrealized day profit and loss for position.

orders

array

Array of resting orders.

orders.orderID

string

Order ID.

orders.orderNo

string

Order number.

orders.createdWhen

string

Timestamp of when order was created.

orders.symbol

string

Ticker symbol for order.

orders.cumQty

number

Cumulative quantity of shares filled.

orders.orderStatus

string

Order status. Options:

  • "0" - New
  • "1" - Partial Fill
  • "2" - Fill
  • "4" - Canceled
  • "6" - Pending Cancel
  • "8" - Rejected

orders.orderType

string

Order type. Options:

  • "1" - Market
  • "2" - Limit
  • "3" - Stop

orders.orderQty

number

Quantity of shares requested up to 4 decimal places

orders.orderCashAmt

number

Amount of cash requested for an order (fractional shares only).

orders.avgPrice

number

Average price.

orders.side

string

Side of position. Options:

  • "B" - Buy
  • "S" - Sell

orders.isoTimeRestingOrderExpires

string

Expiration of order (limits only).

orders.limitPrice

number

Limit price entered (limits only).

orders.stopPrice

number

Stop price entered (stops only).

transactions

array

Array of user's transactions.

transactions.orderID

string

Order ID.

transactions.orderNo

string

Order number.

transactions.symbol

string

Ticker symbol for order.

transactions.cumQty

number

Cumulative quantity of shares filled.

transactions.orderStatus

string

Order status: Options:

  • "0" - New
  • "1" - Partial Fill
  • "2" - Fill
  • "4" - Canceled
  • "8" - Rejected

transactions.orderType

string

Order type. Options:

  • "1" - Market
  • "2" - Limit
  • "3" - Stop

transactions.orderQty

number

Quantity of shares requested.

transactions.orderCashAmt

number

Amount of cash requested for an order (fractional shares only).

transactions.side

string

Side of position. Options:

  • "B" - Buy
  • "S" - Sell

transactions.createdWhen

string

Timestamp of when order was created.

transactions.updatedReason

string

Reason for update of order. For rejected orders see Common Order Gateway Error Codes for rejected reason.

transactions.commission

number

Commission for transaction (if applicable)

transactions.executedWhen

string

Timestamp of when order was executed (if applicable).

transactions.isoTimeRestingOrderExpires

string

Expiration of order (limits only).

transactions.limitPrice

number

Limit price entered (limits only).

transactions.stopPrice

number

Stop price entered (stops only).

transactions.cancelledWhen

string

Timestamp when order was canceled (if applicable).

📘

Additional Margin Information

🚧

Transaction and order information embedded in the account summary response are only available for 24 hours.

Language
Authentication