Search Option Orders

Search for multiple Option Orders.

POST

/trading-api/v1/optionorder/search-option-orders

Request Body

Orders are retrieved using Order IDs, account numbers, security numbers, dates, and order types.

Schema

This request must consist of the below StoneX identifiers:

Attributes	Data Type	Length	Description
orderIds	String	32	Assigned Order identifiers
accountNumber	String
securityNumber	String
dateFrom	String
dateTo	String
orderTypes	String		Single, Block, Allocation
orderStatuses	Boolean		Created, Open, Filled, Cancel, Canceled, Route, Routed, Rejected, Deleted, Expired

Example

{
  "orderIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "accountNumber": "string",
  "securityNumber": "string",
  "dateFrom": "2024-04-03T20:18:41.803Z",
  "dateTo": "2024-04-03T20:18:41.803Z",
  "orderTypes": [
    "Single"
  ],
  "orderStatuses": [
    "Created"
  ]
}

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
message	String
data	Data Block
errors	Errors
traceId	String
hasErrors	Boolean

Example

{
  "statusCode": 200,
  "message": "Request Successful",
  "data": [
    {
      "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-04-22T02:43:27.116Z",
        "displaySymbol": "string"
      },
      "openCloseIndicator": "Open",
      "quantity": 0,
      "filledQuantity": 0,
      "solicited": false,
      "notHeld": false,
      "tradeInfo": {
        "buyingPower": 0,
        "estimatedSettlementDate": "2024-04-22T02:43:27.116Z",
        "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:43:27.117Z",
      "completedDate": "2024-04-22T02:43:27.117Z"
    }
  ],
  "errors": [
    {
      "code": "string",
      "field": "string",
      "reason": "string"
    }
  ],
  "traceId": "string",
  "hasErrors": true
}