Exécuter des commandes cTrader CLI¶

Cet article explique la structure des commandes cTrader CLI, le fonctionnement de l’authentification et la consultation des données de compte, des prix et de l’historique.

Structure des commandes ¶

Toutes les commandes cTrader CLI suivent la même structure :

ctrader-cli <command> [arguments] [options]

• Les options commencent par un préfixe. -- correspond à la forme longue et - à la forme courte (--symbol et -s sont équivalents).
• Les valeurs des options sont séparées par un espace ou un signe égal. Les deux formes --symbol EURUSD et --symbol=EURUSD sont valides.
• Les arguments sont des valeurs positionnelles sans préfixe. Le chemin d’accès à un fichier .algo est un argument.
• Les valeurs contenant des espaces doivent être placées entre guillemets simples ou doubles, par exemple '/opt/my cbots/trend cbot.algo'. Utilisez le même type de guillemets de manière cohérente au sein d’une commande.

Authentification ¶

cTrader CLI utilise deux modes d’authentification. Tous deux s’appuient sur le fichier d’identifiants préparé lors de la configuration.

Les commandes accounts, symbols, metadata, run et backtest existent dans les deux modes. Selon les options fournies, elles s’exécutent en mode par lots ou en mode interactif :

• Mode traitement par lots – lit les identifiants depuis --pwd-file (ou --broker) et s’exécute sans interaction.
• Mode interactif – utilise --password et -q (ou toute option propre à la commande) et s’exécute comme un appel interactif.

Identifiants de période ¶

De nombreuses commandes acceptent une valeur --period. Exécutez ctrader-cli periods pour afficher tous les identifiants acceptés. Ces identifiants couvrent les minutes, heures, jours, semaines et mois, ainsi que les ticks, Renko, barres de range et variantes Heikin Ashi. La casse des caractères n’a aucune importance.

Unités de volume ¶

L’option --volume accepte les unités de la devise de base ou les lots. Utilisez --volume-type=units (par défaut) ou --volume-type=lots pour choisir l’unité du volume. Pour la plupart des paires Forex, 100 000 unités correspondent à un lot standard.

ctrader-cli symbol --ctid=letstrade --pwd-file=C:/test/password.pwd --account=1234567 -q --symbol=XAUUSD

Dates et heures ¶

Toutes les dates et heures utilisées par cTrader CLI sont en UTC. La CLI n’utilise jamais le fuseau horaire local de votre ordinateur ni l’heure du serveur du courtier.

L’UTC s’applique aux sorties des commandes et aux dates saisies comme suit :

• Sortie : tous les horodatages des résultats JSON sont exprimés en UTC au format ISO 8601 avec Z, par exemple 2026-10-08T14:05:00.000Z.
• Commandes interactives (candles, deals, orders-history et backtest exécuté avec -q) : --from et --to n’acceptent qu’une date, au format yyyy-MM-dd, dd/MM/yyyy, dd-MM-yyyy ou yyyy/MM/dd. Cette date correspond à un jour calendaire en UTC.
  • Pour deals et orders-history, --to inclut toute la journée, jusqu’à 23:59:59 UTC.
  • Pour candles, --to correspond au début de la journée (00:00 UTC). Pour inclure une journée entière, définissez --to sur le jour suivant.
  • Sans --from / --to, le backtest interactif couvre les 7 derniers jours.
• Commandes exécutées en mode traitement par lots (backtest et autres) : les dates utilisent le format dd/MM/yyyy, éventuellement suivi d’une heure au format 24 heures dd/MM/yyyy HH:mm, par exemple 31/12/2026 18:00, toujours en UTC.

La seule exception concerne un cBot en cours d’exécution (run, backtest). Son heure suit le paramètre TimeZone défini dans le cBot, comme dans cTrader Algo.

Consulter les données de compte et de marché ¶

La commande ctrader-cli periods ne nécessite ni compte ni identifiants. Elle constitue donc un bon premier test.

ctrader-cli periods

Listez les comptes de trading associés à votre cTrader ID :

ctrader-cli accounts --ctid=letstrade --pwd-file=C:/test/password.pwd

Une fois le numéro de compte obtenu, listez les symboles disponibles sur ce compte :

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

Consultez le prix actuel d’un symbole et récupérez les bougies historiques dans un script :

ctrader-cli price --ctid=letstrade --password=secret --account=1234567 -q --symbol=EURUSD
ctrader-cli candles --ctid=letstrade --password=secret --account=1234567 -q --symbol=EURUSD --period=h1 --count=200 > eurUSD_h1.json

Limites de l’historique ¶

deals et orders-history appliquent les limites d’historique suivantes :

• La CLI charge toute la période définie par --from et --to, sans limitation de durée.
• Un seul appel renvoie au maximum les 200 dernières transactions (deals) ou les 500 derniers ordres (orders-history) de la période.
• Sans --from ni --to, les deux commandes ne renvoient que les 30 derniers jours.

• --count définit le nombre d’enregistrements à renvoyer :

  • 50 par défaut et jusqu’à 200 pour deals.
  • 100 par défaut et jusqu’à 500 pour orders-history.

--count est ignoré si --from ou --to est fourni. L’appel renvoie alors jusqu’au nombre maximal d’enregistrements.

Si une plage contient plus d’enregistrements qu’un seul appel ne peut en renvoyer, divisez-la en plages plus courtes et exécutez la commande pour chacune.

Pour déterminer si les résultats ont été tronqués, examinez la sortie :

• orders-history : la sortie contient les champs available et returned. Si available est supérieur à returned, d’autres ordres sont présents dans la plage.
• deals : si count est exactement égal à 200, il se peut que la plage contienne davantage de trades.

Actions groupées dans le shell interactif ¶

Dans le shell interactif, plusieurs commandes acceptent les arguments finaux all et yes pour effectuer une action groupée sans demander de confirmation.

Exécuter des commandes en mode interactif ¶

Exécutez ctrader-cli sans préciser de commande pour ouvrir le shell interactif. À l’invite, connectez-vous avec votre cTID et votre mot de passe, puis saisissez plusieurs commandes successivement sans avoir à fournir de nouveau vos identifiants. Ce mode est pratique lorsque vous souhaitez exécuter plusieurs commandes à la suite.

Pour exécuter une seule commande et quitter immédiatement, ajoutez -q. Cette option est utile dans les scripts, car le processus doit se terminer dès que la commande a fini de s’exécuter.

Deux options permettent de découvrir les fonctionnalités prises en charge par la CLI.

Si votre cTrader ID est associé à des comptes de plusieurs courtiers portant le même numéro de compte, ajoutez --broker=<broker-name> pour lever l’ambiguïté.

Erreurs courantes ¶