Retrieve Account Margin

get https://bo-api.drivewealth.io/back-office/accounts/{accountID}/summary/margin

Retrieves Account Margin details by accountID.

Response

Response body

object

accountID

string

The user's unique account identifier.

accountNo

string

The user's unique account number, that is human readable.

tradingType

string

The type of trading the account will participate in.

CASH MARGIN

updated

string

Time of last update.

margin

object

marginRequirement

number

Leverage amounts. 0.5 = 2:1 Leverage. 1 = 1:1 Leverage

0.5 1

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 (HOUSE or EXCHANGE) this field will not appear here, but instead appear in the marginCall object.

accruedInterest

number

NEEDS DESCRIPTION

bodDTBP

number | null

The Day Trading Buying Power (DTBP) in dollars at the beginning of day.

patternDayTrader

boolean

NEEDS DESCRIPTION

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).

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 dollar value.

rtExcessEquity

number

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

effectiveSMA

number

The lower of margin.daySMA and margin.rtExcessEquity. This is risk protection for the user 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 user's 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.

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.

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

restingOrders

number

Total dollar value committed in resting orders that reduces the effectiveSMA

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://bo-api.drivewealth.io/back-office/accounts/accountID/summary/margin \
3
     --header 'accept: application/json' \
4
     --header 'dw-client-app-key: {{yourAppKey}}'


xxxxxxxxxx
24
 
1
{
2
  "accountID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759",
3
  "accountNo": "DWBG000052",
4
  "tradingType": "CASH",
5
  "updated": "2017-06-16T15:35:30.617Z",
6
  "margin": {
7
    "marginRequirement": 1,
8
    "longMarketValue": 0,
9
    "debitBalance": 0,
10
    "equity": 0,
11
    "equityFraction": 0,
12
    "equityRequired": 1,
13
    "accruedInterest": 0,
14
    "bodDTBP": 10000,
15
    "patternDayTrader": false,
16
    "restricted": false,
17
    "daySMA": 0,
18
    "rtExcessEquity": 0,
19
    "effectiveSMA": 0,
20
    "noBuyingPowerReason": null,
21
    "marginCall": {},
22
    "restingOrders": 0
23
  }
24
}

200Retrieving an Account Margin details by accountID was Successful.