Plugin Code Samples
This page provides several ready-made code snippets that you can use when developing your own plugins.
Samples Repository
More code samples are always available in the git@github.com:spotware/ctrader-automate-samples.git repository. To access it, click here.
Displaying a Website in a Chart Frame
The following plugin displays the cTrader Forum inside a separate chart frame.
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
27
28
29
30
31
32
33
34
35 | using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using cAlgo.API;
using cAlgo.API.Collections;
using cAlgo.API.Indicators;
using cAlgo.API.Internals;
namespace cAlgo.Plugins
{
[Plugin(AccessRights = AccessRights.None)]
public class ForumExample : Plugin
{
private WebView _cTraderWebView;
protected override void OnStart()
{
_cTraderWebView = new WebView();
_cTraderWebView.Loaded += DisplayForum;
var webViewFrame = ChartManager.AddCustomFrame("Forum");
webViewFrame.Child = _cTraderWebView;
webViewFrame.ChartContainer.Mode = ChartMode.Multi;
webViewFrame.Attach();
}
private void DisplayForum(WebViewLoadedEventArgs args)
{
_cTraderWebView.NavigateAsync("https://ctrader.com/forum");
}
}
}
|
Once per minute, the plugin below saves the total account P&L into a file using the local storage feature and the current timestamp as the file name. It also displays the same information in a separate section in the ASP.
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43 | using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using cAlgo.API;
using cAlgo.API.Collections;
using cAlgo.API.Indicators;
using cAlgo.API.Internals;
namespace cAlgo.Plugins
{
[Plugin(AccessRights = AccessRights.None)]
public class GrossPnL : Plugin
{
private TextBlock _textBlock = new TextBlock
{
Text = "Starting...",
FontSize = 15,
FontWeight = FontWeight.ExtraBold,
TextAlignment = TextAlignment.Center,
Padding = new Thickness(5, 5, 5, 5),
};
protected override void OnStart()
{
var aspBlock = Asp.SymbolTab.AddBlock("Gross P&L");
aspBlock.Child = _textBlock;
Timer.Start(TimeSpan.FromMinutes(1));
}
protected override void OnTimer()
{
var timestamp = Server.TimeInUtc;
string result = timestamp.ToString("HH mm ss");
LocalStorage.SetString($"{result}", $"{Account.UnrealizedGrossProfit}", LocalStorageScope.Device);
_textBlock.Text = $"{result}: {Account.UnrealizedGrossProfit}";
}
}
}
|
Displaying a Separate Window With a Custom Control
The plugin below adds a custom button to a detached window. On click, the control adds a take profit for all open positions but only if a position does not have a previously established take profit.
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51 | using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using cAlgo.API;
using cAlgo.API.Collections;
using cAlgo.API.Indicators;
using cAlgo.API.Internals;
namespace cAlgo.Plugins
{
[Plugin(AccessRights = AccessRights.None)]
public class ProtectionPlugin : Plugin
{
private Button _buttonAddTakeProfit;
private Window _window;
protected override void OnStart()
{
_buttonAddTakeProfit = new Button
{
BackgroundColor = Color.SeaGreen,
Height = 50,
Text = "Add Take Profit"
};
_buttonAddTakeProfit.Click += AddTakeProfit;
_window = new Window
{
Height = 150,
Width = 150,
Padding = new Thickness(5, 10, 10, 5),
};
_window.Child = _buttonAddTakeProfit;
_window.Show();
}
private void AddTakeProfit(ButtonClickEventArgs args)
{
foreach (var position in Positions)
{
if (position.TakeProfit is null)
{
position.ModifyTakeProfitPips(20);
}
}
}
}
}
|
When built, this plugin adds a new tab to the 'Trade Watch' display. This tab contains a two-by-two grid that displays information about the last known bar prices for the m1 timeframe and the symbol whose name is "USDJPY".
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82 | using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using cAlgo.API;
using cAlgo.API.Collections;
using cAlgo.API.Indicators;
using cAlgo.API.Internals;
namespace cAlgo.Plugins
{
[Plugin(AccessRights = AccessRights.None)]
public class BarsPlugin : Plugin
{
private Grid _grid;
private TextBlock _lowBlock;
private TextBlock _highBlock;
private TextBlock _closeBlock;
private TextBlock _openBlock;
private Bars _bars;
protected override void OnStart()
{
_bars = MarketData.GetBars(TimeFrame.Minute, "USDJPY");
_grid = new Grid(2, 2)
{
HorizontalAlignment = HorizontalAlignment.Center,
VerticalAlignment = VerticalAlignment.Center,
ShowGridLines = true,
Height = 150,
Width = 150,
};
_lowBlock = new TextBlock
{
Text = $"Low: {_bars.LowPrices.LastValue}",
HorizontalAlignment = HorizontalAlignment.Center,
VerticalAlignment = VerticalAlignment.Center,
};
_highBlock = new TextBlock
{
Text = $"High: {_bars.HighPrices.LastValue}",
HorizontalAlignment = HorizontalAlignment.Center,
VerticalAlignment = VerticalAlignment.Center,
};
_closeBlock = new TextBlock
{
Text = $"Low: {_bars.ClosePrices.LastValue}",
HorizontalAlignment = HorizontalAlignment.Center,
VerticalAlignment = VerticalAlignment.Center,
};
_openBlock = new TextBlock
{
Text = $"Open: {_bars.OpenPrices.LastValue}",
HorizontalAlignment = HorizontalAlignment.Center,
VerticalAlignment = VerticalAlignment.Center,
};
_grid.AddChild(_lowBlock, 0, 0);
_grid.AddChild(_highBlock, 0, 1);
_grid.AddChild(_openBlock, 1, 0);
_grid.AddChild(_closeBlock, 1, 1);
var TradeWatchTab = TradeWatch.AddTab("Previous Bar Info");
TradeWatchTab.Child = _grid;
TradeWatchTab.IsSelected = true;
Timer.Start(TimeSpan.FromMinutes(1));
}
protected override void OnTimer()
{
_lowBlock.Text = _bars.LowPrices.LastValue.ToString();
_highBlock.Text = _bars.HighPrices.LastValue.ToString();
_openBlock.Text = _bars.HighPrices.LastValue.ToString();
_closeBlock.Text = _bars.HighPrices.LastValue.ToString();
}
}
}
|
Reacting to Changing the Active Frame
The following plugin detects which ChartFrame is currently active. Inside a custom block in the ASP, the plugin shows the percentage difference between the current price of the symbol for which this ChartFrame is opened and the price of this symbol approximately one month ago.
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62 | using System;
using cAlgo.API;
using cAlgo.API.Collections;
using cAlgo.API.Indicators;
using cAlgo.API.Internals;
namespace cAlgo.Plugins
{
[Plugin(AccessRights = AccessRights.None)]
public class ActiveFrameChangedSample : Plugin
{
// Declaring the necessary UI elements
private Grid _grid;
private TextBlock _percentageTextBlock;
private Frame _activeFrame;
protected override void OnStart()
{
// Initialising the grid and the TextBlock
// displaying the percentage difference
_grid = new Grid(1, 1);
_percentageTextBlock = new TextBlock
{
HorizontalAlignment = HorizontalAlignment.Center,
VerticalAlignment = VerticalAlignment.Center,
Text = "Monthly change: ",
};
_grid.AddChild(_percentageTextBlock, 0, 0);
// Initialising a new block inside the ASP
// and adding the grid as a child
var block = Asp.SymbolTab.AddBlock("Monthly Change Plugin");
block.Child = _grid;
// Attaching a custom handler to the
// ActiveFrameChanged event
ChartManager.ActiveFrameChanged += ChartManager_ActiveFrameChanged;
}
private void ChartManager_ActiveFrameChanged(ActiveFrameChangedEventArgs obj)
{
if (obj.NewFrame is ChartFrame)
{
// Casting the Frame into a ChartFrame
var newChartFrame = obj.NewFrame as ChartFrame;
// Attaining market data for the symbol for which
// the currently active ChartFrame is opened
var dailySeries = MarketData.GetBars(TimeFrame.Daily, newChartFrame.Symbol.Name);
// Calculating the monthly change and displaying it
// inside the TextBlock
double monthlyChange = (newChartFrame.Symbol.Bid - dailySeries.ClosePrices[dailySeries.ClosePrices.Count - 30]) / 100;
_percentageTextBlock.Text = $"Monthly change: {monthlyChange}";
}
}
}
}
|