OrderResponse
| Field Name | Data Type | Retrieves |
|---|---|---|
| Account | 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 |
| Buyorsell | string | BUY, SELL, or SELLSHORT. This field will soon be deprecated. Alternatively, you can use the field Side |
| ClaimedByClerk | string | Claimed by clerk |
| CurrentStatus | string | Current status of order (e.g., PENDING, LIVE, COMPLETED, DELETED) |
| ExpirationDate | google.protobuf.Timestamp | Date at which order is no longer valid |
| GoodFrom | google.protobuf.Timestamp | Time at which order is first valid for execution |
| LinkedOrderId | string | ID of linked order |
| OrderId | string | A unique id associated to every order. This is the identifier to lookup the specific order to cancel |
| OrderTag | string | Order tag |
| OriginalOrderId | string | Original order identification code |
| PairSpreadType | string | Pair spread type |
| Price | google.protobuf.DoubleValue | Limit price submitted in order |
| PriceType | PriceTypeEnum | By default the price type is set to Market, in case no value is provided. Refer to the section PriceTypeEnum |
| Reason | string | Reason given by user or destination for changing, cancelling, or deleting the order |
| RefersToId | string | Refers to identification code |
| Route | string | Route name as shown in Eze EMS. Note: This field is also referred to as Exit Vehicle |
| Side | 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 |
| StopPrice | google.protobuf.DoubleValue | Stop price |
| submitTime | google.protobuf.Timestamp | The time when the trade was submitted |
| Symbol | string | Valid ticker symbol (e.g., AAPL, IBM, VOD.LSE) |
| TicketId | string | Ticket ID |
| TimeInForce | ExpirationType | Time or date at which order is no longer valid. Refer to the section ExpirationType |
| TimeStamp | string | Timestamp applied to order by trading system |
| TraderId | string | USERNAME@DOMAIN of the message recipient |
| Type | string | Order Event Type. Refer to the section Appendix A |
| UserMessage | string | User message/notes |
| Volume | int32 | Order quantity |
| VolumeTraded | int32 | Volume traded so far by the order |
The following table provides you the Extended Fields details for Data Type map<string, string> used in OrderResponse.
| Key | Expected Values |
|---|---|
| AcctType | Type of account for a position |
| AllocatedValue | Allocated value |
| Ask | Last ask price for symbol |
| AvgPrice | Average execution price for order so far |
| Basisvalue | Currency value of a unit move |
| Bid | Last bid price for symbol |
| BLOOMBERG_CODE_FULL | Full bloomberg symbol code |
| BookId | Book ID |
| BOOKING_TYPE | Booking type |
| ClientOrderId | Client order ID |
| Commission | Net of commissions for today's trades for a symbol |
| CommissionCode | Broker code |
| CommissionRate | Commission rate |
| CommissionRateType | Commission rate type |
| CrossFlag | Cross flag |
| Currency | Currency of symbol being traded or Currency of position |
| DateIndex | Date index |
| EcnFee | ECN fee |
| Exchange | Three-letter acronym for listing exchange |
| ExecutionState | Execution state |
| ExtendedStateFlags | Extended state information for internal use |
| ExtendedStateFlags2 | Extended state flags 2 |
| EXTERNAL_CUSTOMER | External customer |
| EXTERNAL_TRADER | External trader |
| ExternalAcceptanceFlag | External acceptance flag |
| FixTraderId | FIX trader ID |
| FornexSourceFlags | Forex source |
| FREE_QTY | Target quantity - Committed quantity (the amount of the ticket that has not filled and is not in the market) |
| GwBookSeqNo | Gateway book sequence number |
| Latency3 | Latency |
| Latency6 | Latency |
| LinkedOrderCancellation | Linked order cancellation |
| LinkedOrderRelationship | Linked order relationship |
| Minmove | Minimum movement |
| NewRemoteId | New remote identification code |
| NewsDate | Date of most recent news story |
| NewsTime | Time of most recent news story |
| OmsClientType | OMS client type |
| OppositeParty | Contra (used by ARCAEX to signify liquidity added or removed) |
| OrderFlags | Order flags |
| OrderFlags2 | Order flag 2 |
| OrderResidual | Residual volume |
| OriginalPrice | Original price |
| OriginalTraderId | USERNAME@DOMAIN of the trader who placed the trade originally |
| OriginalVolume | Original volume of trade |
| PairCash | Pair cash component |
| PairImbalanceLimit | Pair imbalance limit |
| PairImbalanceLimitType | Pair imbalance limit type |
| PairLeg1Benchmark | Pair Leg 1 benchmark |
| PairLeg1BenchmarkType | Pair Leg 1 benchmark |
| PairLeg2Benchmark | Pair Leg 2 benchmark |
| PairLeg2BenchmarkType | Pair Leg 2 benchmark |
| PairRatio | Pair ratio |
| PairSpread | Pair spread |
| PairTarget | Pair target |
| Putcallind | Option type (P = put, C = call, U = underlier) for symbol |
| Rank | Rank |
| REGION | Region associated with the listed exchanges for a symbol |
| RemainingVolume | Remaining volume |
| RemoteId | Remote ID |
| RootOrderID | A unique ID associated with each USO child order event, helping you to trace the staged order (USSO) |
| SERVER_ARRIVAL_PRICE | Arrival price as stamped by server. Will be 0 when order arrives outside core trading hours |
| SharesAllocated | Shares allocated |
| ShortLocateId | ID assigned to short sell orders as required by regulation SHO |
| SpreadClip | Spread clip |
| SpreadClipType | Spread clip type |
| SpreadLegCount | Number of legs this spread contains |
| SpreadLegLeanPriority | Spread leg lean priority |
| SpreadLegNumber | Number of legs this spread contains |
| SpreadLegPriceType | Spread leg price type |
| SpreadNumLegs | Spread number of legs |
| StrikePrc | Price at which option can be exercised |
| Styp | Security type |
| Table | Table |
| TboAccountId | Account ID |
| TraderCapacity | Trader capacity |
| TRD_TIME | Time of trade |
| TrdTime | Time of last trade |
| Undersym | Underlier symbol |
| UtcOffset | UTC offset |
| VolumeType | Indicates the fill type of the position for the symbol |
| WorkingQty | Quantity out in the market |
| WorkingQty | Quantity out in the market |