DriveWealth Accounts API is one of 31 APIs that DriveWealth publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Account. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
9 operations
across 8 paths,
and defines 87 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 2 base URLs: https://bo-api.drivewealth.io/back-office, https://bo-api.drivewealth.net/back-office.
The identity and technical contract details declared by the specification.
orderID
string
A unique DriveWealth order identifier created when an order is placed.
taxLotID
string
A unique tax lot identifier.
restricted
boolean
If true, the account cannot trade on unsettled funds.
ordersObj
object
13 properties
accountNickname
string
A description or nickname for an account.
AccountRes
object
29 properties
accountManagementType
string
The type of account who has trading authority.
flaggedForACATS
boolean
True if the account is flagged for an Automated Customer Account Transfer (ACATS).
equityValue
number
The current total market value of the account's open equity positions.
commissionID
string
The unique identifier associated with a specific commission related to the account.
PositionLegs
object
7 properties
authorizedUser
object
2 properties
limitPrice
number
The price set for the limit order.
AccountFeatureMutualFunds
object
6 properties
performanceObj
object
9 properties
orderNo
string
A unique, human-readable DriveWealth order number.
instrumentID
string
A unique ID created by DriveWealth to identify a specific instrument.
patternDayTrader
boolean
True, when the account is designated as a Pattern Day Trader.
interestedPartyAuthorizedUser
object
6 properties
orderQuantity
number
The amount of the instrument in shares.
PerformanceRes
object
6 properties
transactionSumObj
object
19 properties
parentIBIDObject
object
2 properties
accountHolderTypeObject
object
2 properties
MoneyDetailsRes
object
6 properties
goodFaithViolations
number
The total number of good faith violations.
AccountDetails
array
A list of all the user's accounts at DriveWealth.
taxProfileObject
object
2 properties
equityPositionsObj
object
15 properties
leverage
number
The amount of leverage an account is allowed to trade with.
pdtRestricted
boolean
True, when the account is PDT restricted, and can only sell.
openedWhen
string
A timestamp of when the account was opened.
ignoreMarketHoursForTest
boolean
Can the account ignore market hours in the UAT environment?
marginObj
object
16 properties
AccountDetailRes
object
1 property
PositionLots
object
11 properties
MarginRes
object
5 properties
riaID
string
This is the parentIBID or userID of the registered investment advisor creating the re-balance run.
instrumentISIN
string
An International Securities Identification Number (ISIN) uniquely identifies a security. Its structure is defined in ISO 6166. ISINs are commonly used when an…
portfolioID
string
The unique identifier of a portfolio.
SummaryRes
object
5 properties
accountType
string
The type of account that has been created.
statusUpdatedBy
string
A free string, which can be UUID of Backoffice user or any other system which updated the status.
stopPrice
number
The stop price of a limit order.
UpdateAcctReq
object
13 properties
finra3210ComplianceEntity
string
The regulatory system that the account will be reported to.
statusChangeHistory
object
3 properties
patternDayTrades
number
The total number of pattern day trades.
interestFree
boolean
Is the interest generated from money market deposited back into account?
accountStatus
string
The current status of the user's account.
orderCumulativeQuantity
number
The amount of shares currently being transacted; larger orders may execute in chunks.
riaObject
object
2 properties
AccountFeatureEquities
object
Account features related to equities
6 properties
orderStatus
string
The current status of the order.
accountID
string
The user's unique account identifier.
instrumentType
string
The classification of the instrument.
buyingPowerOverride
boolean
True if the account is required to have sufficient buying power to enter a trade.
orderTypes
string
The type of the Order.
gfvPdtExempt
boolean
True if the account exempt from trading violations.
productID
string
The unique identifier associated with an RIA managed product.
Account
object
24 properties
lastActivityDate
string
The date indicating the last recorded activity of the account, across the partner's ecosystem. It's important to update this field regularly, as activity recen…
beneficiariesOption
boolean
True if the account has associated beneficiaries.
AccountReq
object
18 properties
4 required
note
string
A way to store a message/comment on the this object.
instrumentSymbol
stringnull
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.
freeTradeBalance
number
The total number of free trades left for the account.
currency
string
The name of the currency in abbreviation form.
bod
object
Beginning of day balances in the account.
5 properties
accountHolderType
string
A classification for the type of the account holder. US broker-dealers must utilize this field for CAIS compliance. If unset, a default value of I will be assu…
statusChangeReason
string
Change account status with reason
gfvRestricted
boolean
True, when the account cannot trade on unsettled funds.
accountNo
string
The user's unique account number, that is human readable.
sweepInd
boolean
Are the funds swept into a money market account?
accountFeatures
object
4 properties
userID
string
A unique identifier created for each User on DriveWealth's platform.
accountManagementTypeObject
object
2 properties
tradingType
string
The type of trading the account will participate in.
sideAbbreviated
string
The side of the order.
statusChangeReasonInternal
string
Reason for the account status change
AccountFeatureOptions
object
2 properties
interestedParty
object
2 properties
AccountPositionLots
object
3 properties
cashSettlementTime
object
2 properties
AccountFeatureFixedIncome
object
Account features related to Fixed Income
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs DriveWealth publishes across the network.