List All Accounts for a User

List all accounts for a specific user

Attrbiute

Type

Definition

id

string

account identifier

accountNo

string

account number

accountType

object

object containing the details of the account type

accountType.name

string

name of the account type
PRACTICE
LIVE

accountType.description

string

description of the account type name

accountMgmtType

object

object containing the details of the account management type

accountMgmtType.name

string

name of account management type corresponds to Account Management Types

accountMgmtType.description

string

description of the account management type

status

object

object containing the details of the accounts status

status.name

string

current status of the accounts status corresponds to Account Statuses

status.description

string

description of the status

tradingType

object

object containing the details of the trading type

tradingType.name

string

accounts trading type, corresponds to Account Trading Types

tradingTypes.description

string

description of the trading type

leverage

number

current leverage associated with the account

nickname

string

nickname associated with the account

parentIB

object

object containing the details of the accounts referrer

parentIB.id

string

userID of the parentIB

parentIB.name

string

name of the parentIB

commissionID

string

commission identifier

userID

string

user identifier

restricted

boolean

restricted determines if the customer can trade with unsettled funds or not. Can be set by the partner on account creation, or set to due to GFV's or PDTs.

goodFaithViolations

number

running count of the number of good faith violations "GFV's"

patternDayTrades

number

running count of the number of pattern day trades customer has made

freeTradeBalance

number

legacy attribute no longer used. Kept for backwards compatibility

gfvPdtExempt

boolean

cannot be set by the Partner, only defined by DriveWealth

bod

object

object containing the details of the beginning of day account values. THESE WILL NOT CHANGE THROUGHOUT THE DAY

bod.moneyMarket

number

amount of money customer has in money market

bod.equityValue

number

total value of all held positions

bod.cashAvailableForWithdrawal

number

total amount of money customer can currently withdrawal from their account

bod.cashAvailableForTrade

number

total amount of money customer can currently trade with

bod.updatedWhen

string

timestamp of when the BOD was last updated

bod.cashBalance

number

total amount of money currently held by the customer

sweepInd

boolean

always set to true, this dictates customer funds are swept into money market or bank sweep

interestFree

boolean

dictates if interest is paid back to the customer or not

createdWhen

string

timestamp of when the account was created

openedWhen

string

timestamp of when the account was opened, different from the created when

Language
Authentication