How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

DriveWealth Orders API

The Orders API from DriveWealth — 6 operation(s) for orders.

DriveWealth Orders API is one of 31 APIs that DriveWealth publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 6 paths, and defines 60 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.

7 operations 6 paths 60 schemas 5 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.drivewealth.net
Authentication
HTTP Bearer, API Key, API Key
Resource Areas
1

Authentication & Security 3

DriveWealth Orders API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as dw-client-app-key (dwAppKey). An API key is passed in the header as dw-auth-token (sessionToken).

Paths & Operations 7

Across 6 paths, the API surfaces 7 operations — 5 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Orders 7
GET
/accounts/{accountID}/summary/orders
List Account resting Orders
1 param → 200
GET
/accounts/{accountID}/reports/order-history
List Account historical Orders
6 params → 200
POST
/orders
Create Order
body → 200400403
GET
/orders/{orderID}
Retrieve Order
1 param → 200
PATCH
/orders/{orderID}
Update Order
1 param body → 200
GET
/orders/byOrderNo/{orderNo}
Retrieve Order by Order Number
1 param → 200
GET
/orders/{orderID}/audit
Retrieve Order Audit Details
1 param → 200

Schemas 60

The contract defines 60 schemas that model the data the API accepts and returns. The most detailed are OrderStatusResponse (32 properties), CreateOrderRequest (27 properties), OrderAuditResponse (23 properties), auditLog (9 properties). Each schema is shown below with its type and property counts.

ErrorCodeMessage
string
The error message that is returned when an error occurs.
extendedHours
boolean
Whether the order is eligible for Extended Hours Trading. The timeInForce must be set to GTX when this field is true. Only applicable to Equity Orders.
commissionOverrideType
string
The type of commission override applied to the order
expiration
string
The date of expiration for a good-til-canceled order, in “YYYY-MM-DD” format. The order will be canceled if not executed by the market close on this date. If n…
updated
string
ErrorDetails
object
3 properties
commissionOverride
orderID
string
A unique DriveWealth order identifier created when an order is placed.
clientOrderID
string
A unique identifier that represents the order, as defined by the partner. This detail will be reported to the CAT system for US brokers to more easily reconcil…
taxLotID
string
A unique tax lot identifier.
note
string
A way to store a message/comment on the this object.
ErrorResponseModel
object
The error response model that is returned when an error occurs.
3 properties 2 required
deptType
string
The name of the department in abbreviation form.
PendingOrders
object
A list of pending orders.
5 properties
amountCash
number
The USD-denominated amount to purchase or sell.
orderTypesRequest
string
The type of the Order.
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.
currency
string
The name of the currency in abbreviation form.
schemas-side
string
Whether an order is to purchase or sell. Generally, the value should be set to BUY or SELL. For Options orders, BUYOPEN, BUYCLOSE, SELLOPEN, SELLCLOSE should b…
commissionOverrideDesc
string
The description of commission override applied to the order
OrderStatusResponse
object
Order details for a fixed income asset trade
32 properties
localOrderStatus
string
The current status of the order.
OrderHistoryRes
object
5 properties
CreateOrderResponse
object
2 properties
LotDisposition
array
orderCumulativeQuantity
number
The amount of shares currently being transacted; larger orders may execute in chunks.
side
string
The side of the order.
orderAveragePrice
number
The average price of the security being transacted in the order.
created
string
commissionID
string
The unique identifier associated with a specific commission related to the account.
accountID
string
The user's unique account identifier.
TaxLot
object
1 property
cancelDetails
object
Additional details to clarify when and how the cancel request was received. US broker-dealers must utilize this field for CAT compliance.
4 properties
SalesCredit
object
If set, the unit price will be marked up or marked down based on the prescribed amount. Only applicable to Orders for Debt Instruments.
2 properties
ErrorCode
string
The error code that is returned when an error occurs.
accountNo
string
The user's unique account number, that is human readable.
timeInForce
string
Set to "GTC" for a good-til-canceled order. Set to "GTX" for extended hours orders. When this property is not set, market and limit orders will be good-for-day…
instrumentType
string
The classification of the instrument.
instrumentCUSIP
string
CUSIP stands for Committee on Uniform Securities Identification Procedures. A CUSIP number identifies most financial instruments, including: stocks of all regi…
CancelOrderResponse
object
2 properties
auditLog
object
9 properties
orderTypes
string
The type of the Order.
tradingType
string
The type of trading the account will participate in.
sideAbbreviated
string
The side of the order.
commissionRate
number
The commission rate is a percentage charge to the total amount of the order.
clientOrderTransactionTime
string
The date with a valid timestamp of when a partner received the order from the customer.
limitType
string
Whether the limit price represents a unit price, or a yield. Only applicable to Orders for debt Instruments.
orderNo
string
A unique, human-readable DriveWealth order number.
instrumentID
string
A unique ID created by DriveWealth to identify a specific instrument.
orderStatusNumber
number
The current status of the order, represented as a number.
CancelOrder
object
5 properties 1 required
CreateOrderRequest
object
27 properties 3 required
availableForTradingQuantity
number
The number of units that can currently be traded by the Account holder.
OrderAuditResponse
object
23 properties
openQuantity
number
The number of units currently represented by the position in the Account.
metadata
object
The metadata object allows for creating a maximum of 5 keys (max 36 characters) and each value cannot exceed more than 128 bytes.
preventQueuing
boolean
If set to true, Orders received when the market is closed will not be queued for the next market open, and will be rejected. Please pay attention to the spelli…
dccs
boolean
True, when the Mutual Fund HSA is classified as Defined Contribution Clearing and Settlement (DCC&S) order.
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…
orderQuantity
number
The amount of the instrument in shares.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

drivewealth-orders-api-openapi.yml Raw ↑

Other APIs DriveWealth publishes across the network.

DriveWealth FIX API
DriveWealth Accounts API
DriveWealth Advisor Reports API
DriveWealth Asset Transfer API
DriveWealth Auth API
DriveWealth AutoPilot API
DriveWealth Beneficiaries API
DriveWealth Charts API
DriveWealth Commission Schedules API
DriveWealth Correspondent Reports API
DriveWealth Deposits API
DriveWealth Depth of Book API
Where this information came from

This is an independent, third-party profile of DriveWealth Orders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.