FRAMES NO FRAMES | |||||||
| |||||||
SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION | DETAIL: IMPORT | CONSTANT | MEMBER | ACTION |
Member Summary | |
---|---|
string | orderId
As given in NewOrder. |
string | symbol
As given in NewOrder, unless the market has modified it. |
float | price
The requested price active in the market - is only changed if an AmendOrder has been accepted by the market. Does not reflect price traded. |
string | side
Side active in the market. |
string | type
Type of order active in the market. |
integer | quantity
Total amount of order, including any already traded (either as a fill of the current order or previous orders if the service monitor manages orders). Should typically be the amount specified in NewOrder. |
boolean | inMarket
Whether the order is known to the market and is valid. Cancelling an order will make this false. |
boolean | isVisible
Whether the order is visible (stop orders are "hidden" until triggered, all other orders are visible if they are in the market). |
boolean | modifiable
Whether the order may be modified - it is assumed that an adapter only allows one outstanding modification. |
boolean | cancelled
Whether the order has been cancelled, either by being rejected before entering the market, cancelled by the user, an administrator or the market systems (e.g. reached expiry time). |
boolean | orderChangeRejected
Whether the most recent cancel or amendment was rejected. |
boolean | externallyModified
Whether the order was modified or cancelled by an entity other than the one who placed the order. |
boolean | unknownState
Whether the order is in an unknown state - this is an error condition. |
string | marketOrderId
The order identifier supplied by the market, typically unique across the market - may be required if another system is to control the order. |
integer | qtyExecuted
The total quantity executed. |
integer | qtyRemaining
The quantity remaining. Typically qtyRemaining = quantity-qtyExecuted. |
integer | lastShares
The last number of shares traded. |
float | lastPrice
The price of the most recent fill. |
float | avgPrice
The volume-weighted price across all fills. undefined if qtyExecuted is 0. |
string | status
A free-form string describing what has happened to the order - may contain an error message (e.g. "User is not allowed to place orders". |
dictionary<string, string > | extraParams
Extra parameters that do not map into any of the above. Convention is that keys are in TitleCase. e.g. "DealCounterpartyId", etc. Identifier should be shortened to "Id" not "ID". |
Member Detail |
---|
float avgPriceThe volume-weighted price across all fills. undefined if qtyExecuted is 0.
boolean cancelledWhether the order has been cancelled, either by being rejected before entering the market, cancelled by the user, an administrator or the market systems (e.g. reached expiry time).
boolean externallyModifiedWhether the order was modified or cancelled by an entity other than the one who placed the order.
dictionary<string, string > extraParamsExtra parameters that do not map into any of the above. Convention is that keys are in TitleCase. e.g. "DealCounterpartyId", etc. Identifier should be shortened to "Id" not "ID".
boolean inMarketWhether the order is known to the market and is valid. Cancelling an order will make this false.
boolean isVisibleWhether the order is visible (stop orders are "hidden" until triggered, all other orders are visible if they are in the market).
float lastPriceThe price of the most recent fill.
integer lastSharesThe last number of shares traded.
string marketOrderIdThe order identifier supplied by the market, typically unique across the market - may be required if another system is to control the order.
boolean modifiableWhether the order may be modified - it is assumed that an adapter only allows one outstanding modification.
boolean orderChangeRejectedWhether the most recent cancel or amendment was rejected.
string orderIdAs given in NewOrder.
float priceThe requested price active in the market - is only changed if an AmendOrder has been accepted by the market. Does not reflect price traded.
integer qtyExecutedThe total quantity executed.
integer qtyRemainingThe quantity remaining. Typically qtyRemaining = quantity-qtyExecuted.
integer quantityTotal amount of order, including any already traded (either as a fill of the current order or previous orders if the service monitor manages orders). Should typically be the amount specified in NewOrder.
string sideSide active in the market.
string statusA free-form string describing what has happened to the order - may contain an error message (e.g. "User is not allowed to place orders".
string symbolAs given in NewOrder, unless the market has modified it.
string typeType of order active in the market.
boolean unknownStateWhether the order is in an unknown state - this is an error condition.
FRAMES NO FRAMES | |||||||
| |||||||
SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION | DETAIL: IMPORT | CONSTANT | MEMBER | ACTION |