Plugin¶
Summary¶
Base class for Plugins.
Remarks¶
Contains all necessary data, provides framework forconvenient Plugin's creation.
Signature
1 |
|
Namespace¶
cAlgo.API
Methods¶
ToString¶
Summary
The name of the plugin class.
Signature
1 |
|
Return Value
string
RefreshData¶
Summary
Updates MarketSeries, Positions, PendingOrders, History, etc.And sends postponed events after Thread sleep call.If you put the main thread on sleep by calling Thread sleep methodthen you have to call RefreshData after Thread wakes up to sendthe postponed events while thread was sleeping.
Signature
1 |
|
Return Value
void
Examples
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
|
BeginInvokeOnMainThread¶
Summary
Invokes asynchronously the specified code on the main Plugin thread.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
action | Action | The code to invoke on the main Plugin thread |
Return Value
void
Print (3)¶
Print (1 of 3)
Summary
Prints text representation of the specified object to the log.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
value | object | Object to print. |
Return Value
void
Examples
1 |
|
Print (2 of 3)
Summary
Prints a message to the Log
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
parameters | object[] | Parameters to print |
Return Value
void
Examples
1 |
|
Print (3 of 3)
Summary
Prints a message to the Log.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
message | string | Message to print. |
parameters | object[] | Parameters (optional) |
Return Value
void
Examples
1 |
|
Sleep (3)¶
Sleep (1 of 3)
Summary
Suspends the plugin until the specified timespan elapses.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
timespan | TimeSpan | The Timespan during which the plugin should not react to any events. |
Return Value
void
Related Tutorials
Sleep (2 of 3)
Summary
Suspends the plugin until the specified number of milliseconds elapses.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
milliseconds | int | The number of milliseconds for which the plugin should be suspended. |
Return Value
void
Related Tutorials
Sleep (3 of 3)
Summary
Suspends the plugin until the specified datetime.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
dateTime | DateTime | The DateTime until the plugin should be suspended. |
Return Value
void
Related Tutorials
PlaceLimitOrder (7)¶
PlaceLimitOrder (1 of 7)
Summary
Place a Limit Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
Return Value
TradeResult
PlaceLimitOrder (2 of 7)
Summary
Place a Limit Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
label | string | Label representing the order |
Return Value
TradeResult
PlaceLimitOrder (3 of 7)
Summary
Place a Limit Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
Return Value
TradeResult
PlaceLimitOrder (4 of 7)
Summary
Place a Limit Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry time |
Return Value
TradeResult
PlaceLimitOrder (5 of 7)
Summary
Place a Limit Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry time |
comment | string | Order comment |
Return Value
TradeResult
Examples
1 2 |
|
1 2 |
|
1 2 |
|
1 2 3 4 |
|
1 2 3 4 |
|
PlaceLimitOrder (6 of 7)
Summary
Place a Limit Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry time |
comment | string | Order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
Return Value
TradeResult
Examples
1 2 |
|
1 2 |
|
1 2 |
|
1 2 3 4 |
|
1 2 3 4 |
|
1 2 3 4 |
|
PlaceLimitOrder (7 of 7)
Summary
Place a Limit Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry time |
comment | string | Order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
Return Value
TradeResult
Examples
1 2 |
|
1 2 |
|
1 2 |
|
1 2 3 4 |
|
1 2 3 4 |
|
1 2 3 4 |
|
1 2 3 4 |
|
PlaceLimitOrderAsync (7)¶
PlaceLimitOrderAsync (1 of 7)
Summary
Place limit order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume of trade |
targetPrice | double | Target price (or better) at which the order is filled |
callback | Action | The action when the position closes |
Return Value
TradeOperation
PlaceLimitOrderAsync (2 of 7)
Summary
Place limit order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume of trade |
targetPrice | double | Target price (or better) at which the order is filled |
label | string | Label that represents the order |
callback | Action | The action when the position closes |
Return Value
TradeOperation
PlaceLimitOrderAsync (3 of 7)
Summary
Place limit order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume of trade |
targetPrice | double | Target price (or better) at which the order is filled |
label | string | Label that represents the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
callback | Action | The action when the position closes |
Return Value
TradeOperation
PlaceLimitOrderAsync (4 of 7)
Summary
Place limit order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume of trade |
targetPrice | double | Target price (or better) at which the order is filled |
label | string | Label that represents the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry date and time |
callback | Action | The action when the position closes |
Return Value
TradeOperation
PlaceLimitOrderAsync (5 of 7)
Summary
Place limit order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume of trade |
targetPrice | double | Target price (or better) at which the order is filled |
label | string | Label that represents the order |
stopLossPips | double? | Stop loss in pips from target price |
takeProfitPips | double? | Take profit in pips from target price |
expiration | DateTime? | Order expiry date and time |
comment | string | Order comment |
callback | Action | The action when the position closes |
Return Value
TradeOperation
Examples
1 2 |
|
1 2 |
|
1 2 3 |
|
1 2 3 4 5 6 7 8 |
|
PlaceLimitOrderAsync (6 of 7)
Summary
Place limit order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume of trade |
targetPrice | double | Target price (or better) at which the order is filled |
label | string | Label that represents the order |
stopLossPips | double? | Stop loss in pips from target price |
takeProfitPips | double? | Take profit in pips from target price |
expiration | DateTime? | Order expiry date and time |
comment | string | Order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
callback | Action | The action when the position closes |
Return Value
TradeOperation
Examples
1 2 |
|
1 2 |
|
1 2 3 |
|
1 2 3 4 5 6 7 8 |
|
1 2 3 |
|
PlaceLimitOrderAsync (7 of 7)
Summary
Place limit order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume of trade |
targetPrice | double | Target price (or better) at which the order is filled |
label | string | Label that represents the order |
stopLossPips | double? | Stop loss in pips from target price |
takeProfitPips | double? | Take profit in pips from target price |
expiration | DateTime? | Order expiry date and time |
comment | string | Order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
callback | Action | The action when the position closes |
Return Value
TradeOperation
Examples
1 2 |
|
1 2 |
|
1 2 3 |
|
1 2 3 4 5 6 7 8 |
|
1 2 3 |
|
1 2 3 |
|
PlaceStopOrder (8)¶
PlaceStopOrder (1 of 8)
Summary
Place a stop order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price at which order becomes a market order |
Return Value
TradeResult
PlaceStopOrder (2 of 8)
Summary
Place a stop order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price at which order becomes a market order |
label | string | Representing label |
Return Value
TradeResult
PlaceStopOrder (3 of 8)
Summary
Place a stop order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price at which order becomes a market order |
label | string | Representing label |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
Return Value
TradeResult
PlaceStopOrder (4 of 8)
Summary
Place a stop order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price at which order becomes a market order |
label | string | Representing label |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry time |
Return Value
TradeResult
PlaceStopOrder (5 of 8)
Summary
Place a stop order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price at which order becomes a market order |
label | string | Representing label |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry time |
comment | string | Order comment |
Return Value
TradeResult
Examples
1 |
|
1 2 |
|
1 2 |
|
1 2 3 |
|
1 2 |
|
PlaceStopOrder (6 of 8)
Summary
Place a stop order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price at which order becomes a market order |
label | string | Representing label |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry time |
comment | string | Order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
Return Value
TradeResult
Examples
1 |
|
1 2 |
|
1 2 |
|
1 2 3 |
|
1 2 |
|
1 2 |
|
PlaceStopOrder (7 of 8)
Summary
Place a stop order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price at which order becomes a market order |
label | string | Representing label |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry time |
comment | string | Order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
Return Value
TradeResult
Examples
1 |
|
1 2 |
|
1 2 |
|
1 2 3 |
|
1 2 |
|
1 2 |
|
1 2 |
|
PlaceStopOrder (8 of 8)
Summary
Place a stop order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price at which order becomes a market order |
label | string | Representing label |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry time |
comment | string | Order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
stopOrderTriggerMethod | StopTriggerMethod | Determines how pending order will be triggered in case it's a StopOrder |
Return Value
TradeResult
Examples
1 |
|
1 2 |
|
1 2 |
|
1 2 3 |
|
1 2 |
|
1 2 |
|
1 2 |
|
PlaceStopOrderAsync (8)¶
PlaceStopOrderAsync (1 of 8)
Summary
Place stop order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume of trade |
targetPrice | double | Price at which the order becomes market order |
callback | Action | Action when order is placed |
Return Value
TradeOperation
PlaceStopOrderAsync (2 of 8)
Summary
Place stop order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume of trade |
targetPrice | double | Price at which the order becomes market order |
label | string | Label representing the order |
callback | Action | Action when order is placed |
Return Value
TradeOperation
PlaceStopOrderAsync (3 of 8)
Summary
Place stop order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume of trade |
targetPrice | double | Price at which the order becomes market order |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
callback | Action | Action when order is placed |
Return Value
TradeOperation
PlaceStopOrderAsync (4 of 8)
Summary
Place stop order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume of trade |
targetPrice | double | Price at which the order becomes market order |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry date and time |
callback | Action | Action when order is placed |
Return Value
TradeOperation
PlaceStopOrderAsync (5 of 8)
Summary
Place stop order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume of trade |
targetPrice | double | Price at which the order becomes market order |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry date and time |
comment | string | Order comment |
callback | Action | Action when order is placed |
Return Value
TradeOperation
Examples
1 |
|
1 |
|
1 2 3 |
|
1 2 3 4 5 6 7 8 |
|
PlaceStopOrderAsync (6 of 8)
Summary
Place stop order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume of trade |
targetPrice | double | Price at which the order becomes market order |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry date and time |
comment | string | Order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
callback | Action | Action when order is placed |
Return Value
TradeOperation
Examples
1 |
|
1 |
|
1 2 3 |
|
1 2 3 4 5 6 7 8 |
|
1 2 3 4 5 6 7 8 9 10 11 |
|
PlaceStopOrderAsync (7 of 8)
Summary
Place stop order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume of trade |
targetPrice | double | Price at which the order becomes market order |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry date and time |
comment | string | Order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
callback | Action | Action when order is placed |
Return Value
TradeOperation
Examples
1 |
|
1 |
|
1 2 3 |
|
1 2 3 4 5 6 7 8 |
|
1 2 3 4 5 6 7 8 9 10 11 |
|
1 2 3 4 5 6 7 8 9 10 11 12 |
|
PlaceStopOrderAsync (8 of 8)
Summary
Place stop order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume of trade |
targetPrice | double | Price at which the order becomes market order |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry date and time |
comment | string | Order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
stopOrderTriggerMethod | StopTriggerMethod | Determines how pending order will be triggered in case it's a StopOrder |
callback | Action | Action when order is placed |
Return Value
TradeOperation
Examples
1 |
|
1 |
|
1 2 3 |
|
1 2 3 4 5 6 7 8 |
|
1 2 3 4 5 6 7 8 9 10 11 |
|
1 2 3 4 5 6 7 8 9 10 11 12 |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
|
ExecuteMarketOrder (6)¶
ExecuteMarketOrder (1 of 6)
Summary
Execute a Market Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
Return Value
TradeResult
ExecuteMarketOrder (2 of 6)
Summary
Execute a Market Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
label | string | Representing label |
Return Value
TradeResult
ExecuteMarketOrder (3 of 6)
Summary
Execute a Market Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
label | string | Representing label |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
Return Value
TradeResult
ExecuteMarketOrder (4 of 6)
Summary
Execute a Market Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
label | string | Representing label |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
comment | string | order comment |
Return Value
TradeResult
Examples
1 |
|
1 |
|
1 |
|
1 |
|
1 |
|
ExecuteMarketOrder (5 of 6)
Summary
Execute a Market Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
label | string | Representing label |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
comment | string | order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
Return Value
TradeResult
Examples
1 |
|
1 |
|
1 |
|
1 |
|
1 |
|
1 |
|
ExecuteMarketOrder (6 of 6)
Summary
Execute a Market Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
label | string | Representing label |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
comment | string | order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
Return Value
TradeResult
Examples
1 |
|
1 |
|
1 |
|
1 |
|
1 |
|
1 |
|
1 2 |
|
ExecuteMarketOrderAsync (6)¶
ExecuteMarketOrderAsync (1 of 6)
Summary
Execute a market order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
callback | Action | Event raised when position is opened |
Return Value
TradeOperation
ExecuteMarketOrderAsync (2 of 6)
Summary
Execute a market order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
label | string | Label representing the order |
callback | Action | Event raised when position is opened |
Return Value
TradeOperation
ExecuteMarketOrderAsync (3 of 6)
Summary
Execute a market order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
callback | Action | Event raised when position is opened |
Return Value
TradeOperation
ExecuteMarketOrderAsync (4 of 6)
Summary
Execute a market order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
comment | string | Order comment |
callback | Action | Event raised when position is opened |
Return Value
TradeOperation
Examples
1 |
|
1 |
|
1 |
|
1 |
|
1 |
|
1 2 |
|
ExecuteMarketOrderAsync (5 of 6)
Summary
Execute a market order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
comment | string | Order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
callback | Action | Event raised when position is opened |
Return Value
TradeOperation
Examples
1 |
|
1 |
|
1 |
|
1 |
|
1 |
|
1 2 |
|
1 2 |
|
ExecuteMarketOrderAsync (6 of 6)
Summary
Execute a market order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
comment | string | Order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
callback | Action | Event raised when position is opened |
Return Value
TradeOperation
Examples
1 |
|
1 |
|
1 |
|
1 |
|
1 |
|
1 2 |
|
1 2 |
|
1 2 |
|
ExecuteMarketRangeOrder (6)¶
ExecuteMarketRangeOrder (1 of 6)
Summary
Execute a Market Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
marketRangePips | double | The market range (slippage) in Pips |
basePrice | double | Base price to calculate relative slippage price |
Return Value
TradeResult
ExecuteMarketRangeOrder (2 of 6)
Summary
Execute a Market Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
marketRangePips | double | The market range (slippage) in Pips |
basePrice | double | Base price to calculate relative slippage price |
label | string | Representing label |
Return Value
TradeResult
ExecuteMarketRangeOrder (3 of 6)
Summary
Execute a Market Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
marketRangePips | double | The market range (slippage) in Pips |
basePrice | double | Base price to calculate relative slippage price |
label | string | Representing label |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
Return Value
TradeResult
ExecuteMarketRangeOrder (4 of 6)
Summary
Execute a Market Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
marketRangePips | double | The market range (slippage) in Pips |
basePrice | double | Base price to calculate relative slippage price |
label | string | Representing label |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
comment | string | order comment |
Return Value
TradeResult
Examples
1 |
|
1 |
|
1 |
|
1 |
|
1 |
|
ExecuteMarketRangeOrder (5 of 6)
Summary
Execute a Market Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
marketRangePips | double | The market range (slippage) in Pips |
basePrice | double | Base price to calculate relative slippage price |
label | string | Representing label |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
comment | string | order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
Return Value
TradeResult
Examples
1 |
|
1 |
|
1 |
|
1 |
|
1 |
|
1 |
|
ExecuteMarketRangeOrder (6 of 6)
Summary
Execute a Market Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
marketRangePips | double | The market range (slippage) in Pips |
basePrice | double | Base price to calculate relative slippage price |
label | string | Representing label |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
comment | string | order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
Return Value
TradeResult
Examples
1 |
|
1 |
|
1 |
|
1 |
|
1 |
|
1 |
|
1 2 |
|
ExecuteMarketRangeOrderAsync (6)¶
ExecuteMarketRangeOrderAsync (1 of 6)
Summary
Execute a market order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
marketRangePips | double | The market range (slippage) in Pips |
basePrice | double | Base price to calculate relative slippage price |
callback | Action | Event raised when position is opened |
Return Value
TradeOperation
ExecuteMarketRangeOrderAsync (2 of 6)
Summary
Execute a market order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
marketRangePips | double | The market range (slippage) in Pips |
basePrice | double | Base price to calculate relative slippage price |
label | string | Label representing the order |
callback | Action | Event raised when position is opened |
Return Value
TradeOperation
ExecuteMarketRangeOrderAsync (3 of 6)
Summary
Execute a market order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
marketRangePips | double | The market range (slippage) in Pips |
basePrice | double | Base price to calculate relative slippage price |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
callback | Action | Event raised when position is opened |
Return Value
TradeOperation
ExecuteMarketRangeOrderAsync (4 of 6)
Summary
Execute a market order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
marketRangePips | double | The market range (slippage) in Pips |
basePrice | double | Base price to calculate relative slippage price |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
comment | string | Order comment |
callback | Action | Event raised when position is opened |
Return Value
TradeOperation
Examples
1 |
|
1 |
|
1 |
|
1 |
|
1 |
|
1 2 |
|
ExecuteMarketRangeOrderAsync (5 of 6)
Summary
Execute a market order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
marketRangePips | double | The market range (slippage) in Pips |
basePrice | double | Base price to calculate relative slippage price |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
comment | string | Order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
callback | Action | Event raised when position is opened |
Return Value
TradeOperation
Examples
1 |
|
1 |
|
1 |
|
1 |
|
1 |
|
1 2 |
|
1 2 |
|
ExecuteMarketRangeOrderAsync (6 of 6)
Summary
Execute a market order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
marketRangePips | double | The market range (slippage) in Pips |
basePrice | double | Base price to calculate relative slippage price |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
comment | string | Order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
callback | Action | Event raised when position is opened |
Return Value
TradeOperation
Examples
1 |
|
1 |
|
1 |
|
1 |
|
1 |
|
1 2 |
|
1 2 |
|
1 2 |
|
PlaceStopLimitOrder (8)¶
PlaceStopLimitOrder (1 of 8)
Summary
Place a Stop Limit Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
stopLimitRangePips | double | Maximum distance for order execution from target price |
Return Value
TradeResult
PlaceStopLimitOrder (2 of 8)
Summary
Place a Stop Limit Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
stopLimitRangePips | double | Maximum distance for order execution from target price |
label | string | Label representing the order |
Return Value
TradeResult
PlaceStopLimitOrder (3 of 8)
Summary
Place a Stop Limit Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
stopLimitRangePips | double | Maximum distance for order execution from target price |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
Return Value
TradeResult
PlaceStopLimitOrder (4 of 8)
Summary
Place a Stop Limit Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
stopLimitRangePips | double | Maximum distance for order execution from target price |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry date and time |
Return Value
TradeResult
PlaceStopLimitOrder (5 of 8)
Summary
Place a Stop Limit Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
stopLimitRangePips | double | Maximum distance for order execution from target price |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry date and time |
comment | string | Order comment |
Return Value
TradeResult
PlaceStopLimitOrder (6 of 8)
Summary
Place a Stop Limit Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
stopLimitRangePips | double | Maximum distance for order execution from target price |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry date and time |
comment | string | Order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
Return Value
TradeResult
PlaceStopLimitOrder (7 of 8)
Summary
Place a Stop Limit Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
stopLimitRangePips | double | Maximum distance for order execution from target price |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry date and time |
comment | string | Order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
Return Value
TradeResult
PlaceStopLimitOrder (8 of 8)
Summary
Place a Stop Limit Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
stopLimitRangePips | double | Maximum distance for order execution from target price |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry date and time |
comment | string | Order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
stopOrderTriggerMethod | StopTriggerMethod | Determines how pending order will be triggered in case it's a StopLimitOrder |
Return Value
TradeResult
PlaceStopLimitOrderAsync (8)¶
PlaceStopLimitOrderAsync (1 of 8)
Summary
Place Stop Limit order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
stopLimitRangePips | double | Maximum distance for order execution from target price |
callback | Action | Action when order is placed |
Return Value
TradeOperation
PlaceStopLimitOrderAsync (2 of 8)
Summary
Place Stop Limit order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
stopLimitRangePips | double | Maximum distance for order execution from target price |
label | string | Label representing the order |
callback | Action | Action when order is placed |
Return Value
TradeOperation
PlaceStopLimitOrderAsync (3 of 8)
Summary
Place Stop Limit order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
stopLimitRangePips | double | Maximum distance for order execution from target price |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
callback | Action | Action when order is placed |
Return Value
TradeOperation
PlaceStopLimitOrderAsync (4 of 8)
Summary
Place Stop Limit order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
stopLimitRangePips | double | Maximum distance for order execution from target price |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry date and time |
callback | Action | Action when order is placed |
Return Value
TradeOperation
PlaceStopLimitOrderAsync (5 of 8)
Summary
Place Stop Limit order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
stopLimitRangePips | double | Maximum distance for order execution from target price |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry date and time |
comment | string | Order comment |
callback | Action | Action when order is placed |
Return Value
TradeOperation
PlaceStopLimitOrderAsync (6 of 8)
Summary
Place Stop Limit order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
stopLimitRangePips | double | Maximum distance for order execution from target price |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry date and time |
comment | string | Order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
callback | Action | Action when order is placed |
Return Value
TradeOperation
PlaceStopLimitOrderAsync (7 of 8)
Summary
Place Stop Limit order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
stopLimitRangePips | double | Maximum distance for order execution from target price |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry date and time |
comment | string | Order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
callback | Action | Action when order is placed |
Return Value
TradeOperation
PlaceStopLimitOrderAsync (8 of 8)
Summary
Place Stop Limit order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
tradeType | TradeType | Direction of trade |
symbolName | string | Symbol name of trade |
volume | double | Volume (in units) of trade |
targetPrice | double | Price (or better) at which order is filled |
stopLimitRangePips | double | Maximum distance for order execution from target price |
label | string | Label representing the order |
stopLossPips | double? | Stop loss in pips |
takeProfitPips | double? | Take profit in pips |
expiration | DateTime? | Order expiry date and time |
comment | string | Order comment |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
stopOrderTriggerMethod | StopTriggerMethod | Determines how pending order will be triggered in case it's a StopLimitOrder |
callback | Action | Action when order is placed |
Return Value
TradeOperation
ReversePosition (2)¶
ReversePosition (1 of 2)
Summary
Modify the direction of trade at position
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
position | Position | Position which is affected |
Return Value
TradeResult
Examples
1 2 3 4 5 |
|
ReversePosition (2 of 2)
Summary
Modify the direction of trade and volume of a position
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
position | Position | Position which is affected |
volume | double | Volume (in units) of Trade |
Return Value
TradeResult
Examples
1 2 3 4 5 |
|
ModifyPosition (4)¶
ModifyPosition (1 of 4)
Summary
Modify the volume of a position
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
position | Position | Position which is affected |
volume | double | Volume (in units) of Trade |
Return Value
TradeResult
Examples
1 2 3 4 5 |
|
ModifyPosition (2 of 4)
Summary
Modify the protection of a position
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
position | Position | Position which is affected |
stopLoss | double? | New stop loss price |
takeProfit | double? | New take profit price |
Return Value
TradeResult
Examples
1 2 3 4 5 6 7 |
|
ModifyPosition (3 of 4)
Summary
Modify the protection of a position
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
position | Position | Position which is affected |
stopLoss | double? | New stop loss price |
takeProfit | double? | New take profit price |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
Return Value
TradeResult
Examples
1 2 3 4 5 6 7 |
|
1 2 3 4 5 6 7 8 9 |
|
ModifyPosition (4 of 4)
Summary
Modify the protection of a position
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
position | Position | Position which is affected |
stopLoss | double? | New stop loss price |
takeProfit | double? | New take profit price |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
Return Value
TradeResult
Examples
1 2 3 4 5 6 7 |
|
1 2 3 4 5 6 7 8 9 |
|
1 2 3 4 5 6 7 8 9 |
|
ClosePosition (3)¶
ClosePosition (1 of 3)
Summary
Close a position
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
position | Position | Position to close |
Return Value
TradeResult
ClosePosition (2 of 3)
Summary
Close a position
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
position | Position | Position to close |
volume | long | Volume which is closed |
Return Value
TradeResult
Examples
1 |
|
1 2 |
|
ClosePosition (3 of 3)
Summary
Close a position
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
position | Position | Position to close |
volume | double | Volume which is closed |
Return Value
TradeResult
Examples
1 |
|
1 2 |
|
ClosePositionAsync (3)¶
ClosePositionAsync (1 of 3)
Summary
Close a position in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
position | Position | The position to close |
callback | Action | The action when the position closes |
Return Value
TradeOperation
ClosePositionAsync (2 of 3)
Summary
Close a position in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
position | Position | The position to close |
volume | long | The volume to close |
callback | Action | The action when the position closes |
Return Value
TradeOperation
Examples
1 |
|
1 2 |
|
ClosePositionAsync (3 of 3)
Summary
Close a position in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
position | Position | The position to close |
volume | double | The volume to close |
callback | Action | The action when the position closes |
Return Value
TradeOperation
Examples
1 |
|
1 2 |
|
ReversePositionAsync (2)¶
ReversePositionAsync (1 of 2)
Summary
Modify Position in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
position | Position | Position to modify |
callback | Action | Method that is called when position is modified |
Return Value
TradeOperation
Examples
1 2 3 4 5 |
|
ReversePositionAsync (2 of 2)
Summary
Modify Position in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
position | Position | Position to modify |
volume | double | New volume |
callback | Action | Method that is called when position is modified |
Return Value
TradeOperation
Examples
1 2 3 4 5 |
|
ModifyPositionAsync (4)¶
ModifyPositionAsync (1 of 4)
Summary
Modify Position in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
position | Position | Position to modify |
volume | double | New volume |
callback | Action | Method that is called when position is modified |
Return Value
TradeOperation
Examples
1 2 3 4 5 |
|
ModifyPositionAsync (2 of 4)
Summary
Modify Position in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
position | Position | Position to modify |
stopLoss | double? | New stop loss price |
takeProfit | double? | New take profit price |
callback | Action | Method that is called when position is modified |
Return Value
TradeOperation
Examples
1 2 3 4 5 6 7 |
|
ModifyPositionAsync (3 of 4)
Summary
Modify Position in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
position | Position | Position to modify |
stopLoss | double? | New stop loss price |
takeProfit | double? | New take profit price |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
callback | Action | Method that is called when position is modified |
Return Value
TradeOperation
Examples
1 2 3 4 5 6 7 |
|
1 2 3 4 5 6 7 8 |
|
ModifyPositionAsync (4 of 4)
Summary
Modify Position in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
position | Position | Position to modify |
stopLoss | double? | New stop loss price |
takeProfit | double? | New take profit price |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
callback | Action | Method that is called when position is modified |
Return Value
TradeOperation
Examples
1 2 3 4 5 6 7 |
|
1 2 3 4 5 6 7 8 |
|
CancelPendingOrder¶
Summary
Cancel a Pending Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
pendingOrder | PendingOrder | Pending Order which is affected |
Return Value
TradeResult
Examples
1 2 3 4 |
|
ModifyPendingOrder (9)¶
ModifyPendingOrder (1 of 9)
Summary
Modify a Pending Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
pendingOrder | PendingOrder | Pending Order which is affected |
targetPrice | double | New target price |
Return Value
TradeResult
Examples
1 2 3 4 5 |
|
ModifyPendingOrder (2 of 9)
Summary
Modify a Pending Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
pendingOrder | PendingOrder | Pending Order which is affected |
targetPrice | double | New target price |
stopLossPips | double? | New stop loss pips value from target price |
takeProfitPips | double? | New take profit pips value from target price |
Return Value
TradeResult
Examples
1 2 3 4 5 |
|
ModifyPendingOrder (3 of 9)
Summary
Modify a Pending Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
pendingOrder | PendingOrder | Pending Order which is affected |
targetPrice | double | New target price |
stopLossPips | double? | New stop loss pips value from target price |
takeProfitPips | double? | New take profit pips value from target price |
expirationTime | DateTime? | New order expiration time |
Return Value
TradeResult
Examples
1 2 3 4 5 6 |
|
ModifyPendingOrder (4 of 9)
Summary
Modify a Pending Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
pendingOrder | PendingOrder | Pending Order which is affected |
targetPrice | double | New target price |
stopLossPips | double? | New stop loss pips value from target price |
takeProfitPips | double? | New take profit pips value from target price |
expirationTime | DateTime? | New order expiration time |
volume | long | New volume in units for the order |
Return Value
TradeResult
Examples
1 2 3 4 5 6 |
|
ModifyPendingOrder (5 of 9)
Summary
Modify a Pending Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
pendingOrder | PendingOrder | Pending Order which is affected |
targetPrice | double | New target price |
stopLossPips | double? | New stop loss pips value from target price |
takeProfitPips | double? | New take profit pips value from target price |
expirationTime | DateTime? | New order expiration time |
volume | double | New volume in units for the order |
Return Value
TradeResult
Examples
1 2 3 4 5 6 |
|
ModifyPendingOrder (6 of 9)
Summary
Modify a Pending Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
pendingOrder | PendingOrder | Pending Order which is affected |
targetPrice | double | New target price |
stopLossPips | double? | New stop loss pips value from target price |
takeProfitPips | double? | New take profit pips value from target price |
expirationTime | DateTime? | New order expiration time |
volume | double | New volume in units for the order |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
Return Value
TradeResult
Examples
1 2 3 4 5 6 |
|
1 2 3 4 5 6 7 |
|
ModifyPendingOrder (7 of 9)
Summary
Modify a Pending Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
pendingOrder | PendingOrder | Pending Order which is affected |
targetPrice | double | New target price |
stopLossPips | double? | New stop loss pips value from target price |
takeProfitPips | double? | New take profit pips value from target price |
expirationTime | DateTime? | New order expiration time |
volume | double | New volume in units for the order |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
Return Value
TradeResult
Examples
1 2 3 4 5 6 7 |
|
ModifyPendingOrder (8 of 9)
Summary
Modify a Pending Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
pendingOrder | PendingOrder | Pending Order which is affected |
targetPrice | double | New target price |
stopLossPips | double? | New stop loss pips value from target price |
takeProfitPips | double? | New take profit pips value from target price |
expirationTime | DateTime? | New order expiration time |
volume | double | New volume in units for the order |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
stopOrderTriggerMethod | StopTriggerMethod? | Determines how pending order will be triggered in case it's a StopOrder |
Return Value
TradeResult
Examples
1 2 3 4 5 6 |
|
1 2 3 4 5 6 7 |
|
1 2 3 4 5 6 7 |
|
ModifyPendingOrder (9 of 9)
Summary
Modify a Pending Order
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
pendingOrder | PendingOrder | Pending Order which is affected |
targetPrice | double | New target price |
stopLossPips | double? | New stop loss pips value from target price |
takeProfitPips | double? | New take profit pips value from target price |
expirationTime | DateTime? | New order expiration time |
volume | double | New volume in units for the order |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
stopOrderTriggerMethod | StopTriggerMethod? | Determines how pending order will be triggered in case it's a StopOrder |
stopLimitRangePips | double? | Maximum distance for order execution from target price |
Return Value
TradeResult
Examples
1 2 3 4 5 6 |
|
1 2 3 4 5 6 7 |
|
1 2 3 4 5 6 7 |
|
CancelPendingOrderAsync¶
Summary
Cancel a Pending Order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
pendingOrder | PendingOrder | Pending Order to cancel |
callback | Action | Method that is called when pending order is cancelled |
Return Value
TradeOperation
Examples
1 2 3 4 5 |
|
ModifyPendingOrderAsync (9)¶
ModifyPendingOrderAsync (1 of 9)
Summary
Modify a Pending Order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
pendingOrder | PendingOrder | Pending Order to modify |
targetPrice | double | New target price at which the order becomes market order |
callback | Action | Method that is called when order is modified |
Return Value
TradeOperation
Examples
1 2 3 4 5 |
|
ModifyPendingOrderAsync (2 of 9)
Summary
Modify a Pending Order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
pendingOrder | PendingOrder | Pending Order to modify |
targetPrice | double | New target price at which the order becomes market order |
stopLossPips | double? | New stop loss |
takeProfitPips | double? | New take profit |
callback | Action | Method that is called when order is modified |
Return Value
TradeOperation
Examples
1 2 3 4 5 |
|
ModifyPendingOrderAsync (3 of 9)
Summary
Modify a Pending Order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
pendingOrder | PendingOrder | Pending Order to modify |
targetPrice | double | New target price at which the order becomes market order |
stopLossPips | double? | New stop loss |
takeProfitPips | double? | New take profit |
expirationTime | DateTime? | New expiry date and time |
callback | Action | Method that is called when order is modified |
Return Value
TradeOperation
Examples
1 2 3 4 5 6 |
|
ModifyPendingOrderAsync (4 of 9)
Summary
Modify a Pending Order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
pendingOrder | PendingOrder | Pending Order to modify |
targetPrice | double | New target price at which the order becomes market order |
stopLossPips | double? | New stop loss |
takeProfitPips | double? | New take profit |
expirationTime | DateTime? | New expiry date and time |
volume | long | New volume in units for the order |
callback | Action | Method that is called when order is modified |
Return Value
TradeOperation
Examples
1 2 3 4 5 6 7 |
|
ModifyPendingOrderAsync (5 of 9)
Summary
Modify a Pending Order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
pendingOrder | PendingOrder | Pending Order to modify |
targetPrice | double | New target price at which the order becomes market order |
stopLossPips | double? | New stop loss |
takeProfitPips | double? | New take profit |
expirationTime | DateTime? | New expiry date and time |
volume | double | New volume in units for the order |
callback | Action | Method that is called when order is modified |
Return Value
TradeOperation
Examples
1 2 3 4 5 6 7 |
|
ModifyPendingOrderAsync (6 of 9)
Summary
Modify a Pending Order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
pendingOrder | PendingOrder | Pending Order to modify |
targetPrice | double | New target price at which the order becomes market order |
stopLossPips | double? | New stop loss |
takeProfitPips | double? | New take profit |
expirationTime | DateTime? | New expiry date and time |
volume | double | New volume in units for the order |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
stopOrderTriggerMethod | StopTriggerMethod? | Determines how pending order will be triggered in case it's a StopOrder |
callback | Action | Method that is called when order is modified |
Return Value
TradeOperation
Examples
1 2 3 4 5 6 7 |
|
ModifyPendingOrderAsync (7 of 9)
Summary
Modify a Pending Order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
pendingOrder | PendingOrder | Pending Order to modify |
targetPrice | double | New target price at which the order becomes market order |
stopLossPips | double? | New stop loss |
takeProfitPips | double? | New take profit |
expirationTime | DateTime? | New expiry date and time |
volume | double | New volume in units for the order |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
callback | Action | Method that is called when order is modified |
Return Value
TradeOperation
Examples
1 2 3 4 5 6 7 |
|
ModifyPendingOrderAsync (8 of 9)
Summary
Modify a Pending Order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
pendingOrder | PendingOrder | Pending Order to modify |
targetPrice | double | New target price at which the order becomes market order |
stopLossPips | double? | New stop loss |
takeProfitPips | double? | New take profit |
expirationTime | DateTime? | New expiry date and time |
volume | double | New volume in units for the order |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
callback | Action | Method that is called when order is modified |
Return Value
TradeOperation
Examples
1 2 3 4 5 6 7 |
|
ModifyPendingOrderAsync (9 of 9)
Summary
Modify a Pending Order in asynchronous execution mode
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
pendingOrder | PendingOrder | Pending Order to modify |
targetPrice | double | New target price at which the order becomes market order |
stopLossPips | double? | New stop loss |
takeProfitPips | double? | New take profit |
expirationTime | DateTime? | New expiry date and time |
volume | double | New volume in units for the order |
hasTrailingStop | bool | Enable/disable TrailingStop for position |
stopLossTriggerMethod | StopTriggerMethod? | Trigger method for position's StopLoss |
stopOrderTriggerMethod | StopTriggerMethod? | Determines how pending order will be triggered in case it's a StopOrder |
stopLimitRangePips | double? | Maximum distance for order execution from target price |
callback | Action | Method that is called when order is modified |
Return Value
TradeOperation
Examples
1 2 3 4 5 6 |
|
1 2 3 4 5 6 7 |
|
1 2 3 4 5 6 7 |
|
1 2 3 4 5 6 7 |
|
Properties¶
Server¶
Summary
Server related information.
Signature
1 |
|
Return Value
IServer
Examples
1 2 3 4 |
|
Timer¶
Summary
Access to the Timer object.
Signature
1 |
|
Return Value
Timer
Examples
1 2 3 4 5 6 7 8 |
|
TimeZone¶
Summary
TimeZone of a Plugin.
Signature
1 |
|
Return Value
TimeZoneInfo
Time¶
Summary
Returns the current server time. The shortcut to the Server.Time property.
Signature
1 |
|
Return Value
DateTime
Examples
1 2 3 4 |
|
TimeInUtc¶
Summary
Returns the current server time in UTC. The shortcut to the Server.TimeInUtc property.
Signature
1 |
|
Return Value
DateTime
Examples
1 2 3 4 |
|
Application¶
Summary
Represents the application.
Signature
1 |
|
Return Value
Application
Symbols¶
Summary
Gets the symbol names.
Signature
1 |
|
Return Value
Symbols
Asp¶
Summary
Gets the active symbol panel.
Signature
1 |
|
Return Value
Asp
Account¶
Summary
Contains all Account information
Signature
1 |
|
Return Value
IAccount
Examples
1 2 3 4 5 6 7 |
|
AssetConverter¶
Summary
Converts an asset to another asset.
Signature
1 |
|
Return Value
IAssetConverter
Related Tutorials
Assets¶
Summary
Returns list of all available assets.
Signature
1 |
|
Return Value
Assets
History¶
Summary
Represents the collection of all historical trades of the account.
Signature
1 |
|
Return Value
History
Examples
1 2 3 4 |
|
Permissions¶
Summary
Contains all Permissions information
Signature
1 |
|
Return Value
Permissions
TradeWatch¶
Summary
Gets the Trade Watch panel.
Signature
1 |
|
Return Value
TradeWatch
MarketSessions¶
Summary
Returns current market sessions.
Signature
1 |
|
Return Value
MarketSession
Related Tutorials
Watchlists¶
Summary
Gets the watchlist.
Signature
1 |
|
Return Value
Watchlists
Http¶
Summary
Send HTTP requests.
Signature
1 |
|
Return Value
Http
Related Tutorials
Notifications¶
Summary
Represents the notifications, such as sounds and email.
Signature
1 |
|
Return Value
INotifications
Examples
1 |
|
1 2 |
|
ChartManager¶
Summary
Returns chart manager.
Signature
1 |
|
Return Value
ChartManager
MarketData¶
Summary
Provides access to Market Data.
Signature
1 |
|
Return Value
MarketData
Examples
1 2 |
|
LocalStorage¶
Summary
Access the local storage API.
Signature
1 |
|
Return Value
LocalStorage
Related Tutorials
AlgoRegistry¶
Summary
Provides access to installed Algorithms.
Signature
1 |
|
Return Value
AlgoRegistry
Related Tutorials
Backtesting¶
Summary
%DOCUMENTATION%
Signature
1 |
|
Return Value
Backtesting
Indicators¶
Summary
Access to the built-in Indicators.
Signature
1 |
|
Return Value
IIndicatorsAccessor
Examples
1 2 3 4 5 |
|
Related Tutorials
Commands¶
Summary
Provides access to commands.
Signature
1 |
|
Return Value
Commands
LastResult¶
Summary
The latest trade result
Signature
1 |
|
Return Value
TradeResult
Examples
1 2 3 |
|
Positions¶
Summary
The list of all open positions of the account.
Signature
1 |
|
Return Value
Positions
Examples
1 2 3 4 5 |
|
PendingOrders¶
Summary
The array of all Pending Orders of the account.
Signature
1 |
|
Return Value
PendingOrders
Examples
1 2 3 4 5 6 |
|
Events¶
MarketSessionsChanged¶
Summary
Occurs when market sessions change.
Signature
1 |
|