Sign in

v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB
Orders

Retrieve Order by Order Number

Retrieves an Order by OrderNo.

get/orders/byOrderNo/{orderNo}

Path parameters

orderNostring required

A unique, human-readable DriveWealth order number.

Example:ICDU023727

Response

Retrieving an Order by OrderNo was Successful.

idstring

A unique DriveWealth order identifier created when an order is placed.

orderNostring

A unique, human-readable DriveWealth order number.

type'MARKET' | 'LIMIT' | 'STOP' | 'STOP_LIMIT' | 'MARKET_IF_TOUCHED'

The type of the Order.

side'BUY' | 'SELL'

The side of the order.

status'NEW' | 'FILLED' | 'PARTIAL_FILL' | 'REJECTED' | 'CANCELED' | 'PENDING_CANCEL'

The current status 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.

CUSIPstring

CUSIP stands for Committee on Uniform Securities Identification Procedures. A CUSIP number identifies most financial instruments, including: stocks of all registered U.S. and Canadian companies, commercial paper, and U.S. government and municipal bonds. The CUSIP system facilitates the clearance and settlement process of securities. CUSIP numbers consist of nine characters (including letters and numbers) that uniquely identify a company or issuer and the type of financial instrument. A similar system is used to identify foreign securities (CUSIP International Numbering System or CINS). CINS employs the same nine character identifier as CUSIP, but also contains a letter in the first position to signify the issuer's country or geographic region.

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.

averagePricenumber

The average price of the security being transacted in the order.

currency'USD'

The name of the currency in abbreviation form.

totalOrderAmountnumber double

Total amount paid for the order.

cumulativeQuantitynumber

The amount of shares currently being transacted; larger orders may execute in chunks.

quantitynumber

The amount of the instrument in shares.

feesnumber double

Cost of the order.

ptpWithholdingFeenumber double

The publicly traded partnership (PTP) withholding fee for the order.

createdBystring

userID of the individual creating the order.

userIDstring

userID of the account holder the order relates to.

accountIDstring

accountID for the account the order relates to.

accountNostring

accountNo for the account the order related to.

createdstring

The time at which the order was created.

amountCashnumber double

The USD-denominated amount to purchase or sell.

OrderExpiresstring

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.

instrumentType'EQUITY' | 'ALTERNATIVE_ASSET' | 'MUTUAL_FUND' | 'DEBT' | 'OPTION' | 'CRYPTO'

The classification of the instrument.

dccsboolean

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

openQuantitynumber

The number of units currently represented by the position in the Account.

availableForTradingQuantitynumber

The number of units that can currently be traded by the Account holder.

travelRuleBankAccountIDstring

Displays travel rule bank account ID which set while creating order

clientOrderTransactionTimestring

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

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.

executionInstructionsstring[]

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

Example response

{
  "id": "IC.0e352bb7-9869-4233-9861-9673544efedd",
  "orderNo": "ICDU023727",
  "type": "MARKET",
  "side": "BUY",
  "status": "FILLED",
  "instrumentID": "3fb1e8a9-f7d5-4d90-95e2-43e7326b5636",
  "ISIN": "US023135BX34",
  "CUSIP": "E09876AA7",
  "symbol": "MS",
  "averagePrice": 1038.81,
  "currency": "USD",
  "totalOrderAmount": 800,
  "cumulativeQuantity": 0.7219,
  "quantity": 0.7219,
  "fees": 0.01,
  "ptpWithholdingFee": 0.01,
  "createdBy": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
  "userID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
  "accountID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407776996299",
  "accountNo": "CSSW000001",
  "created": "2019-02-14T18:56:07.411Z",
  "salesCredit": {
    "currency": "USD",
    "amount": 14
  },
  "instrumentType": "EQUITY",
  "dccs": true,
  "openQuantity": 1,
  "availableForTradingQuantity": 1,
  "travelRuleBankAccountID": "bank_485ba18c-009d-4c4a-a6e9-99b104c800b2",
  "clientOrderTransactionTime": "2024-07-30T22:13:18.000Z",
  "clientOrderID": "5a1762d5-4562",
  "executionInstructions": [
    "AON"
  ]
}