public property TradeDeskAut.FIX_STOP

Brief

Creates Stop order in the TradeDeskAut.CreateFixOrder3 and OrdersBatchAut.CreateFixOrder methods.

Does not work for United States based accounts. Please read NFA Compliance Rule 2-43(b). In case if this function is used Order2Go API will throw an Exception/Error.

Declaration
Visual Basic
FIX_STOP As Integer
IDL
[propget] HRESULT FIX_STOP( [out, retval] long* retVal)

Parameters
iFixOrderKind

The kind of the order.

The value must equal TradeDeskAut.FIX_STOP

sTradeID

The unique identifier of the trade.

In case a stop order must be created or replaced on the trade, specify the unique identifier of the trade. The trade must exist in the Trades table. The value can be obtained from the TradeID column of the Trades table.

In case a stop order must be created or replaced on the entry order, specify the unique identifier of the trade which will be opened by this entry order. The order must exist in the Orders table. The value can be obtained from the TradeID column of the Orders table.

dRate

The rate at which the stop order must be created or the offset in pips for the stop order. The interpretation of the parameter depends on the value of the iRateFlag parameter (see below).

The stop rate on the trade must be worse than the current close price. I.e. the rate must be lower than the current close price for buying, and higher for selling. The distance between the specified rate and the current close price must be greater than the minimal conditional distance.

The stop rate on the entry order must be worse than the rate of the entry order. I.e. the rate must be lower than the rate of the entry order for buying, and higher for selling. The distance between the specified rate and the rate of the entry order must be greater than the sum of the minimal conditional distance and current spread.

The value of the minimal conditional distance you can retrieve using methods of TradingSettingsProviderAut interface.

dRate1

The parameter is not used.

sQuoteID

The parameter is not used.

sAccountID

The parameter is not used.

sInstrument

The parameter is not used.

bBuySell

The parameter is not used.

iAmount

The parameter is not used.

sRemark

The custom text to written into the QTXT column of the order. The parameter can be an empty string ("").

iRateFlag

The type of the stop order. The value defines interpretation of the dRate parameter.
The parameter must have one of the following values:

TradeDeskAut.SL_NONE

Use this value in case the stop order must be removed.

TradeDeskAut.SL_STOP

Use this value in case the simple stop order must be added.

TradeDeskAut.SL_PEGSTOPOPEN

Use this value in case the stop order must be the pegged stop order and its offset must be added to the open price (see Order Types for information about pegged orders).

The offset is specified in pips.

For buy orders, the stop order must be below open price minus current spread, i.e. offset must be negative and must be less than "-" spread.
For sell orders, the stop order must be above open price plus current spread. i.e. offset must be positive and must be bigger than spread.

TradeDeskAut.SL_PEGSTOPCLOSE

Use this value in case the stop order must be the pegged stop order and its offset must be added to the close price (see Order Types for information about pegged orders).

The offset is specified in pips.

For buy orders, the stop order must be below close price, i.e. offset must be negative.
For sell orders, the stop order must be above close price, i.e. offset must be positive.

iTrailMinMove

Controls the trailing stop order.

In case the stop order must not be trailing, specify 0 in this parameter.

In case the stop order must be trailing with a dynamic step, specify 1 in this parameter.

In case the stop order must be trailing with a fixed step, specify the size in pips of the market movement after which the order must be moved following the market. The value must be from the TradingSettingsProviderAut.GetMinTrailingStepForStop value to the TradingSettingsProviderAut.GetMaxTrailingStepForStop value.

Note that trailing stop orders can be not available on the server. To check whether trailing stop orders with a dynamic step are available, use the PermissionCheckerAut.CanUseDynamicTrailingForStop method. To check whether trailing stop orders with a fixed step are available, use the PermissionCheckerAut.CanUseFluctuateTrailingForStop method.

iTIFType

The parameter is not used.

Details

See also FIX Order Types for more details.

The FIX_STOP property is defined in the TradeDeskAut class.

back