The SubmitSingleOrderRequest object is used as an input in SubmitSingleOrder API. This API is used to place a single leg buy/sell order (either staged or live).
SubmitSingleOrderRequest
| Field Name | Required? | Data Type | Accepted Values/Examples |
|---|---|---|---|
| Account | Yes | string | Semi-colon separated values that represent either Trade or Neutral accounts the user has permission to e.g., TAL;TEST;USER1;TRADE or TAL;TEST;USER2;NEUTRAL |
| ClaimRequire | No | bool | TRUE or FALSE (Note: setting TRUE value envisages a user running Eze EMS who then claims the Order so it can switch from Pending to Live State) |
| ExpirationDate | No | google.protobuf.Timestamp | Date at which order is no longer valid |
| GoodFrom | No | google.protobuf.Timestamp | Time at which order is first valid for execution |
| OrderTag | No | string | Order tag |
| Price | No | google.protobuf.DoubleValue | Limit price submitted in order |
| PriceType | No | PriceTypeEnum | By default the price type is set to Market, in case no value is provided. Refer to the section PriceTypeEnum |
| Quantity | Yes | int32 | Value > 0 |
| ReturnResult | No | bool | If set to True, a current snapshot of all the order event fields is retrieved |
| ReturnResultTimeOutInMs | No | int32 | If set to True, fetches the results at the defined time out interval in milli seconds. If set to True, but no specific value is defined, the default server value (e.g., "RequestTimeOutLimit": 10000) is used. |
| Route | Yes | string | Route name as shown in Eze EMS. Note: This field is also referred to as Exit Vehicle |
| Side | Yes | string | BUY, SELL, SELLSHORT Note: To send an order with side SELLSHORT, the extended field SHORT_LOCATE_ID must be assigned. The SHORT_LOCATE_ID is an ID assigned to short sell orders. Similarly, to send a Buy To Cover order, set the side to BUY and assign the extended field TO_OPEN_POS to the required volume |
| Staged | No | bool | TRUE or FALSE (Note: in order to send a staged order, this field becomes mandatory and has to be set as TRUE only) |
| StopPrice | No | google.protobuf.DoubleValue | Stop price |
| Symbol | Yes | string | Valid ticker symbol (e.g., AAPL, IBM, VOD.LSE) |
| TicketId | No | string | Ticket ID |
| TimeInForce | No | ExpirationType | Time or date at which order is no longer valid. In case no value is provided, DAY expiration type is set by default. Refer to the section ExpirationType |
| UserMessage | No | string | User message/notes |
| UserToken | Yes | string | A server generated GUID that is given as response to the client during the first login |