Get Option Order

Get a Single Non-Discretionary, Single CAT, Single Complex, Block, or Allocation Option Order.

POST

/trading-api/v1/optionorder/get-option-order

Search for a Single Non-Discretionary, Single CAT, Block or Allocation order.

Request Body

Order is retrieved using the Order ID.

Schema

This request must consist of the below StoneX identifiers:

Attributes	Data Type	Length	Description
orderId	String	32	Assigned Order identifier

Example

{
    "orderId": "00000000-0000-0000-0000-000000000000"
}

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

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": "Request successful",
  "data": {
    "orderId": "00000000-0000-0000-0000-000000000000",
    "orderNumber": "00000000",
    "orderType": "Single",
    "action": "Buy",
    "timeInForce": "Day",
    "orderStatus": "Verification",
    "securityIdentifier": {
      "securityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "securityNumber": "string",
      "sourceSystem": "string",
      "symbol": "string",
      "isin": "string",
      "sedol": "string",
      "cusip": "string",
      "description": "string",
      "strikePrice": 0,
      "expirationDate": "2024-04-03T18:16:10.426Z",
      "displaySymbol": "string"
    },
    "quantity": 0,
    "filledQuantity": 0,
    "stopPrice": 0,
    "limitPrice": 0,
    "onClose": false,
    "solicited": false,
    "notHeld": false,
    "tradeInfo": {
      "buyingPower": 0,
      "estimatedSettlementDate": "2024-04-03T18:16:10.426Z",
      "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-03T18:16:10.426Z",
    "completedDate": "2024-04-03T18:16:10.426Z"
  },
  "errors": [
    {
      "code": "string",
      "field": "string",
      "reason": "string"
    }
  ],
  "traceId": "00-00000000000000000000000000000000-0000000000000000-00",
  "hasErrors": true
}