Single Equity Order

Create a Single Non-Discretionary or Single CAT Equity Order.

POST

/trading-api/v1/equityorder/create-single

Request

Query Parameters

Name	Data Type	Description
verifyOnly	Boolean	Allows users to review the response of an order without creating the order

Request Body

The Request Body to create a Single Non-Discretionary or Single CAT Equity Order includes several required fields. This ensures that the created order has all necessary parameters for the order to return with no errors.

This request must consist of the below Stonex identifiers:

Schema

Attributes	Data Type	Value
accountNumber	String	Assigned Account identifier
inventoryAccountNumber	String	Assigned Account identifier
inventorySubNumber	String	Assigned Firm identifier
stopPrice	Number	Price assigned to trigger a Stop order
limitPrice	Number	Price assigned to a Limit Order
noPostage	Boolean	True or False
allOrNone	Boolean	True or False
ttoRep	String	Character field
commissionType	String	FlatRate, CentsPerShare, PercentOfDiscount, Zero, Unknown, CommissionSchedule
commissionSchedule	Integer
commissionAmount	Number
confirmNote	String	Character field
accountType	String	Cash, Margin, Short
securityId	String	Cusip, Isin, Sedol, Symbol
securityIdType	String	Cusip, Isin, Sedol, Symbol
quantity	Number	Amount
action	String	Buy, Sell, BuyToCover, SellShort
timeInForce	String	Day, GoodTillCancel, FillOrKill, GTXPre, NTE
solicited	Boolean	True or False
notHeld	Boolean	True or False
onClose	Boolean	True or False

Example

{
  "inventoryAccountNumber": "string",
  "inventorySubNumber": "string",
  "stopPrice": 0,
  "limitPrice": 0,
  "accountType": "Cash",
  "securityId": "string",
  "securityIdType": "Cusip",
  "quantity": 0,
  "action": "Buy",
  "timeInForce": "Day",
  "solicited": false,
  "notHeld": false,
  "onClose": false
}

Response Body

Responses from the request will return with a Status Code.

There are 3 Codes: Successful (200), Bad Request (400) and Internal Server Error (500).

Successful Response

The response for a Successful request will look like:

Schema

A successful request will respond with a result containing the account number and account status

Attributes	Data Type	Description
statusCode	Integer	Code identifies success of request
message	String	Outcome of request
data	Data Block	Main field containing information of request
errors	Errors	API errors
traceId	String	Unique identifier
hasErrors	Boolean	True or False

Example

{
  "statusCode": 200,
  "message": "Request successful",
  "data": [
    {
      "orderId": "99999999-9999-9999-9999-999999999999",
      "orderNumber": "99999999",
      "orderType": "Single",
      "action": "Buy",
      "timeInForce": "Day",
      "orderStatus": "Verification",
      "securityIdentifier": {
        "securityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "securityNumber": "string",
        "sourceSystem": "string",
        "symbol": "string",
        "underlyingSymbol": "string",
        "isin": "string",
        "sedol": "string",
        "cusip": "string",
        "description": "string",
        "strikePrice": 0,
        "expirationDate": "2024-04-22T02:22:37.421Z",
        "displaySymbol": "string"
      },
      "quantity": 0,
      "filledQuantity": 0,
      "stopPrice": 0,
      "limitPrice": 0,
      "onClose": false,
      "solicited": false,
      "notHeld": false,
      "tradeInfo": {
        "buyingPower": 0,
        "estimatedSettlementDate": "2024-04-22T02:22:37.421Z",
        "estimatedPrincipal": 0,
        "estimatedNetTotal": 0,
        "estimatedCommission": 0,
        "estimatedHandlingFee": 0,
        "estimatedPostageFee": 0,
        "estimatedSecFee": 0,
        "estimatedFirmFee": 0,
        "estimatedPrice": 0,
        "actualPrincipal": 0,
        "actualNetTotal": 0,
        "actualCommission": 0,
        "actualHandlingFee": 0,
        "actualPostageFee": 0,
        "actualSecFee": 0,
        "actualPrice": 0
      },
      "averageTradePriceAmount": 0,
      "orderWarnings": [
        "string"
      ],
      "orderError": {
        "code": "string",
        "target": "string",
        "message": "string",
        "details": [
          "string"
        ]
      },
      "enteredDate": "2024-04-22T02:22:37.421Z",
      "completedDate": "2024-04-22T02:22:37.421Z"
    }
  ],
  "errors": [
    {
      "code": "string",
      "field": "string",
      "reason": "string"
    }
  ],
  "traceId": "00-00000000000000000000000000000000-0000000000000000-00",
  "hasErrors": true
}