Single Option Order

Create a Single Non-Discretionary, Single CAT, or Single Complex Options Order.

POST

/trading-api/v1/optionorder/create-single

Request Body

The Request Body to create a Single Non-Discretionary, Single CAT, or Single Complex Options 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	Length	Value
accountNumber	String	32	Account Identifier
inventoryAccountNumber	String	4	Assigned Account identifier
inventorySubNumber	String	3	Assigned Firm identifier
accountType	String		Cash, Margin, Short
noPostage	Boolean		True or False
allOrNone	Boolean		True or False
solicited	Boolean		True or False
notHeld	Boolean		True or False
stopPrice	Number		Price assigned to trigger a Stope order
limitPrice	Number		Price assigned to a Limit Order
ttoRep	String		Character field
commissionType	String		FlatRate, CentsPerShare, PercentOfDiscount, Zero, Unknown, CommissionSchedule
commissionSchedule	Integer		Character field
commissionAmount	Number		$ amount for commission
leg2Details
confirmNote	String		Character field
underlyingSymbol	String		Cusip, Isin, Sedol, Symbol
expirationDate	String		(date-time)
putCallIndicator	String		Put, Call
strikePrice	Number		The price at which a Put or Call can be exercised
quantity	Number		Amount
action	String		BuyToOpen, BuyToClose, SellToOpen, SellToClose
timeInForce	String		Day, GoodTillCancel, GTXPre

Example

{
  "accountNumber": "string",
  "inventoryAccountNumber": "string",
  "inventorySubNumber": "string",
  "accountType": "Cash",
  "noPostage": false,
  "allOrNone": false,
  "solicited": false,
  "notHeld": false,
  "stopPrice": 0,
  "limitPrice": 0,
  "ttoRep": "string",
  "commissionType": "FlatRate",
  "commissionSchedule": 0,
  "commissionAmount": 0,
  "leg2Details": {
    "underlyingSymbol": "string",
    "expirationDate": "2024-05-07T15:29:07.227Z",
    "putCallIndicator": "Put",
    "strikePrice": 0,
    "qualifier": "Market",
    "action": "BuyToOpen",
    "quantity": 0,
    "accountType": "Cash",
    "commissionAmount": 0,
    "commissionType": "FlatRate",
    "commissionSchedule": 0,
    "debitCredit": "Debit"
  },
  "confirmNote": "string",
  "underlyingSymbol": "string",
  "expirationDate": "2024-05-07T15:29:07.227Z",
  "putCallIndicator": "Put",
  "strikePrice": 0,
  "quantity": 0,
  "action": "BuyToOpen",
  "timeInForce": "Day"
}

Verify Only

verifyOnly is a Query parameter that allows users to review the response of an order without creating the order.

Schema

Attributes	Data Type	Value
verifyOnly	Boolean	True: does not submit order. Response body will not return an orderId
		False: immediately submits order through API. If the order is successfull, the Response Body will return an orderId

Endpoint

verifyOnly=true

POST

/trading-api/v1/optionorder/create-single?verifyOnly=true

verifyOnly=false

POST

/trading-api/v1/optionorder/create-single?verifyOnly=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	Length	Description
statusCode	Integer	3	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": "string",
  "data": {
    "clientAccountIdentifier": {
      "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "subNo": "string",
      "branchNo": "string",
      "accountNumber": "string",
      "name": "string",
      "sourceSystem": "string",
      "subType": "Discretionary",
      "catType": "string"
    },
    "stopPrice": 0,
    "limitPrice": 0,
    "noPostage": false,
    "allOrNone": false,
    "ttoRep": false,
    "commissionType": "FlatRate",
    "commissionSchedule": 0,
    "commissionAmount": 0,
    "calculatedCommission": 0,
    "confirmNote": "string",
    "orderId": "00000000-0000-0000-0000-000000000000",
    "orderNumber": "00000000",
    "orderType": "Single",
    "accountType": "Cash",
    "action": "BuyToOpen",
    "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-05-07T15:29:07.229Z",
      "displaySymbol": "string"
    },
    "openCloseIndicator": "Open",
    "quantity": 0,
    "filledQuantity": 0,
    "solicited": false,
    "notHeld": false,
    "tradeInfo": {
      "buyingPower": 0,
      "estimatedSettlementDate": "2024-05-07T15:29:07.229Z",
      "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-05-07T15:29:07.229Z",
    "completedDate": "2024-05-07T15:29:07.229Z"
  },
  "errors": [
    {
      "code": "string",
      "field": "string",
      "reason": "string"
    }
  ],
  "traceId": "string",
  "hasErrors": true
}