Order Class
Defines the structure for an object that represents an order.
Namespace: tsdata.trading
Properties
Additional
properties, methods, and events are described in the classes listed
under Inheritance Hierarchy (see below).
Name | Type | Description | |
![]() |
AccountID | string | Gets the ID of the account. |
![]() |
Action | enum | Gets the type of order action. See OrderAction for a list of possible values. |
![]() |
ActivationRules | object | Gets an activation rule for the order ticket. See ActivationRules. |
![]() |
AdvanceOptions | string | Gets a string contained the advanced order settings. |
![]() |
AllOrNone | bool | True to allow the order only if the entire quantity can be placed. |
![]() |
AvgFilledPrice | double | Gets the average filled price for the current order. |
![]() |
BuyMinusSellPlus | bool | True to allow buys to occur only on downticks and sells only on upticks. |
![]() |
Child | int | Gets the child order with the specified index in an OCO/OSO order. |
![]() |
ChildCount | int | Gets the number of children in an OCO/OSO order. |
![]() |
Commission | double | Gets the commission paid in an order. |
![]() |
Discretionary | bool | True to show an order's bid/ask at a lower/higher price than you are willing to pay. |
![]() |
DiscretionaryAmount | double | Sets or gets the discretionary price increment used when Discretionary is true. |
![]() |
Duration | string | Gets the duration of the order. |
![]() |
Duration Date | datetime | Gets the duration date for GTD. |
![]() |
ECNSweep | bool | True to route orders to ECNs only, bypassing all market makers. |
![]() |
EnteredQuantity | int | Gets the quantity of shares or contracts requested for the order. |
![]() |
EnteredTime | datetime | Gets the time when the order is placed. |
![]() |
ExtendedProperties | object | Gets the DynamicProperties object associated with the Order. |
![]() |
FilledQuantity | int | Gets the quantity of shares or contracts filled for the order. |
![]() |
FilledTime | datetime | Gets the time when the order is filled. |
![]() |
FirstSibling | object | Gets first Order object in the collection of sibling Orders. Note that all orders have at least one sibling, namely the order itself. |
![]() |
GeneratingApplication | enum | Get the type of application that generated the Order. See GeneratingApplication for a list of possible values. |
![]() |
HasValue | bool | True when specified field contains a value. False if no value. |
![]() |
IfTouched | bool | True to specify a trigger event at which an order will be sent. |
![]() |
IfTouchedPrice | double | The trigger price at which an IfTouched order is sent. |
![]() |
IfTouchedPriceOffset | int | The IfTouched price offset value if using an 'auto' limit price style. |
![]() |
IfTouchedPriceStyle | enum | The IfTouched price style. See PriceStyle for a list of possible values. |
![]() |
LastSibling | object | Gets last Order object in the collection of sibling Orders. Note that all orders have at least one sibling, namely the order itself. |
![]() |
LeftQuantity | int | Gets the number of unfilled shares or contracts for the current order. |
![]() |
LegCount | int | Gets the number of Legs in an options spread order. |
![]() |
Leg[ index ] | object | Gets the Leg with the specified index from the collection of the legs in an options spread order. |
![]() |
LimitPrice | double | Gets the limit price for a limit or stop limit order. |
![]() |
LimitPriceOffset | int | Gets the limit price offset value if using an 'auto' limit price style for limit and stop limit orders. |
![]() |
LimitPriceStyle | string | Gets the name of the limit price style for limit and stop limit orders. |
![]() |
LotSize | int | Gets the size of the lot. Applicable only to forex orders. |
![]() |
NextSibling | object | Gets the next Order object in the collection of sibling Orders, if one exists; otherwise null. Note that all orders have at least one sibling, namely the order itself. |
![]() |
NonDisplay | bool | True if the current order is to be placed with the non-display option. See Placing Non-Display Orders in TradeStation Platform Help. |
![]() |
OCOGroupID | string | Gets the group name of the OCO group. |
![]() |
OSOParentID | string | Gets the ID of the order that triggers the current order. |
![]() |
OrderID | string | Gets the ID of the current order. |
![]() |
OrderName | string | An optional, user-specified name for the order. Order names may not exceed 15 characters. |
![]() |
Originator | string | Gets the account name that generates the order. |
![]() |
Parent | order | Gets the parent order of the current order. |
![]() |
Peg | enum | The enumeration for peg behavior. See PegBehavior for a list of possible values. |
![]() |
PreviousSibling | object | Gets the previous Order object in the collection of sibling Orders, if one exists; otherwise null. Note that all orders have at least one sibling, namely the order itself. |
![]() |
Route | string | Gets the route for the order. |
![]() |
ShowOnly | bool | True to place show only orders. |
![]() |
ShowOnlyQuantity | int | Gets the size of a show only order. See show only in TradeStation platform help. |
![]() |
SiblingCount | int | Gets the number of siblings in an OCO/OSO order. |
![]() |
SpreadName | string | Gets the spread name in an options order. |
![]() |
State | enum | Gets the order state value. See OrderState for a list of possible values. |
![]() |
StateDetail | enum | Gets the order state detail value. See Order StateDetail for a list of possible values. |
![]() |
StopPrice | double | Gets the stop price for a stop or stop limit order. |
![]() |
StopPriceOffset | int | Gets the stop price offset value if using an 'auto' limit price style for stop and stop limit orders. |
![]() |
StopPriceStyle | string | Gets the name of the stop price style for stop and stop limit orders. |
![]() |
Symbol | string | Gets the symbol to trade. |
![]() |
SymbolExtension | string | Gets the symbol extension for the Symbol to trade. |
![]() |
TopLeftOrder | order | Gets the top most and left most node in an OCO/OSO order. |
![]() |
TrailingStop | enum | Gets the trailing stop type. See TrailingStopBehavior for a list of possible values. |
![]() |
TrailingStopAmount | double | Gets the trailing stop value. |
![]() |
|
enum | Get the order type. See OrderType for a list of possible values. |
![]() |
|
double | Gets the value of the specified OrderField. |
Methods
Name | Description | |
![]() |
ActionToString(action) | Gets a string representing a specified OrderAction. |
![]() |
CanCancel | True if the Order can be canceled, otherwise False. |
![]() |
Cancel | True to cancel the Order, otherwise False. |
![]() |
Replace(replaceTicket) | Replaces the current Order with a new ReplaceTicket object. Returns true if the replacement Order was sent, otherwise False if replacement is not possible. Note that there may be cases when the original Order is filled before the replacement becomes active. |
![]() |
StateToString(state) | Gets a string representing the state of the order based on a specified OrderState. |
![]() |
TypeToString() | Gets a string representing the order type based on a specified OrderType. |
Events
Name | Description | |
![]() |
Updated | Occurs whenever the object is updated. See OrderUpdatedEventArgs for the properties returned by the handler's args parameter. |
Inheritance Hierarchy
tsdata.Order