cTrader

https://help.ctrader.com/
Admin
cTrader is a multi-asset trading platform offering a comprehensive suite of tools for manual and...
Tokens:2,574,547
Snippets:23,637
Trust Score:9.6
Update:1 week ago
Show doc for...
Tokens:
Raw
### C# Example: Installing an Algo Asynchronously

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/InstallationOperation?q=

Use this C# example to install an algo asynchronously with AlgoRegistry.InstallAsync. The callback prints the error if installation fails, and the operation's IsExecuting property is printed after starting.

```csharp
 [Robot(AccessRights = AccessRights.None)]
 public class TestExample : Robot
 {
     protected override void OnStart()
     {
         var operation = AlgoRegistry.InstallAsync("path/to-algo-file.algo", result => 
         {
             if (!result.Succeeded)
                 Print(result.Error);
         });
         Print($"Is Executing: {operation.IsExecuting}");
     }
 }

```

--------------------------------

### Using AlgoRegistry to Get, Iterate, and Install Algorithms

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/AlgoRegistry

Shows how to use AlgoRegistry.Get to retrieve algorithm types, iterate over all algorithms, subscribe to events, and install an algorithm file. The example prints names, parameters, lines, and bars for indicators, robots, and plugins, and handles installation errors.

```csharp
# Import cAlgo API types
from cAlgo.API import *
# Import trading wrapper functions
from robot_wrapper import *
class Test():
    def on_start(self):
        indicatorType = api.AlgoRegistry.Get("Simple Moving Average", AlgoKind.StandardIndicator)
        if indicatorType is not None:
            smaIndicatorType = IndicatorType(indicatorType)
            print(f"Name: {smaIndicatorType.Name} | Parameters #: {smaIndicatorType.Parameters.Count} | Lines #: {smaIndicatorType.Lines.Count} | Bars: {smaIndicatorType.Bars.Count}")
        robotType = api.AlgoRegistry.Get("Sample Break Even", AlgoKind.Robot)
        if robotType is not None:
            breakEventRobotType = RobotType(robotType)
            print(f"Name: {breakEventRobotType.Name} | Parameters #: {breakEventRobotType.Parameters.Count}")
        pluginType = api.AlgoRegistry.Get("Sample Test Plugin", AlgoKind.Plugin)
        if pluginType is not None:
            testPluginType = PluginType(pluginType)
            print(f"Name: {testPluginType.Name} | Parameters #: {testPluginType.Parameters.Count}")
        for algo in api.AlgoRegistry:
            print(f"Name: {algo.Name} | Kind: {algo.AlgoKind}")
        api.AlgoRegistry.AlgoTypeChanged += lambda args : print(f"Algo updated: {args.AlgoTypeName}")
        api.AlgoRegistry.AlgoTypeDeleted += lambda args : print(f"Algo deleted: {args.AlgoTypeName}")
        api.AlgoRegistry.AlgoTypeInstalled += lambda args : print(f"Algo installed: {args.AlgoTypeName}")
        result = api.AlgoRegistry.Install("path/to-algo-file.algo")
        if result.Succeeded == False:
            print(f"Algo installation failed with error: {result.Error}")
```

--------------------------------

### C# example using AlgoRegistry.InstallAsync

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/InstallationOperation

C# example showing how to install an algo asynchronously using AlgoRegistry.InstallAsync, checking the operation's IsExecuting property and printing the error if the installation fails.

```csharp
[Robot(AccessRights = AccessRights.None)]
public class TestExample : Robot
{
    protected override void OnStart()
    {
        var operation = AlgoRegistry.InstallAsync("path/to-algo-file.algo", result => 
        {
            if (!result.Succeeded)
                Print(result.Error);
        });
        Print($"Is Executing: {operation.IsExecuting}");
    }
}
```

--------------------------------

### Python example using AlgoRegistry.InstallAsync

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/InstallationOperation

Python example showing how to install an algo asynchronously using AlgoRegistry.InstallAsync, checking the operation's IsExecuting property and printing the error if the installation fails.

```python
import clr
clr.AddReference("cAlgo.API")
# Import cAlgo API types
from cAlgo.API import *
# Import trading wrapper functions
from robot_wrapper import *
from System import Action
class Test():
    def on_start(self):
        operation = api.AlgoRegistry.InstallAsync("path/to-algo-file.algo", Action[InstallationResult](self.on_installation_operation_completed))
        print(f"Is Executing: {operation.IsExecuting}")
    def on_installation_operation_completed(self, result):
        if result.Succeeded == False:
            print(result.Error)
```

--------------------------------

### Python Example: Installing an Algo Asynchronously

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/InstallationOperation?q=

Use this Python example to install an algo asynchronously with api.AlgoRegistry.InstallAsync. The callback method on_installation_operation_completed prints the error if installation fails, and the operation's IsExecuting property is printed after starting.

```python
 import clr
 clr.AddReference("cAlgo.API")
 # Import cAlgo API types
 from cAlgo.API import *
 # Import trading wrapper functions
 from robot_wrapper import *
 from System import Action
 class Test():
     def on_start(self):
         operation = api.AlgoRegistry.InstallAsync("path/to-algo-file.algo", Action[InstallationResult](self.on_installation_operation_completed))
         print(f"Is Executing: {operation.IsExecuting}")
     def on_installation_operation_completed(self, result):
         if result.Succeeded == False:
             print(result.Error)

```

--------------------------------

### C# example: Install algo and handle error

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/InstallationError?q=

C# example showing how to install an algo file using AlgoRegistry.Install and handle failure by printing the error.

```csharp
[Robot(AccessRights = AccessRights.None)]
public class TestExample : Robot
{
    protected override void OnStart()
    {
        var result = AlgoRegistry.Install("path/to-algo-file.algo");
        if (!result.Succeeded)
            Print($"Algo installation failed with error: {result.Error}");
    }
}

```

--------------------------------

### Python example: Install algo and handle error

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/InstallationError?q=

Python example showing how to install an algo file using api.AlgoRegistry.Install and handle failure by printing the error.

```python
import clr
clr.AddReference("cAlgo.API")
# Import cAlgo API types
from cAlgo.API import *
# Import trading wrapper functions
from robot_wrapper import *
class Test():
    def on_start(self):
        result = api.AlgoRegistry.Install("path/to-algo-file.algo")
        if result.Succeeded == False:
            print(f"Algo installation failed with error: {result.Error}")

```

--------------------------------

### C# example: Install algo and check result

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/InstallationResult

Shows how to install an algo file using AlgoRegistry.Install and check the result. If the installation fails, the error message is printed.

```csharp
[Robot(AccessRights = AccessRights.None)]
public class TestExample : Robot
{
    protected override void OnStart()
    {
        var result = AlgoRegistry.Install("path/to-algo-file.algo");
        if (!result.Succeeded)
            Print($"Algo installation failed with error: {result.Error}");
    }
}
```

--------------------------------

### Start a plugin - prompt example

Source: https://help.ctrader.com/ctrader-ai-agent-connect/local-mcp/plugins?q=

Use this prompt to start a specific plugin by name through the cTrader local MCP server.

```text
Start the plugin called 'Trade copier'.

```

--------------------------------

### C# Example: Using AlgoRegistry

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/AlgoRegistry?q=

Shows how to use AlgoRegistry in C# to retrieve algorithm types, enumerate all algorithms, subscribe to events, and install an algorithm. It demonstrates the usage of Get, AlgoTypeChanged, AlgoTypeDeleted, AlgoTypeInstalled, and Install methods.

```csharp
 [Robot(AccessRights = AccessRights.None)]
 public class TestExample : Robot
 {
     protected override void OnStart()
     {
         if (AlgoRegistry.Get("Simple Moving Average", AlgoKind.StandardIndicator) is IndicatorType smaIndicatorType)
             Print($"Name: {smaIndicatorType.Name} | Parameters #: {smaIndicatorType.Parameters.Count} | Lines #: {smaIndicatorType.Lines.Count} | Bars: {smaIndicatorType.Bars.Count}");
         if (AlgoRegistry.Get("Sample Break Even", AlgoKind.Robot) is RobotType robotType)
             Print($"Name: {robotType.Name} | Parameters #: {robotType.Parameters.Count}");
         if (AlgoRegistry.Get("Sample Test Plugin", AlgoKind.Plugin) is PluginType pluginType)
             Print($"Name: {pluginType.Name} | Parameters #: {pluginType.Parameters.Count}");
         foreach (var algo in AlgoRegistry)
         {
             Print($"Name: {algo.Name} | Kind: {algo.AlgoKind}");
         }
         AlgoRegistry.AlgoTypeChanged += args => Print($"Algo updated: {args.AlgoTypeName}");
         AlgoRegistry.AlgoTypeDeleted += args => Print($"Algo deleted: {args.AlgoTypeName}");
         AlgoRegistry.AlgoTypeInstalled += args => Print($"Algo installed: {args.AlgoTypeName}");
         var result = AlgoRegistry.Install("path/to-algo-file.algo");
         if (!result.Succeeded)
             Print($"Algo installation failed with error: {result.Error}");
     }
 }
```

--------------------------------

### Python example: Install algo and check result

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/InstallationResult

Shows how to install an algo file using api.AlgoRegistry.Install and check the result. If the installation fails, the error message is printed.

```python
import clr
clr.AddReference("cAlgo.API")
# Import cAlgo API types
from cAlgo.API import *
# Import trading wrapper functions
from robot_wrapper import *
class Test():
    def on_start(self):
        result = api.AlgoRegistry.Install("path/to-algo-file.algo")
        if result.Succeeded == False:
            print(f"Algo installation failed with error: {result.Error}")
```

--------------------------------

### MarketData example (C#)

Source: https://help.ctrader.com/ctrader-algo/references/General/Algo?q=

C# example from Example 1 showing how to get market depth.

```C#
private MarketDepth _md;
_md = MarketData.GetMarketDepth("GBPUSD");
```

--------------------------------

### Python Example: Using AlgoRegistry

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/AlgoRegistry?q=

Shows how to use AlgoRegistry in Python to retrieve algorithm types, enumerate all algorithms, subscribe to events, and install an algorithm. It demonstrates the usage of Get, AlgoTypeChanged, AlgoTypeDeleted, AlgoTypeInstalled, and Install methods.

```python
 import clr
 clr.AddReference("cAlgo.API")

```

--------------------------------

### MarketData example (Python)

Source: https://help.ctrader.com/ctrader-algo/references/General/Algo?q=

Python example from Example 2 showing how to get market depth.

```Python
md = api.MarketData.GetMarketDepth("GBPUSD")
```

--------------------------------

### Install an algo from another algo using AlgoRegistry.Install

Source: https://help.ctrader.com/ctrader-algo/guides/algo-registry

This cBot installs another cBot from a URL when it starts. It uses AlgoRegistry.Install and prints whether the installation succeeded. The OnTick and OnStop methods are empty placeholders.

```csharp
using System;
using cAlgo.API;
using cAlgo.API.Collections;
using cAlgo.API.Indicators;
using cAlgo.API.Internals;

namespace cAlgo.Robots
{
    [Robot(AccessRights = AccessRights.None, AddIndicators = true)]
    public class Installation : Robot
    {
        protected override void OnStart()
        {
            InstallationResult result = AlgoRegistry.Install("https://ctrader.com/algos/download/4392/");
            Print(result.Succeeded);
        }

        protected override void OnTick()
        {
        }

        protected override void OnStop()
        {
        }
    }
}

```

--------------------------------

### C# Example: Using AlgoRegistry to access and manage algorithms

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/AlgoRegistry

C# example demonstrating how to use AlgoRegistry to retrieve algorithm types (indicator, robot, plugin), enumerate all algorithms, subscribe to events (AlgoTypeChanged, AlgoTypeDeleted, AlgoTypeInstalled), and install a new algorithm file. The example prints algorithm details and handles installation errors.

```csharp
[Robot(AccessRights = AccessRights.None)]
public class TestExample : Robot
{
    protected override void OnStart()
    {
        if (AlgoRegistry.Get("Simple Moving Average", AlgoKind.StandardIndicator) is IndicatorType smaIndicatorType)
            Print($"Name: {smaIndicatorType.Name} | Parameters #: {smaIndicatorType.Parameters.Count} | Lines #: {smaIndicatorType.Lines.Count} | Bars: {smaIndicatorType.Bars.Count}");
        if (AlgoRegistry.Get("Sample Break Even", AlgoKind.Robot) is RobotType robotType)
            Print($"Name: {robotType.Name} | Parameters #: {robotType.Parameters.Count}");
        if (AlgoRegistry.Get("Sample Test Plugin", AlgoKind.Plugin) is PluginType pluginType)
            Print($"Name: {pluginType.Name} | Parameters #: {pluginType.Parameters.Count}");
        foreach (var algo in AlgoRegistry)
        {
            Print($"Name: {algo.Name} | Kind: {algo.AlgoKind}");
        }
        AlgoRegistry.AlgoTypeChanged += args => Print($"Algo updated: {args.AlgoTypeName}");
        AlgoRegistry.AlgoTypeDeleted += args => Print($"Algo deleted: {args.AlgoTypeName}");
        AlgoRegistry.AlgoTypeInstalled += args => Print($"Algo installed: {args.AlgoTypeName}");
        var result = AlgoRegistry.Install("path/to-algo-file.algo");
        if (!result.Succeeded)
            Print($"Algo installation failed with error: {result.Error}");
    }
}
```

--------------------------------

### Python Example: Using AlgoRegistry (partial)

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/AlgoRegistry

Partial Python example showing the beginning of using AlgoRegistry, including importing the cAlgo.API reference. The example is incomplete and only shows the initial setup lines.

```python
import clr
clr.AddReference("cAlgo.API")
```

--------------------------------

### MonteCarloSettings Usage Example (C#)

Source: https://help.ctrader.com/ctrader-algo/references/Plugin/Backtesting/MonteCarloSettings?q=

C# example demonstrating how to configure MonteCarloSettings within a Plugin's OnStart method and start a backtesting process with Monte Carlo simulation.

```APIDOC
## MonteCarloSettings Usage Example (C#)

### Description
This example shows how to create and configure a MonteCarloSettings object within a cTrader Plugin, set its properties, and start a backtesting process with Monte Carlo simulation enabled.

### Code Example
```csharp
using cAlgo.API;
using cAlgo.API.Internals;
using System;

namespace cAlgo.Plugins
{
    [Plugin(AccessRights = AccessRights.FullAccess)]
    public class MonteCarloTest : Plugin
    {
        [Parameter(DefaultValue = "Sample Breakout")]
        public string RobotName {get; set;}
        [Parameter(DefaultValue = "EURUSD")]
        public Symbol Symbol {get; set;}
        [Parameter(DefaultValue = "Daily")]
        public TimeFrame TimeFrame {get; set;}
        [Parameter(DefaultValue = "2023-09-01T06:30:00")]
        public DateTime StartTime {get; set;}
        [Parameter(DefaultValue = "2025-09-01T06:30:00")]
        public DateTime EndTime {get; set;}
        [Parameter(DefaultValue = 10000)]
        public double AccountBalance {get; set;}
        [Parameter(DefaultValue = @"C:\Temp\montecarlo-result.json")]
        public string MonteCarloOutputPath {get; set;}
        private BacktestingProcess _backtestingProcess;
        protected override void OnStart()
        {
            if (AlgoRegistry.Get(RobotName, AlgoKind.Robot) is not RobotType robotType)
            {
                Print($"Robot type {RobotName} not found");
                return;
            }
            var backtestingSettings = new BacktestingSettings
            {
                StartTimeUtc = StartTime,
                EndTimeUtc = EndTime,
                Balance = AccountBalance,
                DataMode = BacktestingDataMode.M1,
                SpreadPips = 1,
                MonteCarlo = new MonteCarloSettings(MonteCarloMethod.BlockBootstrap, MonteCarloOutputPath)
                {
                    Iterations = 5000,
                    Seed = 42,
                    StartingEquity = AccountBalance,
                    RuinFloor = 0,
                    BlockSize = 10
                }
            };
            _backtestingProcess = Backtesting.Start(robotType, Symbol.Name, TimeFrame, backtestingSettings);
            _backtestingProcess.Completed += args => Print($"Monte Carlo result: {_backtestingProcess.MonteCarloJsonReport}");
        }
        protected override void OnStop()
        {
            _backtestingProcess?.Terminate();
        }
    }
}
```

### Properties
- **Iterations** (int) - Number of Monte Carlo iterations.
- **Seed** (int) - Random seed for reproducibility.
- **StartingEquity** (double) - Initial equity for the simulation.
- **RuinFloor** (double) - Equity level below which the simulation is considered ruined.
- **BlockSize** (int) - Block size for the block bootstrap method.

### Constructor
- **MonteCarloSettings(MonteCarloMethod method, string outputPath)** - Creates a new instance with the specified Monte Carlo method and output path for the JSON report.
```

--------------------------------

### MonteCarloSettings Usage Example (Python)

Source: https://help.ctrader.com/ctrader-algo/references/Plugin/Backtesting/MonteCarloSettings?q=

Python example demonstrating how to configure MonteCarloSettings within a Plugin's on_start method and start a backtesting process with Monte Carlo simulation.

```APIDOC
## MonteCarloSettings Usage Example (Python)

### Description
This example shows how to create and configure a MonteCarloSettings object in Python, set its properties, and start a backtesting process with Monte Carlo simulation enabled.

### Code Example
```python
import clr
clr.AddReference("cAlgo.API")
from cAlgo.API import *

# You have to add these parameters to Plugin C# file:
#     [Parameter(DefaultValue = "Sample Breakout")]
#     public string RobotName {get; set;}
#     [Parameter(DefaultValue = "EURUSD")]
#     public Symbol Symbol {get; set;}
#     [Parameter(DefaultValue = "Daily")]
#     public TimeFrame TimeFrame {get; set;}
#     [Parameter(DefaultValue = "2023-09-01T06:30:00")]
#     public DateTime StartTime {get; set;}
#     [Parameter(DefaultValue = "2025-09-01T06:30:00")]
#     public DateTime EndTime {get; set;}
#     [Parameter(DefaultValue = 10000)]
#     public double AccountBalance {get; set;}
#     [Parameter(DefaultValue = "C:\\Temp\\montecarlo-result.json")]
#     public string MonteCarloOutputPath {get; set;}

class MonteCarloTest():
    def on_start(self):
        algoType = api.AlgoRegistry.Get(api.RobotName, AlgoKind.Robot)
        if algoType is None:
            print(f"Robot type {api.RobotName} not found")
            return
        robotType = RobotType(algoType)
        backtestingSettings = BacktestingSettings()
        backtestingSettings.StartTimeUtc = api.StartTime
        backtestingSettings.EndTimeUtc = api.EndTime
        backtestingSettings.Balance = api.AccountBalance
        backtestingSettings.DataMode = BacktestingDataMode.M1
        backtestingSettings.SpreadPips = 1
        monteCarlo = MonteCarloSettings(MonteCarloMethod.BlockBootstrap, api.MonteCarloOutputPath)
        monteCarlo.Iterations = 5000
        monteCarlo.Seed = 42
        monteCarlo.StartingEquity = api.AccountBalance
        monteCarlo.RuinFloor = 0
        monteCarlo.BlockSize = 10
        backtestingSettings.MonteCarlo = monteCarlo
        self.backtestingProcess = api.Backtesting.Start(robotType, api.Symbol.Name, api.TimeFrame, backtestingSettings)
        self.backtestingProcess.Completed += lambda args: print(f"Monte Carlo result: {self.backtestingProcess.MonteCarloJsonReport}")

    def on_stop(self):
        if hasattr(self, "backtestingProcess") and self.backtestingProcess is not None:
            self.backtestingProcess.Terminate()
```

### Properties
- **Iterations** (int) - Number of Monte Carlo iterations.
- **Seed** (int) - Random seed for reproducibility.
- **StartingEquity** (double) - Initial equity for the simulation.
- **RuinFloor** (double) - Equity level below which the simulation is considered ruined.
- **BlockSize** (int) - Block size for the block bootstrap method.

### Constructor
- **MonteCarloSettings(MonteCarloMethod method, string outputPath)** - Creates a new instance with the specified Monte Carlo method and output path for the JSON report.
```

--------------------------------

### C# example: Retrieve plugin and print name and parameters

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/PluginType

Shows how to get a plugin from AlgoRegistry and access its Name and Parameters properties. The example uses a Robot class with AccessRights.None.

```csharp
 [Robot(AccessRights = AccessRights.None)]
 public class TestExample : Robot
 {
     protected override void OnStart()
     {
         if (AlgoRegistry.Get("Sample Test Plugin", AlgoKind.Plugin) is PluginType pluginType)
             Print($"Name: {pluginType.Name} | Parameters #: {pluginType.Parameters.Count}");
     }
 }
```

--------------------------------

### Monte Carlo report example (C#)

Source: https://help.ctrader.com/ctrader-algo/references/Plugin/Backtesting/BacktestingProcess

C# example showing how to start a backtesting process and subscribe to the Completed event to print the Monte Carlo JSON report.

```csharp
 _backtestingProcess = Backtesting.Start(robotType, Symbol.Name, TimeFrame, backtestingSettings);
 _backtestingProcess.Completed += args => Print($"Monte Carlo result: {_backtestingProcess.MonteCarloJsonReport}");
```

--------------------------------

### WebView setup and event handlers

Source: https://help.ctrader.com/ctrader-algo/references/Controls/WebView

This snippet shows the complete WebView usage example from the documentation. It includes grid layout setup, window creation, and event handlers for navigation, script execution, and web message reception. The example demonstrates how to use methods like NavigateAsync, StopAsync, ExecuteScript, ReloadAsync, GoForwardAsync, and GoBackAsync, as well as event handlers for WebViewLoaded, WebViewUnloaded, WebViewWebMessageReceived, and WebViewNavigationCompleted.

```csharp
mainGrid.Rows[0].SetHeightToAuto();
             mainGrid.Rows[1].SetHeightInStars(1);
             mainGrid.AddChild(addressBarPanel, 0, 0);
             mainGrid.AddChild(_webView, 1, 0);
             var window = new Window
             {
                 Child = mainGrid
             };
             window.Show();
             _webView.NavigateAsync(_addressTextBox.Text);
         }
         private void OnWebViewLoaded(WebViewLoadedEventArgs args)
         {
             Print($"Webview loaded, IsLoaded: {args.WebView.IsLoaded}");
         }
         private void OnWebViewUnloaded(WebViewUnloadedEventArgs args)
         {
             Print($"Webview unloaded, IsLoaded: {args.WebView.IsLoaded}");
         }
         private void OnStopButtonClick(ButtonClickEventArgs args)
         {
             _webView.StopAsync();
         }
         private void OnExecuteScriptButtonClick(ButtonClickEventArgs args)
         {
             var result = _webView.ExecuteScript(_scriptTextbox.Text);
             Print($"IsSuccessful: {result.IsSuccessful} | Json: {result.Json}");
         }
         private void OnReloadButtonClick(ButtonClickEventArgs args)
         {
             _webView.ReloadAsync();
         }
         private void OnGoForwardButtonClick(ButtonClickEventArgs args)
         {
             _webView.GoForwardAsync();
         }
         private void OnGoBackButtonClick(ButtonClickEventArgs args)
         {
             _webView.GoBackAsync();
         }
         private void OnGoButtonClick(ButtonClickEventArgs args)
         {
             _webView.NavigateAsync(_addressTextBox.Text);
         }
         private void OnWebViewWebMessageReceived(WebViewWebMessageReceivedEventArgs args)
         {
             Print($"Source: {args.Source} | Message: {args.Message}");
         }
         private void OnWebViewNavigationCompleted(WebViewNavigationCompletedEventArgs args)
         {
             Print($"{args.HttpStatusCode} | {args.IsSuccessful} | {args.Url}");
             _addressTextBox.Text = args.Url;
             _scriptTextbox.IsEnabled = true;
             _executeScriptButton.IsEnabled = true;
         }
     }
 }
```

--------------------------------

### Start Timer with seconds interval - C# and Python examples

Source: https://help.ctrader.com/ctrader-algo/references/Timer/Timer?q=

C# and Python examples for starting the Timer with an integer interval in seconds. The C# example calls Timer.Start(1) and draws the time in OnTimer. The Python example calls api.Timer.Start(1) and draws the time.

```csharp
protected override void OnStart()
{
    Timer.Start(1);
}
protected override void OnTimer()
{
    Chart.DrawStaticText("time", Time.ToString("HH:mm:ss"), VerticalAlignment.Center, HorizontalAlignment.Center, Color.Red);
}
```

```python
class Test():
    def on_start(self):
        api.Timer.Start(1)
    def on_timer(self):
        api.Chart.DrawStaticText("time", str(api.Time), VerticalAlignment.Center, HorizontalAlignment.Center, Color.Red)
```

--------------------------------

### C# example: Show RobotStartDialog

Source: https://help.ctrader.com/ctrader-algo/references/Dialogs/RobotStartDialog?q=

C# example showing how to create and show a RobotStartDialog for a robot obtained from the AlgoRegistry.

```csharp
using cAlgo.API;
namespace cAlgo.Robots;
[Robot(AccessRights = AccessRights.None)]
public class TestExample : Robot
{
    protected override void OnStart()
    {
        var robotType = (RobotType)AlgoRegistry.Get("Sample Breakout", AlgoKind.Robot);
        var robotStartDialog = new RobotStartDialog(robotType);
        robotStartDialog.ShowDialog();
    }
}

```

--------------------------------

### List plugins - prompt example

Source: https://help.ctrader.com/ctrader-ai-agent-connect/local-mcp/plugins?q=

Use this prompt to list all available plugins through the cTrader local MCP server.

```text
Show me all available plugins.

```

--------------------------------

### Python example: Show RobotStartDialog

Source: https://help.ctrader.com/ctrader-algo/references/Dialogs/RobotStartDialog?q=

Python example showing how to create and show a RobotStartDialog for a robot obtained from the AlgoRegistry.

```python
import clr
clr.AddReference("cAlgo.API")
# Import cAlgo API types
from cAlgo.API import *
# Import trading wrapper functions
from robot_wrapper import *
class Test():
    def on_start(self):
        robotType = RobotType(api.AlgoRegistry.Get("Sample Breakout", AlgoKind.Robot))
        robotStartDialog = RobotStartDialog(robotType)
        robotStartDialog.ShowDialog()

```

--------------------------------

### InstallationResult.Error

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/InstallationResult?q=

Gets the installation error if the installation failed; otherwise, null.

```APIDOC
## InstallationResult.Error

### Description
Gets the installation error if the installation failed; otherwise, null.

### Property Signature
```csharp
public InstallationError? Error {get;}
```

### Return Value
- **InstallationError?** - The installation error, or null if installation succeeded.

```

--------------------------------

### C# example: Configure BacktestingSettings with Monte Carlo

Source: https://help.ctrader.com/ctrader-algo/references/Plugin/Backtesting/BacktestingSettings

C# example showing how to configure BacktestingSettings with a Monte Carlo simulation using BlockBootstrap method, 5000 iterations, seed 42, and block size 10. Prints the output file path after configuration.

```csharp
var backtestingSettings = new BacktestingSettings
{
    StartTimeUtc = StartTime,
    EndTimeUtc = EndTime,
    Balance = AccountBalance,
    DataMode = BacktestingDataMode.M1,
    MonteCarlo = new MonteCarloSettings(MonteCarloMethod.BlockBootstrap, MonteCarloOutputPath)
    {
        Iterations = 5000,
        Seed = 42,
        BlockSize = 10
    }
};
Print($"Monte Carlo output file: {backtestingSettings.MonteCarlo.OutputFilePath}");

```

--------------------------------

### Start Timer with TimeSpan interval - C# and Python examples

Source: https://help.ctrader.com/ctrader-algo/references/Timer/Timer?q=

C# and Python examples for starting the Timer with a TimeSpan interval. The Python example imports TimeSpan from System and uses api.Timer.Start with TimeSpan.FromMilliseconds(1000). The C# example calls Timer.Start with the same interval and draws the current time in OnTimer.

```python
from System import TimeSpan
class Test():
    def on_start(self):
        api.Timer.Start(TimeSpan.FromMilliseconds(1000))
    def on_timer(self):
        api.Chart.DrawStaticText("time", str(api.Time), VerticalAlignment.Center, HorizontalAlignment.Center, Color.Red)
```

```csharp
protected override void OnStart()
{
    Timer.Start(TimeSpan.FromMilliseconds(1000));
}
protected override void OnTimer()
{
    Chart.DrawStaticText("time", Time.ToString("HH:mm:ss"), VerticalAlignment.Center, HorizontalAlignment.Center, Color.Red);
}
```

--------------------------------

### Python GetMarketDepth Example

Source: https://help.ctrader.com/ctrader-algo/references/General/Algo

Example 2 (PYTHON): Gets market depth for a specific symbol.

```python
md = api.MarketData.GetMarketDepth("GBPUSD")

```

--------------------------------

### C# GetMarketDepth Example

Source: https://help.ctrader.com/ctrader-algo/references/General/Algo

Example 1 (C#): Gets market depth for a specific symbol.

```csharp
private MarketDepth _md;
_md = MarketData.GetMarketDepth("GBPUSD");

```

--------------------------------

### InstallationOperation.Result

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/InstallationOperation?q=

Gets the result of the installation operation.

```APIDOC
## InstallationOperation.Result

### Description
Gets the result of the installation operation. The result contains information about the success or failure of the installation.

### Property Signature
```csharp
public InstallationResult Result {get;}
```

### Return Value
- **InstallationResult** - The result of the installation operation.
```

--------------------------------

### InstallAsync(Uri uri, Action<InstallationResult> callback)

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/AlgoRegistry?q=

Installs an algo file from the specified URI asynchronously, invoking a callback with the installation result.

```APIDOC
## InstallAsync(Uri uri, Action<InstallationResult> callback)

### Description
Installs an algo file from the provided URI asynchronously, invoking a callback with the installation result.

### Method
InstallAsync

### Signature
public abstract InstallationOperation InstallAsync(Uri uri, Action<InstallationResult> callback)

### Parameters
- **uri** (Uri) - Required - Algo file URI.
- **callback** (Action) - Required - Callback that will be invoked with installation result.

### Return Value
InstallationOperation
```

--------------------------------

### Plugins

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/AlgoRegistry

Gets the list of all installed plugins.

```APIDOC
## [PROPERTY] Plugins

### Description
Gets the list of all installed plugins.

### Signature
```csharp
public abstract IReadonlyList<PluginType> Plugins {get;}
```

### Return Value
- **IReadonlyList<PluginType>** - The list of installed plugins.
```

--------------------------------

### CustomSymbolTest plugin setup (C#)

Source: https://help.ctrader.com/ctrader-algo/references/Plugin/Symbol/Custom/CustomSymbols

Example 1 (C#) shows a Plugin class that creates a UI panel with buttons for various custom symbol operations. The OnStart method sets up the panel and wires button click events to handler methods.

```csharp
using System;
using cAlgo.API;
using cAlgo.API.Internals;
using System.Linq;

namespace cAlgo.Plugins;

[Plugin(AccessRights = AccessRights.None)]
public class CustomSymbolTest : Plugin
{
    private const string InitialDescription = "This is custom symbol initial description";
    private const string ChangedDescription = "This is custom symbol changed description";
    private bool _isLoadMoreEnabled = true;
    private CustomSymbol _customSymbol;
    private CustomBars _customBars;

    protected override void OnStart()
    {
        var panel = new StackPanel();

        var addCustomSymbolWithBaseButton = new Button { Text = "Add custom symbol with Base Symbol" };
        addCustomSymbolWithBaseButton.Click += OnAddCustomSymbolWithBaseButtonClick;
        panel.AddChild(addCustomSymbolWithBaseButton);

        var addCustomSymbolWithoutBaseButton = new Button { Text = "Add custom symbol without Base Symbol" };
        addCustomSymbolWithoutBaseButton.Click += OnAddCustomSymbolWithoutBaseButtonClick;
        panel.AddChild(addCustomSymbolWithoutBaseButton);

        var removeCustomSymbolButton = new Button { Text = "Remove custom symbol" };
        removeCustomSymbolButton.Click += OnRemoveCustomSymbolButtonClick;
        panel.AddChild(removeCustomSymbolButton);

        var displayChartInfoButton = new Button { Text = "Display Charts Info" };
        displayChartInfoButton.Click += OnDisplayChartInfoButtonClick;
        panel.AddChild(displayChartInfoButton);

        var changeDescriptionButton = new Button { Text = "Change Description" };
        changeDescriptionButton.Click += OnChangeDescriptionButtonClick;
        panel.AddChild(changeDescriptionButton);

        var updateSymbolPropertiesButton = new Button { Text = "Update Symbol Properties" };
        updateSymbolPropertiesButton.Click += OnUpdateSymbolPropertiesButtonClick;
        panel.AddChild(updateSymbolPropertiesButton);

        var updateSymbolBaseAssetButton = new Button { Text = "Update Symbol Base Asset" };
        updateSymbolBaseAssetButton.Click += OnUpdateSymbolBaseAssetButtonClick;
        panel.AddChild(updateSymbolBaseAssetButton);

        var updateSymbolQuoteAssetButton = new Button { Text = "Update Symbol Quote Asset" };
        updateSymbolQuoteAssetButton.Click += OnUpdateSymbolQuoteAssetButtonClick;
        panel.AddChild(updateSymbolQuoteAssetButton);

        var showSymbolPropertiesButton = new Button { Text = "Show Symbol Properties" };
        showSymbolPropertiesButton.Click += args => ShowSymbolProperties();
        panel.AddChild(showSymbolPropertiesButton);

        var showSymbolAssetsButton = new Button { Text = "Show Symbol Assets" };
        showSymbolAssetsButton.Click += args => ShowSymbolAssets();
        panel.AddChild(showSymbolAssetsButton);

        var pauseOrResumeLoadMoreButton = new Button { Text = "Pause / Resume Load More" };
        pauseOrResumeLoadMoreButton.Click += OnPauseOrResumeLoadMoreButtonClick;
        panel.AddChild(pauseOrResumeLoadMoreButton);

        var showRegularBarsInfoButton = new Button { Text = "Show Regular Bars Info" };
        showRegularBarsInfoButton.Click += OnShowRegularBarsInfoButtonClick;
        panel.AddChild(showRegularBarsInfoButton);

```

--------------------------------

### Robots

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/AlgoRegistry

Gets the list of all installed robots.

```APIDOC
## [PROPERTY] Robots

### Description
Gets the list of all installed robots.

### Signature
```csharp
public abstract IReadonlyList<RobotType> Robots {get;}
```

### Return Value
- **IReadonlyList<RobotType>** - The list of installed robots.
```

--------------------------------

### C# example: Create and show NewOrderDialog

Source: https://help.ctrader.com/ctrader-algo/references/Dialogs/NewOrderDialog

C# example showing how to instantiate NewOrderDialog, set its properties (TradeType, OrderType, SymbolName, Volume, StopLossPips, TakeProfitPips), and display it with ShowDialog(). Requires a Robot class with AccessRights.None.

```csharp
using cAlgo.API;
namespace cAlgo.Robots;
[Robot(AccessRights = AccessRights.None)]
public class TestExample : Robot
{
    protected override void OnStart()
    {
        var newOrderDialog = new NewOrderDialog
        {
            TradeType = TradeType.Sell,
            OrderType = OrderType.Limit,
            SymbolName = SymbolName,
            Volume = Symbol.VolumeInUnitsMin * 10,
            StopLossPips = 20,
            TakeProfitPips = 40
        };
        newOrderDialog.ShowDialog();
    }
}
```

--------------------------------

### Indicators

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/AlgoRegistry

Gets the list of all installed indicators.

```APIDOC
## [PROPERTY] Indicators

### Description
Gets the list of all installed indicators.

### Signature
```csharp
public abstract IReadonlyList<IndicatorType> Indicators {get;}
```

### Return Value
- **IReadonlyList<IndicatorType>** - The list of installed indicators.
```

--------------------------------

### InstallAsync(string filePath, Action<InstallationResult> callback)

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/AlgoRegistry?q=

Installs an algo file from the specified file path asynchronously, invoking a callback with the installation result.

```APIDOC
## InstallAsync(string filePath, Action<InstallationResult> callback)

### Description
Installs an algo file from the provided file path asynchronously, invoking a callback with the installation result.

### Method
InstallAsync

### Signature
public abstract InstallationOperation InstallAsync(string filePath, Action<InstallationResult> callback)

### Parameters
- **filePath** (string) - Required - Algo file full file path.
- **callback** (Action) - Required - Callback that will be invoked with installation result.

### Return Value
InstallationOperation
```

--------------------------------

### Count

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/AlgoRegistry

Gets the number of installed algorithms.

```APIDOC
## [PROPERTY] Count

### Description
Gets the number of installed algorithms.

### Signature
```csharp
public abstract int Count {get;}
```

### Return Value
- **int** - The number of installed algorithms.
```

--------------------------------

### Start a plugin

Source: https://help.ctrader.com/ctrader-ai-agent-connect/local-mcp/plugins

Use this prompt to start a specific plugin by name through the cTrader local MCP server.

```text
Start the plugin called 'Trade copier'.
```

--------------------------------

### C# Example: Iterate AlgoRegistry and Print Algo Properties

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/AlgoType?q=

C# example showing how to iterate over AlgoRegistry in a Robot's OnStart method, printing each algorithm's Name, AlgoKind, and ProjectFilePath. Requires the cAlgo.API namespace and a Robot class with AccessRights.None.

```csharp
[Robot(AccessRights = AccessRights.None)]
public class TestExample : Robot
{
    protected override void OnStart()
    {
        foreach (var algo in AlgoRegistry)
        {
            Print($"Name: {algo.Name} | Kind: {algo.AlgoKind} | ProjectFilePath: {algo.ProjectFilePath}");
        }
    }
}
```

--------------------------------

### Start

Source: https://help.ctrader.com/ctrader-algo/references/Chart/Robots/ChartRobot?q=

Starts the Robot instance.

```APIDOC
## Start

### Description
Starts the Robot instance.

### Method
Start

### Signature
```csharp
public abstract void Start()
```

### Return Value
void
```

--------------------------------

### Deals property usage examples

Source: https://help.ctrader.com/ctrader-algo/references/Trading/Positions/Position?q=

Examples for the Deals property in C# and Python. The C# example iterates over positions and prints deal IDs and impacts. The Python example shows the initial import and reference setup.

```csharp
using cAlgo.API;
namespace cAlgo.Robots;
[Robot(AccessRights = AccessRights.None)]
public class TestExample : Robot
{
    protected override void OnStart()
    {
        foreach (var position in Positions)
        {
            foreach (var deal in position.Deals)
            {
                Print($"Deal Id: {deal.Id}, impact: {deal.PositionImpact}");
            }
        }
    }
}
```

```python
import clr
clr.AddReference("cAlgo.API")
```

--------------------------------

### C# SampleRobot using BollingerBands

Source: https://help.ctrader.com/ctrader-algo/references/Indicators/BollingerBands

C# robot example showing how to declare parameters, instantiate BollingerBands, and print the current Main band value in OnBar.

```csharp
 //...
 [Robot]
 public class SampleRobot : Robot
 //...
 [Parameter("Source")]
 public DataSeries Source { get; set; }
 [Parameter("BandPeriods", DefaultValue = 14)]
 public int BandPeriod { get; set; }
 [Parameter("Std", DefaultValue = 14)]
 public int std { get; set; }
 [Parameter("MAType")]
 public MovingAverageType MAType { get; set; }
 //...
 private BollingerBands boll;
 //...
 protected override void OnStart()
 {
     boll = Indicators.BollingerBands(Source,BandPeriod,std,MAType);
 }
 protected override void OnBar()
 {
     Print("Current Main Bollinger Band's price is: {0}", boll.Main.LastValue);
 }
 //...
```

--------------------------------

### ExecuteMarketOrder example (C#)

Source: https://help.ctrader.com/ctrader-algo/references/General/Algo?q=

C# example from Example 2 showing how to place a market order using Symbol.Name.

```C#
ExecuteMarketOrder(TradeType.Buy, Symbol.Name, 10000, "myLabel", 10, 10);  
```

--------------------------------

### Iterate BidEntries to get volume and price

Source: https://help.ctrader.com/ctrader-algo/references/MarketData/MarketDepth/MarketDepth?q=

Examples for iterating over BidEntries to retrieve volume and price. The C# example uses a foreach loop, the Python example uses a for loop.

```csharp
foreach (var entry in _marketDepth.BidEntries)
{
    volume  = entry.VolumeInUnits;
    entryPrice = entry.Price;
}
```

```python
for entry in self.marketDepth.BidEntries:
    volume  = entry.VolumeInUnits
    entryPrice = entry.Price
```

--------------------------------

### Iterate AskEntries to get volume and price

Source: https://help.ctrader.com/ctrader-algo/references/MarketData/MarketDepth/MarketDepth?q=

Examples for iterating over AskEntries to retrieve volume and price. The C# example uses a foreach loop, the Python example uses a for loop.

```csharp
foreach (var entry in _marketDepth.AskEntries)
{
    volume  = entry.VolumeInUnits;
    entryPrice = entry.Price;
}
```

```python
for entry in self.marketDepth.AskEntries:
    volume  = entry.VolumeInUnits
    entryPrice = entry.Price
```

--------------------------------

### C# example using OpenFileDialog

Source: https://help.ctrader.com/ctrader-algo/references/Dialogs/OpenFileDialog?q=

C# example showing how to create an OpenFileDialog, set properties, show the dialog, and print selected file names.

```csharp
using cAlgo.API;
namespace cAlgo.Robots;
[Robot(AccessRights = AccessRights.None)]
public class TestExample : Robot
{
    protected override void OnStart()
    {
        var openFileDialog = new OpenFileDialog
        {
            Title = "Select File(s)",
            Multiselect = true,
            AddExtension = true,
        };
        var result = openFileDialog.ShowDialog();
        if (result == FileDialogResult.Cancel)
            return;
        foreach (var fileName in openFileDialog.FileNames)
        {
            Print(fileName);
        }
    }
}

```

--------------------------------

### Python example: BarOutput attribute imports

Source: https://help.ctrader.com/ctrader-algo/references/Attributes/BarOutputAttribute?q=

Python example showing the initial imports and reference setup for using the cAlgo.API. This is the beginning of the Python version of the BarOutput attribute example.

```python
import clr
clr.AddReference("cAlgo.API")
from cAlgo.API import *
```

--------------------------------

### C# example using VolumeInUnitsStep

Source: https://help.ctrader.com/ctrader-algo/references/MarketData/Symbols/Symbol

C# example using VolumeInUnitsStep to increment volume while respecting the maximum volume limit.

```csharp
if(volume + Symbol.VolumeInUnitsStep <= Symbol.VolumeInUnitsMax)
{
    volume += Symbol.VolumeInUnitsStep;
}
```

--------------------------------

### Plugins Property

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/AlgoRegistry?q=

Gets the list of all installed plugins.

```APIDOC
## Plugins Property

### Description
Gets the list of all installed plugins.

### Signature
```csharp
public abstract IReadonlyList<PluginType> Plugins { get; }
```

### Return Value
- **IReadonlyList** - A read-only list of installed plugin types.
```

--------------------------------

### Robots Property

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/AlgoRegistry?q=

Gets the list of all installed robots.

```APIDOC
## Robots Property

### Description
Gets the list of all installed robots.

### Signature
```csharp
public abstract IReadonlyList<RobotType> Robots { get; }
```

### Return Value
- **IReadonlyList** - A read-only list of installed robot types.
```

--------------------------------

### Python example: Create and show NewOrderDialog

Source: https://help.ctrader.com/ctrader-algo/references/Dialogs/NewOrderDialog

Python example showing how to create a NewOrderDialog, set its properties, and call ShowDialog(). Requires importing cAlgo.API and robot_wrapper, and uses api.SymbolName and api.Symbol.VolumeInUnitsMin.

```python
import clr
clr.AddReference("cAlgo.API")
# Import cAlgo API types
from cAlgo.API import *
# Import trading wrapper functions
from robot_wrapper import *
class Test():
    def on_start(self):
        newOrderDialog = NewOrderDialog()
        newOrderDialog.TradeType = TradeType.Sell
        newOrderDialog.OrderType = OrderType.Limit
        newOrderDialog.SymbolName = api.SymbolName
        newOrderDialog.Volume = api.Symbol.VolumeInUnitsMin * 10
        newOrderDialog.StopLossPips = 20
        newOrderDialog.TakeProfitPips = 40
        newOrderDialog.ShowDialog()
```

--------------------------------

### Indicators Property

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/AlgoRegistry?q=

Gets the list of all installed indicators.

```APIDOC
## Indicators Property

### Description
Gets the list of all installed indicators.

### Signature
```csharp
public abstract IReadonlyList<IndicatorType> Indicators { get; }
```

### Return Value
- **IReadonlyList** - A read-only list of installed indicator types.
```

--------------------------------

### Count Property

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/AlgoRegistry?q=

Gets the number of installed algorithms.

```APIDOC
## Count Property

### Description
Gets the number of installed algorithms.

### Signature
```csharp
public abstract int Count { get; }
```

### Return Value
- **int** - The number of installed algorithms.
```

--------------------------------

### ExecuteMarketOrder example (Python)

Source: https://help.ctrader.com/ctrader-algo/references/General/Algo?q=

Python example from Example 5 showing how to place a market order using api.Symbol.Name.

```Python
api.ExecuteMarketOrder(TradeType.Buy, api.Symbol.Name, 10000, "myLabel", 10, 10)
```

--------------------------------

### Using parameters in OnStart()

Source: https://help.ctrader.com/plugins/developers/desktop/parameters

Uses previously declared customisable parameters inside the OverrideStart() method to print their values. This example shows how to read parameter values at plugin startup.

```C#
protected override void OnStart()
{
    Print($"API Key: {ApiKey}");
    Print($"Max Retries: {MaxRetries}");
    Print($"Enable Logging: {EnableLogging}");

    Print($"Stop Loss (pips): {StopLossPips}");
    Print($"Enable Trailing Stop: {EnableTrailingStop}");
    Print($"Stop Loss Trigger Method: {StopLossTrigger}");

    Print($"Trade Direction: {TradeDirection}");

    Print($"Pending Order Type: {OrderType}");
    Print($"Expiry Time: {ExpiryTime}");
}
```

--------------------------------

### Install (1 of 2)

Source: https://help.ctrader.com/ctrader-algo/references/AlgoRegistry/AlgoRegistry?q=

Installs an algo file from a provided file path.

```APIDOC
## Install (1 of 2)

### Description
Installs an algo file from a provided file path.

### Method
Install

### Signature
```csharp
public abstract InstallationResult Install(string filePath)
```

### Parameters
- **filePath** (string) - Required - Algo file full file path.

### Return Value
InstallationResult
```

--------------------------------

### Send GET request with api.Http.Get in Python

Source: https://help.ctrader.com/ctrader-algo/references/HTTP/Http?q=

Python equivalent of the GET request example, using api.Http.Get. Requires importing cAlgo.API and robot_wrapper.

```python
import clr
clr.AddReference("cAlgo.API")
# Import cAlgo API types
from cAlgo.API import *
# Import trading wrapper functions
from robot_wrapper import *
class Test():
    def on_start(self):
        response = api.Http.Get("https://api.restful-api.dev/objects")
        if response.IsSuccessful == False:
            print("HTTP request failed")
            return
        print(response.Body)

```
Tokens:
Raw