Sign in

v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB
Orders

Create Order

Create an Order.

post/orders

Request body

accountNostring required

The user's assiocated account number.

orderType'MARKET' | 'LIMIT' | 'STOP' | 'MARKET_IF_TOUCHED' required

The type of the Order.

limitType'PRICE' | 'YIELD'

Whether the limit price represents a unit price, or a yield. Only applicable to Orders for debt Instruments.

symbolstring nullable

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.

side'BUY' | 'SELL' required

The side of the order.

instrumentIDstring uuid

A unique ID created by DriveWealth to identify a specific instrument.

ISINstring

An International Securities Identification Number (ISIN) uniquely identifies a security. Its structure is defined in ISO 6166. ISINs are commonly used when an Instrument does not have a symbol, such as Debt Instruments and Global Mutual Funds.

quantitynumber double

The unit quantity to purchase or sell. Required if amountCash is null.

amountCashnumber double

The USD-denominated amount to purchase or sell.

pricenumber double

The price for non-MARKET Order types. This would be required if placing a LIMIT, STOP, or MARKET_IF_TOUCHED order.

currency'USD'

The name of the currency in abbreviation form.

commissionnumber double

A USD amount to charge as commission for an Order. This defaults to using an Account's assigned Commission Schedule if unset. For example, 4 will result in a $4.00 commission charge, regardless of the assigned Commission Schedule.

commissionRatenumber

The commission rate is a percentage charge to the total amount of the order.

clientNotesstring

Client facing notes that can be added to a request.

preventQueuingtrue | false

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 spelling of queuing as there are two valid spellings of this word.

extendedHourstrue | false

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.

metadataMetadata

The metadata object allows for creating a maximum of 5 keys (max 36 characters) and each value cannot exceed more than 128 bytes.

timeInForce'GTC' | 'GTX' | 'DAY' | 'FILL_OR_KILL'

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 by default, while stops and market-if-touched orders will be assumed good-til-canceled.

executionInstructionsstring[]

A list of execution instructions for an order. Currently only supported for Fixed Income orders.

expirationstring date

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 not set, a good-til-canceled Stop and MIT order will be assumed to expire 90 days after creation. If not set, a limit order will be considered GTD and will cancel at the end of the trading day.

dccsboolean

True, when the Mutual Fund HSA is classified as Defined Contribution Clearing and Settlement (DCC&S) order.

travelRuleBankAccountIDstring

The travel rule bank account ID. Supported By MARKET, LIMIT, STOP, MARKET_IF_TOUCHED orders. Only if partner enabled to send travel rule.

traderIDstring

The trader ID of the individual creating the order.

clientOrderTransactionTimestring

The date with a valid timestamp of when a partner received the order from the customer.

clientOrderRouteTimestring

The date with a valid timestamp of when DW received the order from the partner.

clientOrderIDstring

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 reconcile reported information.

deptType'A' | 'ATS' | 'DMA' | 'SA' | 'T' | 'O'

The name of the department in abbreviation form.

clientIDstring

A unique identifier from the partner's platform that represents the customer who placed this order. This detail should be supplied for orders in an omnibus account.

Example request

{
  "accountNo": "CSSW000001",
  "orderType": "MARKET",
  "limitType": "PRICE",
  "symbol": "MS",
  "side": "BUY",
  "instrumentID": "3fb1e8a9-f7d5-4d90-95e2-43e7326b5636",
  "ISIN": "US023135BX34",
  "quantity": 5,
  "price": 160.12,
  "currency": "USD",
  "commission": 4,
  "commissionRate": 0.3,
  "clientNotes": "Manual limit order.",
  "metadata": {
    "myCustomKey": "myCustomValue"
  },
  "timeInForce": "GTC",
  "executionInstructions": [
    "AON"
  ],
  "expiration": "YYYY-MM-DD",
  "salesCredit": {
    "currency": "USD",
    "amount": 14
  },
  "dccs": true,
  "taxLotDisposition": [
    {
      "taxLotID": "3db27e74626adac3be7b549f2bbc0ab2480852a7"
    }
  ],
  "travelRuleBankAccountID": "bank_485ba18c-009d-4c4a-a6e9-99b104c800b2",
  "traderID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
  "clientOrderTransactionTime": "2024-07-30T22:13:18.000Z",
  "clientOrderRouteTime": "2024-07-30T22:13:18.000Z",
  "clientOrderID": "5a1762d5-4562",
  "deptType": "ATS",
  "clientID": "1abc234xyz789"
}

Response

Creating an Order was Successful.

orderIdstring

A unique identifier for the order.

orderNostring

A human readable order identifier.

Example response

{
  "orderId": "EF.418a5506-256c-4c3c-9d4d-f491522cf7f2",
  "orderNo": "EFXM000103"
}