Search Equity Orders

Search for multiple Equity Orders.

POST

/trading-api/v1/equityorder/search-equity-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	Description
orderIds	String
accountNumber	String
securityNumber	String
dateFrom	String
dateTo	String
orderTypes	String	Order Types: Single, Block, Allocation
orderStatuses	Boolean	Status: 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:24:29.575Z",
  "dateTo": "2024-04-03T20:24:29.575Z",
  "orderTypes": [
    "Single"
  ],
  "orderStatuses": [
    "Created"
  ]
}

Response

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

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

Schema

Attributes	Data Type	Description
statusCode	Integer	Code identifies success of request
message	String	Outcome of request
data	Search Equity 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",
        "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
}