Robot¶
Summary¶
Base class for all cBots.
Remarks¶
Provides a convenient framework for creating cBots including methods to create, modify, cancel orders and closepositions, methods triggered by each tick and each bar, access to built-in Indicators and more.
Signature
1 | |
Namespace¶
cAlgo.API
Examples¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | |
Methods¶
OnStart¶
Summary
Called when cBot is being started. Override this method to initialize cBot, create nested indicators, etc.
Signature
1 | |
Return Value
void
Examples
1 2 3 4 | |
OnStop¶
Summary
Called when cBot is stopped.
Signature
1 | |
Return Value
void
Examples
1 2 3 4 | |
OnTick¶
Summary
Called on each incoming market tick.
Signature
1 | |
Return Value
void
Examples
1 2 3 4 | |
OnBar¶
Summary
Called on each incoming Bar.
Signature
1 | |
Return Value
void
Examples
1 2 3 4 | |
OnBarClosed¶
Summary
Called when a new bar is opened; the method is called for the previous (closed) bar.
Signature
1 | |
Return Value
void
OnError¶
Summary
Called if there is an error executing a trade operation.
Signature
1 | |
Parameters
| Name | Type | Description |
|---|---|---|
| error | Error | Error description. |
Return Value
void
Examples
1 2 3 4 | |
Stop¶
Summary
Stops the cBot. cBot will be completely stopped and will not send/receive any signals.
Signature
1 | |
Return Value
void
Examples
1 2 3 4 5 | |
ToString¶
Summary
Returns the cBot class name
Signature
1 | |
Return Value
string
Examples
1 2 3 4 | |
GetFitness¶
Summary
Override this method to provide custom fitness value for Optimization
Signature
1 | |
Parameters
| Name | Type | Description |
|---|---|---|
| args | GetFitnessArgs |
Return Value
double
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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 | |
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 | |
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 |
| stopLoss | double? | New Stop loss |
| takeProfit | double? | New Take profit |
| protectionType | ProtectionType? | New Protection type |
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 |
| stopLoss | double? | New Stop loss |
| takeProfit | double? | New Take profit |
| protectionType | ProtectionType? | New Protection type |
| 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 |
| stopLoss | double? | New Stop loss |
| takeProfit | double? | New Take profit |
| protectionType | ProtectionType? | New Protection type |
| 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 |
| stopLoss | double? | New Stop loss |
| takeProfit | double? | New Take profit |
| protectionType | ProtectionType? | New Protection type |
| 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 |
| stopLoss | double? | New Stop loss |
| takeProfit | double? | New Take profit |
| protectionType | ProtectionType? | New Protection type |
| 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 |
| stopLoss | double? | New Stop loss |
| takeProfit | double? | New Take profit |
| protectionType | ProtectionType? | New Protection type |
| 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 |
| stopLoss | double? | New Stop loss |
| takeProfit | double? | New Take profit |
| protectionType | ProtectionType? | New Protection type |
| 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 is 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 |
| stopLoss | double? | New Stop loss |
| takeProfit | double? | New Take profit |
| protectionType | ProtectionType? | New Protection type |
| 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 is 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 |
| stopLoss | double? | New Stop loss |
| takeProfit | double? | New Take profit |
| protectionType | ProtectionType? | New Protection type |
| 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 |
| stopLoss | double? | New Stop loss |
| takeProfit | double? | New Take profit |
| protectionType | ProtectionType? | New Protection type |
| 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 |
| stopLoss | double? | New Stop loss |
| takeProfit | double? | New Take profit |
| protectionType | ProtectionType? | New Protection type |
| 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 |
| stopLoss | double? | New Stop loss |
| takeProfit | double? | New Take profit |
| protectionType | ProtectionType? | New Protection type |
| 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 |
| stopLoss | double? | New Stop loss |
| takeProfit | double? | New Take profit |
| protectionType | ProtectionType? | New Protection type |
| 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 is 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 |
| stopLoss | double? | New Stop loss |
| takeProfit | double? | New Take profit |
| protectionType | ProtectionType? | New Protection type |
| 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 |
| stopLoss | double? | New Stop loss |
| takeProfit | double? | New Take profit |
| protectionType | ProtectionType? | New Protection type |
| 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 |
| stopLoss | double? | New Stop loss |
| takeProfit | double? | New Take profit |
| protectionType | ProtectionType? | New Protection type |
| 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 is 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 | |
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 |
| takeProfit | double? | New take profit |
| protectionType | ProtectionType? | Protection type |
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 |
| takeProfit | double? | New take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| takeProfit | double? | New take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| takeProfit | double? | New take profit |
| protectionType | ProtectionType? | New protection type |
| 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 |
| protectionType | ProtectionType? | New protection type |
| 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 |
| takeProfit | double? | New take profit |
| protectionType | ProtectionType? | New protection type |
| 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 | |
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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 is 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 is a StopLimitOrder |
| callback | Action | Action when order is placed |
Return Value
TradeOperation
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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 is 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 |
| stopLoss | double? | Stop loss |
| takeProfit | double? | Take profit |
| protectionType | ProtectionType? | Protection type |
| 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 is 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 | |
Properties¶
Account¶
Summary
Contains all Account information
Signature
1 | |
Return Value
IAccount
Examples
1 2 3 4 5 6 7 | |
LastResult¶
Summary
The latest trade result
Signature
1 | |
Return Value
TradeResult
Examples
1 2 3 | |