cTrader CLI

cTrader CLIを使用すると、通常のcTraderアプリケーションを起動または依存することなく、コンソールやターミナルから直接アカウントとアルゴリズム取引操作を管理できます。 cTrader CLIを使用すると、ユーザーはテキストベースのターミナルにコマンドを入力するだけで、cTraderアルゴリズムにアクセスして実行できます。

起動と使用方法

cTrader Windows経由

cBotをcTrader CLIで実行するには、cTrader WindowsでそのcBotのローカルインスタンスを右クリックし、外部プロセスで起動を選択します。

cTrader CLIが自動的に起動し、cTrader Windowsアプリケーションとは独立してインスタンスを実行します。

cBotインスタンスをcTrader CLI外部プロセスで起動した後、cTrader Windowsを閉じてCPUとRAMリソースを節約できます。cTrader CLIはcTrader Windowsが開いたままである必要はありません。

Windowsコマンドライン経由

WindowsのコマンドプロンプトやWindows PowerShellなどのコマンドラインプログラムからcTrader CLIを起動できます。

まず、ctrader-cliを含むフォルダに移動し、パスをコピーします。 cTrader CLI実行ファイルは通常、cTrader Windowsアプリケーションと同じディレクトリにあります：

1

C:\Users\{username}\AppData\Local\Spotware\cTrader\{installationId}

次に、コマンドプロンプトまたはWindows PowerShellを開き、cdと入力し、スペースを追加して、先ほどコピーしたパスを貼り付けます。 コードは次のようになります：

1

cd C:\Users\{username}\AppData\Local\Spotware\cTrader\{installationId}

コードを実行すると、コマンドラインプログラムはctrader-cli実行ファイルを含むディレクトリに入ります。

最後に、ctrader-cli.exeと入力し、続けて有効な<command>を入力して実行できます。 例えば、ctrader-cli.exe periodsを実行して利用可能な期間を確認できます。

パス変数を追加

まず、以前と同じようにctrader-cliを含むフォルダを見つけてパスをコピーします。

1

C:\Users\{username}\AppData\Local\Spotware\cTrader\{installationId}

Windowsスタートメニューで環境変数を検索します。 システム環境変数の編集をクリックします。

システムのプロパティウィンドウで、環境変数をクリックします。 {username}のユーザー変数の下にあるPathをダブルクリックします。 環境変数の編集ウィンドウで、新規ボタンをクリックし、先ほどコピーしたパスをフィールドに貼り付けます。

すべてのダイアログが閉じるまでOKをクリックします。

Linux Dockerイメージ経由

cTrader CLIはLinux Dockerイメージとして利用可能で、安価なLinux VPSインスタンス、高性能サーバー、信頼性の高いクラウドプラットフォームでcBotを実行できます。 このイメージは、Docker Desktop（WSL）を通じてWindows上でもDockerコンテナとして使用できます。

cTrader CLI DockerイメージはSpotware Githubパッケージで公開されており、主要なcTrader Windowsアップデートごとに新しいリリースが提供されます。

cTrader CLI Dockerイメージを使用するには、マシンにDockerがインストールされていることを確認し、最新のcTrader CLI Dockerイメージをプルします：

1

docker pull ghcr.io/spotware/ctrader-console:latest

イメージをプルした後、コンテナを作成して実行する必要があります。 Dockerコンテナはオペレーティングシステムから隔離された仮想化されたサンドボックスで実行されるため、コンテナがcBotアルゴリズムファイルとcTIDパスワードファイルにアクセスできるように明示的に許可する必要があります。 これは、Dockerのマウント機能を使用して実現できます。この機能により、コンテナはホストシステムからディレクトリまたはファイルにアクセスできます。

以下のコマンドは、プルしたイメージに基づいてコンテナを作成し、cBotを実行します：

1

docker run -d -it --name ctrader.console.run.mybot --mount type=bind,src=/cAlgo/Robots,dst=/mnt/Robots -e CTID='mycid' -e PWD-FILE='/mnt/Robots/ctrader-cli.pwd' -e ACCOUNT='9102302' -e SYMBOL='EURUSD' -e PERIOD='H1' ghcr.io/spotware/ctrader-console:latest run "/mnt/Robots/My bot.algo" --environment-variables

1
2
3
4
5
6
7
8
9

docker run -d -it \
  --name ctrader.console.run.mybot \
  --mount type=bind,src=/cAlgo/Robots,dst=/mnt/Robots \
  -e CTID='mycid' \
  -e PWD-FILE='/mnt/Robots/ctrader-cli.pwd' \
  -e ACCOUNT='9102302' \
  -e SYMBOL='EURUSD' \
  -e PERIOD='H1' \
  ghcr.io/spotware/ctrader-console:latest run "/mnt/Robots/My bot.algo" --environment-variables

コマンドの残りのパラメータは以下の通りです：

また、cTrader CLIイメージに基づいて実行準備が整ったDockerイメージを作成し、アルゴリズムファイルをコピーして、すべての環境変数とその他の設定をイメージ内で直接構成することもできます。

一般的な使用例

これは、トレーダーがcTrader CLIを使用する人気のある操作のリストです：

• すべてのシンボルを取得

  1	ctrader-cli symbols --ctid=letstrade@email.com --pwd-file=C:/test/password.pwd --account=1234567

  応答：

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

  [ { "Id": 1, "Name": "EURUSD", "Description": "Euro vs US Dollar" }, . . . { "Id": 21497, "Name": "HONG KONG 50", "Description": "HONG KONG 50" } ]

• アルゴリズムのメタデータを取得

  1	ctrader-cli metadata C:/test/RSI_cBot.algo

  応答：

  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

  { "Name": "RSI_cBot", "Type": "cBot", "AccessRights": "None", "BuildTime": "2023-05-11T16:42:56.7421508+03:00", "Parameters": [ { "PropertyName": "Quantity", "FriendlyName": "Quantity (Lots)", "GroupName": "Volume", "Type": "Double", "DefaultValue": 1.0, "MinValue": 0.01 }, { "PropertyName": "Source", "FriendlyName": "Source", "GroupName": "RSI", "Type": "DataSeries", "DefaultValue": { "OwnerId": "00000000-0000-0000-0000-000000000000", "FriendlyName": "Close", "IsStandard": true } }, { "PropertyName": "Periods", "FriendlyName": "Periods", "GroupName": "RSI", "Type": "Integer", "DefaultValue": 14 } ] }

• cBotをバックテスト

  1	ctrader-cli run C:\test\mycbot.algo -c=letstrade@email.com --pwd-file=C:\test\password.pwd --account=1234567 --symbol=EURUSD --period=h1

• デフォルトパラメータでcBotを実行

  1	ctrader-cli run C:\test\mycbot.algo -c=letstrade --pwd-file=C:\test\password.pwd --account=1234567 --symbol=EURUSD --period=h1

• カスタムパラメータでcBotを実行

  1	ctrader-cli run C:\mycbot.algo -c=letstrade@email.com --pwd-file=C:\test\password.pwd --account=1234567 --symbol=EURUSD --period=h1 --ConsolidationPeriods=3 --Periods=15

• ファイルに保存されたパラメータでcBotを実行

  1	ctrader-cli run C:\mycbot.algo C:\test\mysettings.cbotset -c=letstrade --pwd-file=C:\test\password.pwd --account=1234567 --symbol=EURUSD --period=h1

コマンドの詳細

cTrader CLIは、他のコマンドラインツールと同じように動作します。 ユーザーはctrader-cliと事前定義されたコマンドを入力して実行します。 例えば、periodsコマンドは以下のように使用され、アルゴリズムが実行できるすべてのチャート期間をリストアップします：

1

ctrader-cli periods

一部のコマンドには、以下のルールに従うオプションや引数があります：

• --はオプションの完全版（例：--ctid、--symbol）の前に書き、-は短縮版（例：-c、-s）の前に書きます。

• オプションの値は、スペース（例：--ctid letstrade、--symbol EURUSD）または等号（例：--ctid=letstrade、--symbol=EURUSD）を使用して指定できます。

• オプションとは異なり、引数はそのまま入力されます。 アルゴリズムのパスを考えてみましょう。 これは単に入力される引数です：C:/test/mycbot.algo

スペースを含むパスや値は、以下のように単一引用符または二重引用符を使用して指定する必要があります：

• 引数：'C:/test for cbot/my cbot.algo'または"C:/test for cbot/my cbot.algo"
• オプション：--pwd-file='C:\test for cbot\password.pwd'または--pwd-file="C:\test for cbot\password.pwd"、--start='01/01/2024 12:34'または--start="01/01/2024 12:34"など。

PWDまたはTXTファイルの作成

cTrader IDのパスワードは直接指定されません。 代わりに、PWDまたはTXTファイルに保存され、--pwd-fileオプションを使用してファイルへのパスを指定します（例: --pwd-file=C:\test\password.pwdまたは--pwd-file=C:\test\password.txt）。

テキストエディタ（例: メモ帳）で空のドキュメントを開き、パスワードを貼り付けるか入力し（空白なし）、.pwdまたは.txt拡張子でファイルを保存します。

すべてのCLIコマンド

説明

cTrader CLIでのバックテスト

バックテストを使用すると、トレーダーは過去のデータを使用してcBotのパフォーマンスと信頼性を評価し、その強みや弱みを発見し、パラメーターを実験することができます。 過去の市場状況で取引をシミュレートすることにより、バックテストは実際の資金がライブ市場で投入される前にアルゴリズムがどのように機能するかを判断するのに役立ちます。

コマンド

すべての可能なオプションを備えたバックテストコマンド：

1

ctrader-cli backtest <cbot.algo> [<params.cbotset>] --start=<start-time> --end=<end-time> --data-mode=<data-mode> [--data-file=<path>] [--balance=<balance>] [--commission=<commission>] [--spread=<pips>] [--report=<path>] --ctid=<ctid> --pwd-file=<path> --account=<id> --symbol=<name> --period=<period> [--CustomParameter1=<value>] [--environment-variables]

サンプルのバックテストコマンド：

1

ctrader-cli backtest 'C:\test\sample martingale.algo' C:\test\special-parameters.cbotset --start='01/01/2024 12:34' --end='31/08/2024 20:56' --balance=10000 --commission=30 --data-mode=m1 --spread=1 --ctid=letstrade --pwd-file=C:\test\password.pwd --account=4791386 

レポート

backtestコマンドが実行されると、cTrader CLIはまずバックテストのパラメーターに関する情報を表示します。

バックテスト操作が終了すると、cTrader CLIは結果の概要を表示します。

さらに、cTrader CLIはバックテストの結果と有用な詳細をBacktestingフォルダに保存します。 すべてのバックテスト操作には独自のInstanceIDとBacktestingフォルダが割り当てられます。

特定のcBotバックテストインスタンスへのパス： …\data\{cBotName}\{BacktestingInstanceID}\Backtesting

上記のパスにあるデータフォルダは、通常、バックテスト中に指定されたcBotのアルゴリズムファイルと同じディレクトリにあります。

イベントログパラメーターレポート

events JSONファイルには、すべての重要な取引イベントの詳細が含まれています。

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

[ { "serial": 0, "orderId": null, "positionId": 1, "event": "Create Position", "time": 1704146700000, "volume": 100000, "quantity": 1, "type": "Sell", "entryPrice": 1.10426, "tp": 1.10026, "sl": 1.10826, "closePrice": null, "grossProfit": 0, "pips": 0, "balance": null, "equity": 10000 }, . . . { "serial": 284, "orderId": null, "positionId": 143, "event": "Create Position", "time": 1725023280000, "volume": 200000, "quantity": 2, "type": "Buy", "entryPrice": 1.10559, "tp": 1.10959, "sl": 1.10159, "closePrice": null, "grossProfit": 0, "pips": 0, "balance": null, "equity": 32340.43 } ]

log TXT（テキスト）ファイルには、cBotの開始、停止、取引アクションおよび結果に関する情報が提供されます。

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

Info | CBot instance [sample martingale, EURUSD, h1] started. 01/01/2024 22:05:00.000 | Trade | Executing Market Order to Sell 100000 EURUSD (SL: 40, TP: 40) 01/01/2024 22:05:00.000 | Trade | → Executing Market Order to Sell 100000 EURUSD (SL: 40, TP: 40) SUCCEEDED, Position PID1 02/01/2024 10:12:00.000 | Info | Closed 02/01/2024 10:12:00.000 | Trade | Executing Market Order to Buy 100000 EURUSD (SL: 40, TP: 40) 02/01/2024 10:12:00.000 | Trade | → Executing Market Order to Buy 100000 EURUSD (SL: 40, TP: 40) SUCCEEDED, Position PID2 02/01/2024 12:22:00.000 | Info | Closed 02/01/2024 12:22:00.000 | Trade | Executing Market Order to Buy 200000 EURUSD (SL: 40, TP: 40) 02/01/2024 12:22:00.000 | Trade | → Executing Market Order to Buy 200000 EURUSD (SL: 40, TP: 40) SUCCEEDED, Position PID3 . . . 30/08/2024 13:08:00.000 | Info | Closed 30/08/2024 13:08:00.000 | Trade | Executing Market Order to Buy 200000 EURUSD (SL: 40, TP: 40) 30/08/2024 13:08:00.000 | Trade | → Executing Market Order to Buy 200000 EURUSD (SL: 40, TP: 40) SUCCEEDED, Position PID143 Info | CBot instance [sample martingale, EURUSD, h1] stopped.

parameters CBOTSETファイルには、バックテスト操作で使用されたパラメーターと値が含まれています。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21

{ "Chart": { "Symbol": "EURUSD", "Period": "h1" }, "Parameters": { "InitialQuantity": "1", "StopLoss": "40", "TakeProfit": "40" } }

report HTMLファイルは、バックテスト操作の概要、取引統計、注文履歴、および多くの重要な詳細を提供するGUIレポートです。 これは任意のウェブブラウザで表示できます。

エラーのトラブルシューティング

cTrader CLIでのcTrader Algo API

一部のcTrader Algo APIメンバーは、cTrader CLIでは異なる動作をします。 以下の表に、メンバーとその動作の変更について説明します。

概要

cTrader CLIは、アルゴリズム取引活動の範囲を拡大したいトレーダーにとって不可欠な機能です。なぜなら、cTrader CLIを使用することで、cBotを効率的に実行および管理するための簡単なコマンドライン指示を提供するからです。 ユーザーは常に、cTrader CLIを有用なAPIやニーズに合ったサードパーティサービスと統合することを推奨されています。