Files
mt5cli/api/cli/index.html
T

3241 lines
348 KiB
HTML
Raw Normal View History

2026-05-24 16:49:15 +00:00
<!DOCTYPE html>
<html lang="en" data-bs-theme="light">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
2026-04-22 17:11:38 +00:00
2026-05-24 16:49:15 +00:00
<meta name="author" content="dceoy">
<link rel="canonical" href="https://github.com/dceoy/mt5cli/api/cli/">
<link rel="shortcut icon" href="../../img/favicon.ico">
<title>CLI - mt5cli API Documentation</title>
<link href="../../css/bootstrap.min.css" rel="stylesheet">
<link href="../../css/fontawesome.min.css" rel="stylesheet">
<link href="../../css/brands.min.css" rel="stylesheet">
<link href="../../css/solid.min.css" rel="stylesheet">
<link href="../../css/v4-font-face.min.css" rel="stylesheet">
<link href="../../css/base.css" rel="stylesheet">
<link id="hljs-light" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" >
<link id="hljs-dark" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github-dark.min.css" disabled>
<link href="../../assets/_mkdocstrings.css" rel="stylesheet">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body>
<div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
<div class="container">
<a class="navbar-brand" href="../..">mt5cli API Documentation</a>
<!-- Expander button -->
<button type="button" class="navbar-toggler" data-bs-toggle="collapse" data-bs-target="#navbar-collapse" aria-controls="navbar-collapse" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<!-- Expanded navigation -->
<div id="navbar-collapse" class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li class="nav-item">
<a href="../.." class="nav-link">Home</a>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle active" aria-current="page" role="button" data-bs-toggle="dropdown" aria-expanded="false">API Reference</a>
<ul class="dropdown-menu">
<li>
<a href="../" class="dropdown-item">Overview</a>
</li>
2026-06-18 10:12:55 +00:00
<li>
<a href="../public-contract/" class="dropdown-item">Public API Contract</a>
</li>
2026-06-12 16:32:35 +00:00
<li>
<a href="../client/" class="dropdown-item">Client</a>
</li>
<li>
<a href="../schemas/" class="dropdown-item">Schemas</a>
</li>
<li>
<a href="../converters/" class="dropdown-item">Converters</a>
</li>
<li>
<a href="../exceptions/" class="dropdown-item">Exceptions</a>
</li>
2026-05-24 16:49:15 +00:00
<li>
<a href="./" class="dropdown-item active" aria-current="page">CLI</a>
</li>
2026-06-08 13:55:22 +00:00
<li>
<a href="../sdk/" class="dropdown-item">SDK</a>
</li>
2026-06-11 10:33:27 +00:00
<li>
<a href="../trading/" class="dropdown-item">Trading</a>
</li>
2026-06-08 16:28:50 +00:00
<li>
2026-06-08 17:40:53 +00:00
<a href="../history/" class="dropdown-item">History Collection (SQLite)</a>
2026-06-08 16:28:50 +00:00
</li>
2026-07-03 16:04:05 +00:00
<li>
<a href="../telemetry/" class="dropdown-item">Telemetry</a>
</li>
<li>
<a href="../grafana/" class="dropdown-item">Grafana</a>
</li>
2026-06-08 13:55:22 +00:00
<li>
<a href="../utils/" class="dropdown-item">Utils</a>
</li>
2026-05-24 16:49:15 +00:00
</ul>
</li>
</ul>
<ul class="nav navbar-nav ms-md-auto">
<li class="nav-item">
<a href="#" class="nav-link" data-bs-toggle="modal" data-bs-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li class="nav-item">
2026-06-12 16:32:35 +00:00
<a rel="prev" href="../exceptions/" class="nav-link">
2026-05-24 16:49:15 +00:00
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li class="nav-item">
2026-06-08 13:55:22 +00:00
<a rel="next" href="../sdk/" class="nav-link">
2026-05-24 16:49:15 +00:00
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
<li class="nav-item">
<a href="https://github.com/dceoy/mt5cli/edit/master/docs/api/cli.md" class="nav-link">Edit on dceoy/mt5cli
</a>
</li>
</ul>
2026-04-22 17:11:38 +00:00
</div>
2026-05-24 16:49:15 +00:00
</div>
</div>
<div class="container">
<div class="row">
<div class="col-md-3"><div class="navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
<div class="navbar-header">
<button type="button" class="navbar-toggler collapsed" data-bs-toggle="collapse" data-bs-target="#toc-collapse" title="Table of Contents">
<span class="fa fa-angle-down"></span>
</button>
</div>
2026-04-22 17:11:38 +00:00
2026-05-24 16:49:15 +00:00
<div id="toc-collapse" class="navbar-collapse collapse card bg-body-tertiary">
<ul class="nav flex-column">
2026-04-22 17:11:38 +00:00
2026-05-24 16:49:15 +00:00
<li class="nav-item" data-bs-level="1"><a href="#cli-module" class="nav-link">CLI Module</a>
<ul class="nav flex-column">
<li class="nav-item" data-bs-level="2"><a href="#mt5cli.cli" class="nav-link">cli</a>
<ul class="nav flex-column">
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div></div>
<div class="col-md-9" role="main">
2026-04-22 17:11:38 +00:00
<h1 id="cli-module">CLI Module<a class="headerlink" href="#cli-module" title="Permanent link">&para;</a></h1>
<div class="doc doc-object doc-module">
<h2 id="mt5cli.cli" class="doc doc-heading">
<span class="doc doc-object-name doc-module-name">mt5cli.cli</span>
<a href="#mt5cli.cli" class="headerlink" title="Permanent link">&para;</a></h2>
<div class="doc doc-contents first">
2026-06-27 16:23:59 +00:00
<p>Command-line interface for MetaTrader 5 data and execution utilities.</p>
2026-04-22 17:11:38 +00:00
<div class="doc doc-children">
<div class="doc doc-object doc-attribute">
2026-06-08 13:55:22 +00:00
<h3 id="mt5cli.cli.app" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">app</span>
2026-04-22 17:11:38 +00:00
<span class="doc doc-labels">
<small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
</span>
2026-06-08 13:55:22 +00:00
<a href="#mt5cli.cli.app" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">app</span> <span class="o">=</span> <span class="n"><span title="typer.Typer">Typer</span></span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n"><span title="typer.Typer(name)">name</span></span><span class="o">=</span><span class="s2">&quot;mt5cli&quot;</span><span class="p">,</span>
2026-06-27 16:23:59 +00:00
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n"><span title="typer.Typer(help)">help</span></span><span class="o">=</span><span class="s2">&quot;MT5 data and execution utilities — read market data, inspect account state, and send trade requests. Data commands write to CSV, JSON, Parquet, or SQLite3. Execution commands (order-send, close-positions) require --yes for live mutations.&quot;</span><span class="p">,</span>
2026-06-08 13:55:22 +00:00
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="p">)</span>
2026-04-22 17:11:38 +00:00
</code></pre></div>
<div class="doc doc-contents ">
</div>
</div>
<div class="doc doc-object doc-attribute">
2026-06-08 13:55:22 +00:00
<h3 id="mt5cli.cli.logger" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">logger</span>
2026-04-26 12:50:38 +00:00
<span class="doc doc-labels">
<small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
</span>
2026-06-08 13:55:22 +00:00
<a href="#mt5cli.cli.logger" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">logger</span> <span class="o">=</span> <span class="n"><span title="logging.getLogger">getLogger</span></span><span class="p">(</span><span class="n"><span title="__name__">__name__</span></span><span class="p">)</span>
2026-04-26 12:50:38 +00:00
</code></pre></div>
<div class="doc doc-contents ">
</div>
</div>
2026-06-08 13:55:22 +00:00
<div class="doc doc-object doc-function">
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
<h3 id="mt5cli.cli.account_info" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">account_info</span>
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
<a href="#mt5cli.cli.account_info" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">account_info</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
2026-04-22 17:11:38 +00:00
</code></pre></div>
<div class="doc doc-contents ">
2026-06-08 13:55:22 +00:00
<p>Export account information.</p>
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-454">454</a></span>
<span class="normal"><a href="#__codelineno-0-455">455</a></span>
<span class="normal"><a href="#__codelineno-0-456">456</a></span>
<span class="normal"><a href="#__codelineno-0-457">457</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-454" name="__codelineno-0-454"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-455" name="__codelineno-0-455"></a><span class="k">def</span><span class="w"> </span><span class="nf">account_info</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-456" name="__codelineno-0-456"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export account information.&quot;&quot;&quot;</span>
<a id="__codelineno-0-457" name="__codelineno-0-457"></a> <span class="n">_export_command</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">account_info</span><span class="p">())</span>
2026-06-25 01:40:44 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="mt5cli.cli.close_positions" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">close_positions</span>
<a href="#mt5cli.cli.close_positions" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">close_positions</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n"><span title="list">list</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="s2">&quot;--symbol&quot;</span><span class="p">,</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="s2">&quot;-s&quot;</span><span class="p">,</span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Symbol to close (repeat for multiple symbols).&quot;</span><span class="p">,</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="p">),</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n"><span title="list">list</span></span><span class="p">[</span><span class="n"><span title="int">int</span></span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="s2">&quot;--ticket&quot;</span><span class="p">,</span>
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="s2">&quot;-t&quot;</span><span class="p">,</span>
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Position ticket to close (repeat for multiple tickets).&quot;</span><span class="p">,</span>
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> <span class="p">),</span>
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
2026-07-04 05:20:25 +00:00
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> <span class="n">deviation</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
2026-06-25 01:40:44 +00:00
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
2026-07-04 05:20:25 +00:00
<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Optional slippage/deviation for each close request.&quot;</span>
<a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a> <span class="p">),</span>
<a id="__codelineno-0-24" name="__codelineno-0-24" href="#__codelineno-0-24"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-25" name="__codelineno-0-25" href="#__codelineno-0-25"></a> <span class="n">comment</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-26" name="__codelineno-0-26" href="#__codelineno-0-26"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-27" name="__codelineno-0-27" href="#__codelineno-0-27"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-28" name="__codelineno-0-28" href="#__codelineno-0-28"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Optional comment attached to each close request.&quot;</span>
<a id="__codelineno-0-29" name="__codelineno-0-29" href="#__codelineno-0-29"></a> <span class="p">),</span>
<a id="__codelineno-0-30" name="__codelineno-0-30" href="#__codelineno-0-30"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-31" name="__codelineno-0-31" href="#__codelineno-0-31"></a> <span class="n">magic</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-32" name="__codelineno-0-32" href="#__codelineno-0-32"></a> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-33" name="__codelineno-0-33" href="#__codelineno-0-33"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-34" name="__codelineno-0-34" href="#__codelineno-0-34"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Optional magic tag for close requests and position filtering.&quot;</span>
<a id="__codelineno-0-35" name="__codelineno-0-35" href="#__codelineno-0-35"></a> <span class="p">),</span>
<a id="__codelineno-0-36" name="__codelineno-0-36" href="#__codelineno-0-36"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-37" name="__codelineno-0-37" href="#__codelineno-0-37"></a> <span class="n">dry_run</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-38" name="__codelineno-0-38" href="#__codelineno-0-38"></a> <span class="n"><span title="bool">bool</span></span><span class="p">,</span>
<a id="__codelineno-0-39" name="__codelineno-0-39" href="#__codelineno-0-39"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-40" name="__codelineno-0-40" href="#__codelineno-0-40"></a> <span class="s2">&quot;--dry-run&quot;</span><span class="p">,</span>
<a id="__codelineno-0-41" name="__codelineno-0-41" href="#__codelineno-0-41"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Preview close orders without executing them.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-42" name="__codelineno-0-42" href="#__codelineno-0-42"></a> <span class="p">),</span>
<a id="__codelineno-0-43" name="__codelineno-0-43" href="#__codelineno-0-43"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
<a id="__codelineno-0-44" name="__codelineno-0-44" href="#__codelineno-0-44"></a> <span class="n">yes</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-45" name="__codelineno-0-45" href="#__codelineno-0-45"></a> <span class="n"><span title="bool">bool</span></span><span class="p">,</span>
<a id="__codelineno-0-46" name="__codelineno-0-46" href="#__codelineno-0-46"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-47" name="__codelineno-0-47" href="#__codelineno-0-47"></a> <span class="s2">&quot;--yes&quot;</span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Confirm live position closing.&quot;</span>
<a id="__codelineno-0-48" name="__codelineno-0-48" href="#__codelineno-0-48"></a> <span class="p">),</span>
<a id="__codelineno-0-49" name="__codelineno-0-49" href="#__codelineno-0-49"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
<a id="__codelineno-0-50" name="__codelineno-0-50" href="#__codelineno-0-50"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
2026-06-25 01:40:44 +00:00
</code></pre></div>
<div class="doc doc-contents ">
<p>Close open positions by symbol or ticket.</p>
<p>Delegates to :func:<code>mt5cli.trading.close_open_positions</code>. At least one
<code>--symbol</code> or <code>--ticket</code> must be provided to avoid accidentally closing
all positions. Use <code>--dry-run</code> to preview without executing; <code>--yes</code> is
required for live execution.</p>
<p><code>order-send</code> is the expert raw-request path. <code>close-positions</code> is the
safer high-level helper that builds correct close requests automatically.</p>
<p><span class="doc-section-title">Raises:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code><span title="typer.BadParameter">BadParameter</span></code>
</td>
<td>
<div class="doc-md-description">
<p>If neither <code>--symbol</code> nor <code>--ticket</code> is given,
or if <code>--yes</code> is missing for a live (non-dry-run) run.</p>
</div>
</td>
</tr>
</tbody>
</table>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-711">711</a></span>
<span class="normal"><a href="#__codelineno-0-712">712</a></span>
<span class="normal"><a href="#__codelineno-0-713">713</a></span>
<span class="normal"><a href="#__codelineno-0-714">714</a></span>
<span class="normal"><a href="#__codelineno-0-715">715</a></span>
<span class="normal"><a href="#__codelineno-0-716">716</a></span>
<span class="normal"><a href="#__codelineno-0-717">717</a></span>
<span class="normal"><a href="#__codelineno-0-718">718</a></span>
<span class="normal"><a href="#__codelineno-0-719">719</a></span>
<span class="normal"><a href="#__codelineno-0-720">720</a></span>
<span class="normal"><a href="#__codelineno-0-721">721</a></span>
<span class="normal"><a href="#__codelineno-0-722">722</a></span>
<span class="normal"><a href="#__codelineno-0-723">723</a></span>
<span class="normal"><a href="#__codelineno-0-724">724</a></span>
<span class="normal"><a href="#__codelineno-0-725">725</a></span>
<span class="normal"><a href="#__codelineno-0-726">726</a></span>
<span class="normal"><a href="#__codelineno-0-727">727</a></span>
<span class="normal"><a href="#__codelineno-0-728">728</a></span>
<span class="normal"><a href="#__codelineno-0-729">729</a></span>
<span class="normal"><a href="#__codelineno-0-730">730</a></span>
<span class="normal"><a href="#__codelineno-0-731">731</a></span>
<span class="normal"><a href="#__codelineno-0-732">732</a></span>
<span class="normal"><a href="#__codelineno-0-733">733</a></span>
<span class="normal"><a href="#__codelineno-0-734">734</a></span>
<span class="normal"><a href="#__codelineno-0-735">735</a></span>
<span class="normal"><a href="#__codelineno-0-736">736</a></span>
<span class="normal"><a href="#__codelineno-0-737">737</a></span>
<span class="normal"><a href="#__codelineno-0-738">738</a></span>
<span class="normal"><a href="#__codelineno-0-739">739</a></span>
<span class="normal"><a href="#__codelineno-0-740">740</a></span>
<span class="normal"><a href="#__codelineno-0-741">741</a></span>
<span class="normal"><a href="#__codelineno-0-742">742</a></span>
<span class="normal"><a href="#__codelineno-0-743">743</a></span>
<span class="normal"><a href="#__codelineno-0-744">744</a></span>
<span class="normal"><a href="#__codelineno-0-745">745</a></span>
<span class="normal"><a href="#__codelineno-0-746">746</a></span>
<span class="normal"><a href="#__codelineno-0-747">747</a></span>
<span class="normal"><a href="#__codelineno-0-748">748</a></span>
<span class="normal"><a href="#__codelineno-0-749">749</a></span>
<span class="normal"><a href="#__codelineno-0-750">750</a></span>
<span class="normal"><a href="#__codelineno-0-751">751</a></span>
<span class="normal"><a href="#__codelineno-0-752">752</a></span>
<span class="normal"><a href="#__codelineno-0-753">753</a></span>
<span class="normal"><a href="#__codelineno-0-754">754</a></span>
<span class="normal"><a href="#__codelineno-0-755">755</a></span>
<span class="normal"><a href="#__codelineno-0-756">756</a></span>
<span class="normal"><a href="#__codelineno-0-757">757</a></span>
<span class="normal"><a href="#__codelineno-0-758">758</a></span>
<span class="normal"><a href="#__codelineno-0-759">759</a></span>
<span class="normal"><a href="#__codelineno-0-760">760</a></span>
<span class="normal"><a href="#__codelineno-0-761">761</a></span>
<span class="normal"><a href="#__codelineno-0-762">762</a></span>
<span class="normal"><a href="#__codelineno-0-763">763</a></span>
<span class="normal"><a href="#__codelineno-0-764">764</a></span>
<span class="normal"><a href="#__codelineno-0-765">765</a></span>
<span class="normal"><a href="#__codelineno-0-766">766</a></span>
<span class="normal"><a href="#__codelineno-0-767">767</a></span>
<span class="normal"><a href="#__codelineno-0-768">768</a></span>
<span class="normal"><a href="#__codelineno-0-769">769</a></span>
<span class="normal"><a href="#__codelineno-0-770">770</a></span>
<span class="normal"><a href="#__codelineno-0-771">771</a></span>
<span class="normal"><a href="#__codelineno-0-772">772</a></span>
<span class="normal"><a href="#__codelineno-0-773">773</a></span>
<span class="normal"><a href="#__codelineno-0-774">774</a></span>
<span class="normal"><a href="#__codelineno-0-775">775</a></span>
<span class="normal"><a href="#__codelineno-0-776">776</a></span>
<span class="normal"><a href="#__codelineno-0-777">777</a></span>
<span class="normal"><a href="#__codelineno-0-778">778</a></span>
<span class="normal"><a href="#__codelineno-0-779">779</a></span>
<span class="normal"><a href="#__codelineno-0-780">780</a></span>
<span class="normal"><a href="#__codelineno-0-781">781</a></span>
<span class="normal"><a href="#__codelineno-0-782">782</a></span>
<span class="normal"><a href="#__codelineno-0-783">783</a></span>
<span class="normal"><a href="#__codelineno-0-784">784</a></span>
<span class="normal"><a href="#__codelineno-0-785">785</a></span>
<span class="normal"><a href="#__codelineno-0-786">786</a></span>
<span class="normal"><a href="#__codelineno-0-787">787</a></span>
<span class="normal"><a href="#__codelineno-0-788">788</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-711" name="__codelineno-0-711"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Execution&quot;</span><span class="p">)</span>
<a id="__codelineno-0-712" name="__codelineno-0-712"></a><span class="k">def</span><span class="w"> </span><span class="nf">close_positions</span><span class="p">(</span>
<a id="__codelineno-0-713" name="__codelineno-0-713"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-714" name="__codelineno-0-714"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-715" name="__codelineno-0-715"></a> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-716" name="__codelineno-0-716"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-717" name="__codelineno-0-717"></a> <span class="s2">&quot;--symbol&quot;</span><span class="p">,</span>
<a id="__codelineno-0-718" name="__codelineno-0-718"></a> <span class="s2">&quot;-s&quot;</span><span class="p">,</span>
<a id="__codelineno-0-719" name="__codelineno-0-719"></a> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Symbol to close (repeat for multiple symbols).&quot;</span><span class="p">,</span>
<a id="__codelineno-0-720" name="__codelineno-0-720"></a> <span class="p">),</span>
<a id="__codelineno-0-721" name="__codelineno-0-721"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-722" name="__codelineno-0-722"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-723" name="__codelineno-0-723"></a> <span class="nb">list</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-724" name="__codelineno-0-724"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-725" name="__codelineno-0-725"></a> <span class="s2">&quot;--ticket&quot;</span><span class="p">,</span>
<a id="__codelineno-0-726" name="__codelineno-0-726"></a> <span class="s2">&quot;-t&quot;</span><span class="p">,</span>
<a id="__codelineno-0-727" name="__codelineno-0-727"></a> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Position ticket to close (repeat for multiple tickets).&quot;</span><span class="p">,</span>
<a id="__codelineno-0-728" name="__codelineno-0-728"></a> <span class="p">),</span>
<a id="__codelineno-0-729" name="__codelineno-0-729"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-730" name="__codelineno-0-730"></a> <span class="n">deviation</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-731" name="__codelineno-0-731"></a> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-732" name="__codelineno-0-732"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Optional slippage/deviation for each close request.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-733" name="__codelineno-0-733"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-734" name="__codelineno-0-734"></a> <span class="n">comment</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-735" name="__codelineno-0-735"></a> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-736" name="__codelineno-0-736"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Optional comment attached to each close request.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-737" name="__codelineno-0-737"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-738" name="__codelineno-0-738"></a> <span class="n">magic</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-739" name="__codelineno-0-739"></a> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-740" name="__codelineno-0-740"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-741" name="__codelineno-0-741"></a> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Optional magic tag for close requests and position filtering.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-742" name="__codelineno-0-742"></a> <span class="p">),</span>
<a id="__codelineno-0-743" name="__codelineno-0-743"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-744" name="__codelineno-0-744"></a> <span class="n">dry_run</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-745" name="__codelineno-0-745"></a> <span class="nb">bool</span><span class="p">,</span>
<a id="__codelineno-0-746" name="__codelineno-0-746"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="s2">&quot;--dry-run&quot;</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Preview close orders without executing them.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-747" name="__codelineno-0-747"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
<a id="__codelineno-0-748" name="__codelineno-0-748"></a> <span class="n">yes</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-749" name="__codelineno-0-749"></a> <span class="nb">bool</span><span class="p">,</span>
<a id="__codelineno-0-750" name="__codelineno-0-750"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="s2">&quot;--yes&quot;</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Confirm live position closing.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-751" name="__codelineno-0-751"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
<a id="__codelineno-0-752" name="__codelineno-0-752"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-753" name="__codelineno-0-753"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Close open positions by symbol or ticket.</span>
<a id="__codelineno-0-754" name="__codelineno-0-754"></a>
<a id="__codelineno-0-755" name="__codelineno-0-755"></a><span class="sd"> Delegates to :func:`mt5cli.trading.close_open_positions`. At least one</span>
<a id="__codelineno-0-756" name="__codelineno-0-756"></a><span class="sd"> ``--symbol`` or ``--ticket`` must be provided to avoid accidentally closing</span>
<a id="__codelineno-0-757" name="__codelineno-0-757"></a><span class="sd"> all positions. Use ``--dry-run`` to preview without executing; ``--yes`` is</span>
<a id="__codelineno-0-758" name="__codelineno-0-758"></a><span class="sd"> required for live execution.</span>
<a id="__codelineno-0-759" name="__codelineno-0-759"></a>
<a id="__codelineno-0-760" name="__codelineno-0-760"></a><span class="sd"> ``order-send`` is the expert raw-request path. ``close-positions`` is the</span>
<a id="__codelineno-0-761" name="__codelineno-0-761"></a><span class="sd"> safer high-level helper that builds correct close requests automatically.</span>
<a id="__codelineno-0-762" name="__codelineno-0-762"></a>
<a id="__codelineno-0-763" name="__codelineno-0-763"></a><span class="sd"> Raises:</span>
<a id="__codelineno-0-764" name="__codelineno-0-764"></a><span class="sd"> typer.BadParameter: If neither ``--symbol`` nor ``--ticket`` is given,</span>
<a id="__codelineno-0-765" name="__codelineno-0-765"></a><span class="sd"> or if ``--yes`` is missing for a live (non-dry-run) run.</span>
<a id="__codelineno-0-766" name="__codelineno-0-766"></a><span class="sd"> &quot;&quot;&quot;</span>
<a id="__codelineno-0-767" name="__codelineno-0-767"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">symbol</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">ticket</span><span class="p">:</span>
<a id="__codelineno-0-768" name="__codelineno-0-768"></a> <span class="n">msg</span> <span class="o">=</span> <span class="s2">&quot;Provide at least one --symbol or --ticket to close positions.&quot;</span>
<a id="__codelineno-0-769" name="__codelineno-0-769"></a> <span class="k">raise</span> <span class="n">typer</span><span class="o">.</span><span class="n">BadParameter</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<a id="__codelineno-0-770" name="__codelineno-0-770"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">dry_run</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">yes</span><span class="p">:</span>
<a id="__codelineno-0-771" name="__codelineno-0-771"></a> <span class="n">msg</span> <span class="o">=</span> <span class="s2">&quot;Pass --yes to close live positions.&quot;</span>
<a id="__codelineno-0-772" name="__codelineno-0-772"></a> <span class="k">raise</span> <span class="n">typer</span><span class="o">.</span><span class="n">BadParameter</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">param_hint</span><span class="o">=</span><span class="s2">&quot;--yes&quot;</span><span class="p">)</span>
<a id="__codelineno-0-773" name="__codelineno-0-773"></a> <span class="n">export_ctx</span> <span class="o">=</span> <span class="n">_get_export_context</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
<a id="__codelineno-0-774" name="__codelineno-0-774"></a> <span class="n">client</span> <span class="o">=</span> <span class="n">create_trading_client</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="n">export_ctx</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
<a id="__codelineno-0-775" name="__codelineno-0-775"></a> <span class="k">try</span><span class="p">:</span>
<a id="__codelineno-0-776" name="__codelineno-0-776"></a> <span class="n">results</span> <span class="o">=</span> <span class="n">close_open_positions</span><span class="p">(</span>
<a id="__codelineno-0-777" name="__codelineno-0-777"></a> <span class="n">client</span><span class="p">,</span>
<a id="__codelineno-0-778" name="__codelineno-0-778"></a> <span class="n">symbols</span><span class="o">=</span><span class="nb">list</span><span class="p">(</span><span class="n">symbol</span><span class="p">)</span> <span class="k">if</span> <span class="n">symbol</span> <span class="k">else</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-779" name="__codelineno-0-779"></a> <span class="n">tickets</span><span class="o">=</span><span class="nb">list</span><span class="p">(</span><span class="n">ticket</span><span class="p">)</span> <span class="k">if</span> <span class="n">ticket</span> <span class="k">else</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-780" name="__codelineno-0-780"></a> <span class="n">deviation</span><span class="o">=</span><span class="n">deviation</span><span class="p">,</span>
<a id="__codelineno-0-781" name="__codelineno-0-781"></a> <span class="n">comment</span><span class="o">=</span><span class="n">comment</span><span class="p">,</span>
<a id="__codelineno-0-782" name="__codelineno-0-782"></a> <span class="n">magic</span><span class="o">=</span><span class="n">magic</span><span class="p">,</span>
<a id="__codelineno-0-783" name="__codelineno-0-783"></a> <span class="n">dry_run</span><span class="o">=</span><span class="n">dry_run</span><span class="p">,</span>
<a id="__codelineno-0-784" name="__codelineno-0-784"></a> <span class="p">)</span>
<a id="__codelineno-0-785" name="__codelineno-0-785"></a> <span class="k">finally</span><span class="p">:</span>
<a id="__codelineno-0-786" name="__codelineno-0-786"></a> <span class="n">client</span><span class="o">.</span><span class="n">shutdown</span><span class="p">()</span>
<a id="__codelineno-0-787" name="__codelineno-0-787"></a> <span class="n">df</span> <span class="o">=</span> <span class="n">_execution_results_to_df</span><span class="p">(</span><span class="n">results</span><span class="p">)</span>
<a id="__codelineno-0-788" name="__codelineno-0-788"></a> <span class="n">_execute_export</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="k">lambda</span><span class="p">:</span> <span class="n">df</span><span class="p">)</span>
2026-06-08 13:55:22 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
</div>
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
<div class="doc doc-object doc-function">
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
<h3 id="mt5cli.cli.collect_history" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">collect_history</span>
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
<a href="#mt5cli.cli.collect_history" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">collect_history</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n"><span title="list">list</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">],</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="s2">&quot;--symbol&quot;</span><span class="p">,</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="s2">&quot;-s&quot;</span><span class="p">,</span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Symbol to collect (repeat for multiple symbols).&quot;</span><span class="p">,</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="p">),</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="p">],</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n"><span title="datetime.datetime">datetime</span></span><span class="p">,</span>
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
module-attribute
(mt5cli.utils.DATETIME_TYPE)" href="../utils/#mt5cli.utils.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Start date.&quot;</span>
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="p">),</span>
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="p">],</span>
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> <span class="n"><span title="datetime.datetime">datetime</span></span><span class="p">,</span>
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
module-attribute
(mt5cli.utils.DATETIME_TYPE)" href="../utils/#mt5cli.utils.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;End date.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a> <span class="p">],</span>
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a> <span class="n">dataset</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a> <span class="n"><span title="list">list</span></span><span class="p">[</span><span class="n"><a class="autorefs autorefs-internal" title="Dataset (mt5cli.utils.Dataset)" href="../utils/#mt5cli.utils.Dataset">Dataset</a></span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-24" name="__codelineno-0-24" href="#__codelineno-0-24"></a> <span class="s2">&quot;--dataset&quot;</span><span class="p">,</span>
2026-06-27 21:01:21 +00:00
<a id="__codelineno-0-25" name="__codelineno-0-25" href="#__codelineno-0-25"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Dataset to include (repeat for multiple). Defaults to rates, history-orders, history-deals. Ticks are opt-in: pass --dataset ticks to include them.&quot;</span><span class="p">,</span>
2026-06-08 13:55:22 +00:00
<a id="__codelineno-0-26" name="__codelineno-0-26" href="#__codelineno-0-26"></a> <span class="p">),</span>
<a id="__codelineno-0-27" name="__codelineno-0-27" href="#__codelineno-0-27"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-28" name="__codelineno-0-28" href="#__codelineno-0-28"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-29" name="__codelineno-0-29" href="#__codelineno-0-29"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span>
<a id="__codelineno-0-30" name="__codelineno-0-30" href="#__codelineno-0-30"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-31" name="__codelineno-0-31" href="#__codelineno-0-31"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="TIMEFRAME_TYPE
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
module-attribute
(mt5cli.utils.TIMEFRAME_TYPE)" href="../utils/#mt5cli.utils.TIMEFRAME_TYPE">TIMEFRAME_TYPE</a></span><span class="p">,</span>
<a id="__codelineno-0-32" name="__codelineno-0-32" href="#__codelineno-0-32"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Rates timeframe (e.g., M1, H1, D1).&quot;</span><span class="p">,</span>
<a id="__codelineno-0-33" name="__codelineno-0-33" href="#__codelineno-0-33"></a> <span class="p">),</span>
<a id="__codelineno-0-34" name="__codelineno-0-34" href="#__codelineno-0-34"></a> <span class="p">]</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
<a id="__codelineno-0-35" name="__codelineno-0-35" href="#__codelineno-0-35"></a> <span class="n">flags</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-36" name="__codelineno-0-36" href="#__codelineno-0-36"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span>
<a id="__codelineno-0-37" name="__codelineno-0-37" href="#__codelineno-0-37"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-38" name="__codelineno-0-38" href="#__codelineno-0-38"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="TICK_FLAGS_TYPE
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
module-attribute
(mt5cli.utils.TICK_FLAGS_TYPE)" href="../utils/#mt5cli.utils.TICK_FLAGS_TYPE">TICK_FLAGS_TYPE</a></span><span class="p">,</span>
<a id="__codelineno-0-39" name="__codelineno-0-39" href="#__codelineno-0-39"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Tick copy flags (ALL, INFO, TRADE, or integer).&quot;</span><span class="p">,</span>
<a id="__codelineno-0-40" name="__codelineno-0-40" href="#__codelineno-0-40"></a> <span class="p">),</span>
2026-06-11 14:23:26 +00:00
<a id="__codelineno-0-41" name="__codelineno-0-41" href="#__codelineno-0-41"></a> <span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;ALL&quot;</span><span class="p">,</span>
2026-06-08 13:55:22 +00:00
<a id="__codelineno-0-42" name="__codelineno-0-42" href="#__codelineno-0-42"></a> <span class="n">if_exists</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-43" name="__codelineno-0-43" href="#__codelineno-0-43"></a> <span class="n"><a class="autorefs autorefs-internal" title="IfExists (mt5cli.utils.IfExists)" href="../utils/#mt5cli.utils.IfExists">IfExists</a></span><span class="p">,</span>
<a id="__codelineno-0-44" name="__codelineno-0-44" href="#__codelineno-0-44"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-45" name="__codelineno-0-45" href="#__codelineno-0-45"></a> <span class="s2">&quot;--if-exists&quot;</span><span class="p">,</span>
<a id="__codelineno-0-46" name="__codelineno-0-46" href="#__codelineno-0-46"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Behavior when a target table already exists.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-47" name="__codelineno-0-47" href="#__codelineno-0-47"></a> <span class="p">),</span>
<a id="__codelineno-0-48" name="__codelineno-0-48" href="#__codelineno-0-48"></a> <span class="p">]</span> <span class="o">=</span> <span class="n"><a class="autorefs autorefs-internal" title="FAIL
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
class-attribute
instance-attribute
(mt5cli.utils.IfExists.FAIL)" href="../utils/#mt5cli.utils.IfExists.FAIL">FAIL</a></span><span class="p">,</span>
<a id="__codelineno-0-49" name="__codelineno-0-49" href="#__codelineno-0-49"></a> <span class="n">with_views</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-50" name="__codelineno-0-50" href="#__codelineno-0-50"></a> <span class="n"><span title="bool">bool</span></span><span class="p">,</span>
<a id="__codelineno-0-51" name="__codelineno-0-51" href="#__codelineno-0-51"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-52" name="__codelineno-0-52" href="#__codelineno-0-52"></a> <span class="s2">&quot;--with-views&quot;</span><span class="p">,</span>
<a id="__codelineno-0-53" name="__codelineno-0-53" href="#__codelineno-0-53"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Add cash_events and positions_reconstructed SQLite views derived from history_deals.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-54" name="__codelineno-0-54" href="#__codelineno-0-54"></a> <span class="p">),</span>
<a id="__codelineno-0-55" name="__codelineno-0-55" href="#__codelineno-0-55"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
<a id="__codelineno-0-56" name="__codelineno-0-56" href="#__codelineno-0-56"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
2026-04-22 17:11:38 +00:00
</code></pre></div>
<div class="doc doc-contents ">
2026-06-08 13:55:22 +00:00
<p>Collect historical datasets into a single SQLite database.</p>
2026-06-27 21:01:21 +00:00
<p>Tables written depend on <code>--dataset</code>: <code>rates</code>, <code>history_orders</code>,
<code>history_deals</code> by default. <code>ticks</code> are opt-in: pass
<code>--dataset ticks</code> to include them (tick data grows the database quickly).
History datasets are fetched per symbol and concatenated. Rates rows carry
the requested <code>timeframe</code> so appended runs at different timeframes remain
distinguishable.</p>
2026-06-08 13:55:22 +00:00
<p>With <code>--with-views</code> (requires the <code>history-deals</code> dataset), optional
views <code>cash_events</code> and <code>positions_reconstructed</code> are derived from
<code>history_deals</code> when the required columns are present.</p>
<p><span class="doc-section-title">Raises:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code><span title="typer.BadParameter">BadParameter</span></code>
</td>
<td>
<div class="doc-md-description">
<p>If the output format is not SQLite3.</p>
</div>
</td>
</tr>
</tbody>
</table>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-858">858</a></span>
<span class="normal"><a href="#__codelineno-0-859">859</a></span>
<span class="normal"><a href="#__codelineno-0-860">860</a></span>
<span class="normal"><a href="#__codelineno-0-861">861</a></span>
<span class="normal"><a href="#__codelineno-0-862">862</a></span>
<span class="normal"><a href="#__codelineno-0-863">863</a></span>
<span class="normal"><a href="#__codelineno-0-864">864</a></span>
<span class="normal"><a href="#__codelineno-0-865">865</a></span>
<span class="normal"><a href="#__codelineno-0-866">866</a></span>
<span class="normal"><a href="#__codelineno-0-867">867</a></span>
<span class="normal"><a href="#__codelineno-0-868">868</a></span>
<span class="normal"><a href="#__codelineno-0-869">869</a></span>
<span class="normal"><a href="#__codelineno-0-870">870</a></span>
<span class="normal"><a href="#__codelineno-0-871">871</a></span>
<span class="normal"><a href="#__codelineno-0-872">872</a></span>
<span class="normal"><a href="#__codelineno-0-873">873</a></span>
<span class="normal"><a href="#__codelineno-0-874">874</a></span>
<span class="normal"><a href="#__codelineno-0-875">875</a></span>
<span class="normal"><a href="#__codelineno-0-876">876</a></span>
<span class="normal"><a href="#__codelineno-0-877">877</a></span>
<span class="normal"><a href="#__codelineno-0-878">878</a></span>
<span class="normal"><a href="#__codelineno-0-879">879</a></span>
<span class="normal"><a href="#__codelineno-0-880">880</a></span>
<span class="normal"><a href="#__codelineno-0-881">881</a></span>
<span class="normal"><a href="#__codelineno-0-882">882</a></span>
<span class="normal"><a href="#__codelineno-0-883">883</a></span>
<span class="normal"><a href="#__codelineno-0-884">884</a></span>
<span class="normal"><a href="#__codelineno-0-885">885</a></span>
<span class="normal"><a href="#__codelineno-0-886">886</a></span>
<span class="normal"><a href="#__codelineno-0-887">887</a></span>
<span class="normal"><a href="#__codelineno-0-888">888</a></span>
<span class="normal"><a href="#__codelineno-0-889">889</a></span>
<span class="normal"><a href="#__codelineno-0-890">890</a></span>
<span class="normal"><a href="#__codelineno-0-891">891</a></span>
<span class="normal"><a href="#__codelineno-0-892">892</a></span>
<span class="normal"><a href="#__codelineno-0-893">893</a></span>
<span class="normal"><a href="#__codelineno-0-894">894</a></span>
<span class="normal"><a href="#__codelineno-0-895">895</a></span>
<span class="normal"><a href="#__codelineno-0-896">896</a></span>
<span class="normal"><a href="#__codelineno-0-897">897</a></span>
<span class="normal"><a href="#__codelineno-0-898">898</a></span>
<span class="normal"><a href="#__codelineno-0-899">899</a></span>
<span class="normal"><a href="#__codelineno-0-900">900</a></span>
<span class="normal"><a href="#__codelineno-0-901">901</a></span>
<span class="normal"><a href="#__codelineno-0-902">902</a></span>
<span class="normal"><a href="#__codelineno-0-903">903</a></span>
<span class="normal"><a href="#__codelineno-0-904">904</a></span>
<span class="normal"><a href="#__codelineno-0-905">905</a></span>
<span class="normal"><a href="#__codelineno-0-906">906</a></span>
<span class="normal"><a href="#__codelineno-0-907">907</a></span>
<span class="normal"><a href="#__codelineno-0-908">908</a></span>
<span class="normal"><a href="#__codelineno-0-909">909</a></span>
<span class="normal"><a href="#__codelineno-0-910">910</a></span>
<span class="normal"><a href="#__codelineno-0-911">911</a></span>
<span class="normal"><a href="#__codelineno-0-912">912</a></span>
<span class="normal"><a href="#__codelineno-0-913">913</a></span>
<span class="normal"><a href="#__codelineno-0-914">914</a></span>
<span class="normal"><a href="#__codelineno-0-915">915</a></span>
<span class="normal"><a href="#__codelineno-0-916">916</a></span>
<span class="normal"><a href="#__codelineno-0-917">917</a></span>
<span class="normal"><a href="#__codelineno-0-918">918</a></span>
<span class="normal"><a href="#__codelineno-0-919">919</a></span>
<span class="normal"><a href="#__codelineno-0-920">920</a></span>
<span class="normal"><a href="#__codelineno-0-921">921</a></span>
<span class="normal"><a href="#__codelineno-0-922">922</a></span>
<span class="normal"><a href="#__codelineno-0-923">923</a></span>
<span class="normal"><a href="#__codelineno-0-924">924</a></span>
<span class="normal"><a href="#__codelineno-0-925">925</a></span>
<span class="normal"><a href="#__codelineno-0-926">926</a></span>
<span class="normal"><a href="#__codelineno-0-927">927</a></span>
<span class="normal"><a href="#__codelineno-0-928">928</a></span>
<span class="normal"><a href="#__codelineno-0-929">929</a></span>
<span class="normal"><a href="#__codelineno-0-930">930</a></span>
<span class="normal"><a href="#__codelineno-0-931">931</a></span>
<span class="normal"><a href="#__codelineno-0-932">932</a></span>
<span class="normal"><a href="#__codelineno-0-933">933</a></span>
<span class="normal"><a href="#__codelineno-0-934">934</a></span>
<span class="normal"><a href="#__codelineno-0-935">935</a></span>
<span class="normal"><a href="#__codelineno-0-936">936</a></span>
<span class="normal"><a href="#__codelineno-0-937">937</a></span>
<span class="normal"><a href="#__codelineno-0-938">938</a></span>
<span class="normal"><a href="#__codelineno-0-939">939</a></span>
<span class="normal"><a href="#__codelineno-0-940">940</a></span>
<span class="normal"><a href="#__codelineno-0-941">941</a></span>
<span class="normal"><a href="#__codelineno-0-942">942</a></span>
<span class="normal"><a href="#__codelineno-0-943">943</a></span>
<span class="normal"><a href="#__codelineno-0-944">944</a></span>
<span class="normal"><a href="#__codelineno-0-945">945</a></span>
<span class="normal"><a href="#__codelineno-0-946">946</a></span>
<span class="normal"><a href="#__codelineno-0-947">947</a></span>
<span class="normal"><a href="#__codelineno-0-948">948</a></span>
<span class="normal"><a href="#__codelineno-0-949">949</a></span>
<span class="normal"><a href="#__codelineno-0-950">950</a></span>
<span class="normal"><a href="#__codelineno-0-951">951</a></span>
<span class="normal"><a href="#__codelineno-0-952">952</a></span>
<span class="normal"><a href="#__codelineno-0-953">953</a></span>
<span class="normal"><a href="#__codelineno-0-954">954</a></span>
<span class="normal"><a href="#__codelineno-0-955">955</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-858" name="__codelineno-0-858"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Collection&quot;</span><span class="p">)</span>
<a id="__codelineno-0-859" name="__codelineno-0-859"></a><span class="k">def</span><span class="w"> </span><span class="nf">collect_history</span><span class="p">(</span>
<a id="__codelineno-0-860" name="__codelineno-0-860"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-861" name="__codelineno-0-861"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-862" name="__codelineno-0-862"></a> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span>
<a id="__codelineno-0-863" name="__codelineno-0-863"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-864" name="__codelineno-0-864"></a> <span class="s2">&quot;--symbol&quot;</span><span class="p">,</span>
<a id="__codelineno-0-865" name="__codelineno-0-865"></a> <span class="s2">&quot;-s&quot;</span><span class="p">,</span>
<a id="__codelineno-0-866" name="__codelineno-0-866"></a> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Symbol to collect (repeat for multiple symbols).&quot;</span><span class="p">,</span>
<a id="__codelineno-0-867" name="__codelineno-0-867"></a> <span class="p">),</span>
<a id="__codelineno-0-868" name="__codelineno-0-868"></a> <span class="p">],</span>
<a id="__codelineno-0-869" name="__codelineno-0-869"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-870" name="__codelineno-0-870"></a> <span class="n">datetime</span><span class="p">,</span>
<a id="__codelineno-0-871" name="__codelineno-0-871"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Start date.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-872" name="__codelineno-0-872"></a> <span class="p">],</span>
<a id="__codelineno-0-873" name="__codelineno-0-873"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-874" name="__codelineno-0-874"></a> <span class="n">datetime</span><span class="p">,</span>
<a id="__codelineno-0-875" name="__codelineno-0-875"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;End date.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-876" name="__codelineno-0-876"></a> <span class="p">],</span>
<a id="__codelineno-0-877" name="__codelineno-0-877"></a> <span class="n">dataset</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-878" name="__codelineno-0-878"></a> <span class="nb">list</span><span class="p">[</span><span class="n">Dataset</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-879" name="__codelineno-0-879"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-880" name="__codelineno-0-880"></a> <span class="s2">&quot;--dataset&quot;</span><span class="p">,</span>
<a id="__codelineno-0-881" name="__codelineno-0-881"></a> <span class="n">help</span><span class="o">=</span><span class="p">(</span>
<a id="__codelineno-0-882" name="__codelineno-0-882"></a> <span class="s2">&quot;Dataset to include (repeat for multiple).&quot;</span>
<a id="__codelineno-0-883" name="__codelineno-0-883"></a> <span class="s2">&quot; Defaults to rates, history-orders, history-deals.&quot;</span>
<a id="__codelineno-0-884" name="__codelineno-0-884"></a> <span class="s2">&quot; Ticks are opt-in: pass --dataset ticks to include them.&quot;</span>
<a id="__codelineno-0-885" name="__codelineno-0-885"></a> <span class="p">),</span>
<a id="__codelineno-0-886" name="__codelineno-0-886"></a> <span class="p">),</span>
<a id="__codelineno-0-887" name="__codelineno-0-887"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-888" name="__codelineno-0-888"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-889" name="__codelineno-0-889"></a> <span class="nb">int</span><span class="p">,</span>
<a id="__codelineno-0-890" name="__codelineno-0-890"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-891" name="__codelineno-0-891"></a> <span class="n">click_type</span><span class="o">=</span><span class="n">TIMEFRAME_TYPE</span><span class="p">,</span>
<a id="__codelineno-0-892" name="__codelineno-0-892"></a> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Rates timeframe (e.g., M1, H1, D1).&quot;</span><span class="p">,</span>
<a id="__codelineno-0-893" name="__codelineno-0-893"></a> <span class="p">),</span>
<a id="__codelineno-0-894" name="__codelineno-0-894"></a> <span class="p">]</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
<a id="__codelineno-0-895" name="__codelineno-0-895"></a> <span class="n">flags</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-896" name="__codelineno-0-896"></a> <span class="nb">int</span><span class="p">,</span>
<a id="__codelineno-0-897" name="__codelineno-0-897"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-898" name="__codelineno-0-898"></a> <span class="n">click_type</span><span class="o">=</span><span class="n">TICK_FLAGS_TYPE</span><span class="p">,</span>
<a id="__codelineno-0-899" name="__codelineno-0-899"></a> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Tick copy flags (ALL, INFO, TRADE, or integer).&quot;</span><span class="p">,</span>
<a id="__codelineno-0-900" name="__codelineno-0-900"></a> <span class="p">),</span>
<a id="__codelineno-0-901" name="__codelineno-0-901"></a> <span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;ALL&quot;</span><span class="p">,</span> <span class="c1"># pyright: ignore[reportArgumentType]</span>
<a id="__codelineno-0-902" name="__codelineno-0-902"></a> <span class="n">if_exists</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-903" name="__codelineno-0-903"></a> <span class="n">IfExists</span><span class="p">,</span>
<a id="__codelineno-0-904" name="__codelineno-0-904"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-905" name="__codelineno-0-905"></a> <span class="s2">&quot;--if-exists&quot;</span><span class="p">,</span>
<a id="__codelineno-0-906" name="__codelineno-0-906"></a> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Behavior when a target table already exists.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-907" name="__codelineno-0-907"></a> <span class="p">),</span>
<a id="__codelineno-0-908" name="__codelineno-0-908"></a> <span class="p">]</span> <span class="o">=</span> <span class="n">IfExists</span><span class="o">.</span><span class="n">FAIL</span><span class="p">,</span>
<a id="__codelineno-0-909" name="__codelineno-0-909"></a> <span class="n">with_views</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-910" name="__codelineno-0-910"></a> <span class="nb">bool</span><span class="p">,</span>
<a id="__codelineno-0-911" name="__codelineno-0-911"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-912" name="__codelineno-0-912"></a> <span class="s2">&quot;--with-views&quot;</span><span class="p">,</span>
<a id="__codelineno-0-913" name="__codelineno-0-913"></a> <span class="n">help</span><span class="o">=</span><span class="p">(</span>
<a id="__codelineno-0-914" name="__codelineno-0-914"></a> <span class="s2">&quot;Add cash_events and positions_reconstructed SQLite views&quot;</span>
<a id="__codelineno-0-915" name="__codelineno-0-915"></a> <span class="s2">&quot; derived from history_deals.&quot;</span>
<a id="__codelineno-0-916" name="__codelineno-0-916"></a> <span class="p">),</span>
<a id="__codelineno-0-917" name="__codelineno-0-917"></a> <span class="p">),</span>
<a id="__codelineno-0-918" name="__codelineno-0-918"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
<a id="__codelineno-0-919" name="__codelineno-0-919"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-920" name="__codelineno-0-920"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Collect historical datasets into a single SQLite database.</span>
<a id="__codelineno-0-921" name="__codelineno-0-921"></a>
<a id="__codelineno-0-922" name="__codelineno-0-922"></a><span class="sd"> Tables written depend on ``--dataset``: ``rates``, ``history_orders``,</span>
<a id="__codelineno-0-923" name="__codelineno-0-923"></a><span class="sd"> ``history_deals`` by default. ``ticks`` are opt-in: pass</span>
<a id="__codelineno-0-924" name="__codelineno-0-924"></a><span class="sd"> ``--dataset ticks`` to include them (tick data grows the database quickly).</span>
<a id="__codelineno-0-925" name="__codelineno-0-925"></a><span class="sd"> History datasets are fetched per symbol and concatenated. Rates rows carry</span>
<a id="__codelineno-0-926" name="__codelineno-0-926"></a><span class="sd"> the requested ``timeframe`` so appended runs at different timeframes remain</span>
<a id="__codelineno-0-927" name="__codelineno-0-927"></a><span class="sd"> distinguishable.</span>
<a id="__codelineno-0-928" name="__codelineno-0-928"></a>
<a id="__codelineno-0-929" name="__codelineno-0-929"></a><span class="sd"> With ``--with-views`` (requires the ``history-deals`` dataset), optional</span>
<a id="__codelineno-0-930" name="__codelineno-0-930"></a><span class="sd"> views ``cash_events`` and ``positions_reconstructed`` are derived from</span>
<a id="__codelineno-0-931" name="__codelineno-0-931"></a><span class="sd"> ``history_deals`` when the required columns are present.</span>
<a id="__codelineno-0-932" name="__codelineno-0-932"></a>
<a id="__codelineno-0-933" name="__codelineno-0-933"></a><span class="sd"> Raises:</span>
<a id="__codelineno-0-934" name="__codelineno-0-934"></a><span class="sd"> typer.BadParameter: If the output format is not SQLite3.</span>
<a id="__codelineno-0-935" name="__codelineno-0-935"></a><span class="sd"> &quot;&quot;&quot;</span>
<a id="__codelineno-0-936" name="__codelineno-0-936"></a> <span class="n">export_ctx</span> <span class="o">=</span> <span class="n">_get_export_context</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
<a id="__codelineno-0-937" name="__codelineno-0-937"></a> <span class="k">if</span> <span class="n">export_ctx</span><span class="o">.</span><span class="n">output_format</span> <span class="o">!=</span> <span class="s2">&quot;sqlite3&quot;</span><span class="p">:</span>
<a id="__codelineno-0-938" name="__codelineno-0-938"></a> <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
<a id="__codelineno-0-939" name="__codelineno-0-939"></a> <span class="s2">&quot;collect-history requires SQLite3 output.&quot;</span>
<a id="__codelineno-0-940" name="__codelineno-0-940"></a> <span class="s2">&quot; Use a .db/.sqlite/.sqlite3 extension or --format sqlite3.&quot;</span>
<a id="__codelineno-0-941" name="__codelineno-0-941"></a> <span class="p">)</span>
<a id="__codelineno-0-942" name="__codelineno-0-942"></a> <span class="k">raise</span> <span class="n">typer</span><span class="o">.</span><span class="n">BadParameter</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<a id="__codelineno-0-943" name="__codelineno-0-943"></a> <span class="n">datasets</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">dataset</span><span class="p">)</span> <span class="k">if</span> <span class="n">dataset</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="kc">None</span>
<a id="__codelineno-0-944" name="__codelineno-0-944"></a> <span class="n">sdk</span><span class="o">.</span><span class="n">collect_history</span><span class="p">(</span>
<a id="__codelineno-0-945" name="__codelineno-0-945"></a> <span class="n">output</span><span class="o">=</span><span class="n">export_ctx</span><span class="o">.</span><span class="n">output</span><span class="p">,</span>
<a id="__codelineno-0-946" name="__codelineno-0-946"></a> <span class="n">symbols</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
<a id="__codelineno-0-947" name="__codelineno-0-947"></a> <span class="n">date_from</span><span class="o">=</span><span class="n">date_from</span><span class="p">,</span>
<a id="__codelineno-0-948" name="__codelineno-0-948"></a> <span class="n">date_to</span><span class="o">=</span><span class="n">date_to</span><span class="p">,</span>
<a id="__codelineno-0-949" name="__codelineno-0-949"></a> <span class="n">datasets</span><span class="o">=</span><span class="n">datasets</span><span class="p">,</span>
<a id="__codelineno-0-950" name="__codelineno-0-950"></a> <span class="n">timeframe</span><span class="o">=</span><span class="n">timeframe</span><span class="p">,</span>
<a id="__codelineno-0-951" name="__codelineno-0-951"></a> <span class="n">flags</span><span class="o">=</span><span class="n">flags</span><span class="p">,</span>
<a id="__codelineno-0-952" name="__codelineno-0-952"></a> <span class="n">if_exists</span><span class="o">=</span><span class="n">if_exists</span><span class="p">,</span>
<a id="__codelineno-0-953" name="__codelineno-0-953"></a> <span class="n">with_views</span><span class="o">=</span><span class="n">with_views</span><span class="p">,</span>
<a id="__codelineno-0-954" name="__codelineno-0-954"></a> <span class="n">config</span><span class="o">=</span><span class="n">export_ctx</span><span class="o">.</span><span class="n">config</span><span class="p">,</span>
<a id="__codelineno-0-955" name="__codelineno-0-955"></a> <span class="p">)</span>
2026-06-08 13:55:22 +00:00
</code></pre></div></td></tr></table></div>
</details>
2026-04-22 17:11:38 +00:00
</div>
</div>
2026-06-08 13:55:22 +00:00
<div class="doc doc-object doc-function">
2026-06-27 22:56:08 +00:00
<h3 id="mt5cli.cli.grafana_schema" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">grafana_schema</span>
<a href="#mt5cli.cli.grafana_schema" class="headerlink" title="Permanent link">&para;</a></h3>
2026-06-28 08:14:55 +00:00
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">grafana_schema</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">publish_copy</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n"><span title="pathlib.Path">Path</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="s2">&quot;--publish-copy&quot;</span><span class="p">,</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Publish a Grafana-ready SQLite copy to this path after schema creation.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">),</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
2026-06-27 22:56:08 +00:00
</code></pre></div>
<div class="doc doc-contents ">
<p>Create or refresh Grafana-ready views and indexes in a SQLite database.</p>
<p>Idempotent — safe to run repeatedly on the same database. Requires SQLite
output. Does not connect to MetaTrader 5.</p>
<p><span class="doc-section-title">Raises:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code><span title="typer.BadParameter">BadParameter</span></code>
</td>
<td>
<div class="doc-md-description">
<p>If the output format is not SQLite3.</p>
</div>
</td>
</tr>
</tbody>
</table>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-958"> 958</a></span>
<span class="normal"><a href="#__codelineno-0-959"> 959</a></span>
<span class="normal"><a href="#__codelineno-0-960"> 960</a></span>
<span class="normal"><a href="#__codelineno-0-961"> 961</a></span>
<span class="normal"><a href="#__codelineno-0-962"> 962</a></span>
<span class="normal"><a href="#__codelineno-0-963"> 963</a></span>
<span class="normal"><a href="#__codelineno-0-964"> 964</a></span>
<span class="normal"><a href="#__codelineno-0-965"> 965</a></span>
<span class="normal"><a href="#__codelineno-0-966"> 966</a></span>
<span class="normal"><a href="#__codelineno-0-967"> 967</a></span>
<span class="normal"><a href="#__codelineno-0-968"> 968</a></span>
<span class="normal"><a href="#__codelineno-0-969"> 969</a></span>
<span class="normal"><a href="#__codelineno-0-970"> 970</a></span>
<span class="normal"><a href="#__codelineno-0-971"> 971</a></span>
<span class="normal"><a href="#__codelineno-0-972"> 972</a></span>
<span class="normal"><a href="#__codelineno-0-973"> 973</a></span>
<span class="normal"><a href="#__codelineno-0-974"> 974</a></span>
<span class="normal"><a href="#__codelineno-0-975"> 975</a></span>
<span class="normal"><a href="#__codelineno-0-976"> 976</a></span>
<span class="normal"><a href="#__codelineno-0-977"> 977</a></span>
<span class="normal"><a href="#__codelineno-0-978"> 978</a></span>
<span class="normal"><a href="#__codelineno-0-979"> 979</a></span>
<span class="normal"><a href="#__codelineno-0-980"> 980</a></span>
<span class="normal"><a href="#__codelineno-0-981"> 981</a></span>
<span class="normal"><a href="#__codelineno-0-982"> 982</a></span>
<span class="normal"><a href="#__codelineno-0-983"> 983</a></span>
<span class="normal"><a href="#__codelineno-0-984"> 984</a></span>
<span class="normal"><a href="#__codelineno-0-985"> 985</a></span>
<span class="normal"><a href="#__codelineno-0-986"> 986</a></span>
<span class="normal"><a href="#__codelineno-0-987"> 987</a></span>
<span class="normal"><a href="#__codelineno-0-988"> 988</a></span>
<span class="normal"><a href="#__codelineno-0-989"> 989</a></span>
<span class="normal"><a href="#__codelineno-0-990"> 990</a></span>
<span class="normal"><a href="#__codelineno-0-991"> 991</a></span>
<span class="normal"><a href="#__codelineno-0-992"> 992</a></span>
<span class="normal"><a href="#__codelineno-0-993"> 993</a></span>
<span class="normal"><a href="#__codelineno-0-994"> 994</a></span>
<span class="normal"><a href="#__codelineno-0-995"> 995</a></span>
<span class="normal"><a href="#__codelineno-0-996"> 996</a></span>
<span class="normal"><a href="#__codelineno-0-997"> 997</a></span>
<span class="normal"><a href="#__codelineno-0-998"> 998</a></span>
<span class="normal"><a href="#__codelineno-0-999"> 999</a></span>
<span class="normal"><a href="#__codelineno-0-1000">1000</a></span>
<span class="normal"><a href="#__codelineno-0-1001">1001</a></span>
<span class="normal"><a href="#__codelineno-0-1002">1002</a></span>
<span class="normal"><a href="#__codelineno-0-1003">1003</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-958" name="__codelineno-0-958"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Collection&quot;</span><span class="p">)</span>
<a id="__codelineno-0-959" name="__codelineno-0-959"></a><span class="k">def</span><span class="w"> </span><span class="nf">grafana_schema</span><span class="p">(</span>
<a id="__codelineno-0-960" name="__codelineno-0-960"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-961" name="__codelineno-0-961"></a> <span class="n">publish_copy</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-962" name="__codelineno-0-962"></a> <span class="n">Path</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-963" name="__codelineno-0-963"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-964" name="__codelineno-0-964"></a> <span class="s2">&quot;--publish-copy&quot;</span><span class="p">,</span>
<a id="__codelineno-0-965" name="__codelineno-0-965"></a> <span class="n">help</span><span class="o">=</span><span class="p">(</span>
<a id="__codelineno-0-966" name="__codelineno-0-966"></a> <span class="s2">&quot;Publish a Grafana-ready SQLite copy to this path&quot;</span>
<a id="__codelineno-0-967" name="__codelineno-0-967"></a> <span class="s2">&quot; after schema creation.&quot;</span>
<a id="__codelineno-0-968" name="__codelineno-0-968"></a> <span class="p">),</span>
<a id="__codelineno-0-969" name="__codelineno-0-969"></a> <span class="p">),</span>
<a id="__codelineno-0-970" name="__codelineno-0-970"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-971" name="__codelineno-0-971"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-972" name="__codelineno-0-972"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Create or refresh Grafana-ready views and indexes in a SQLite database.</span>
<a id="__codelineno-0-973" name="__codelineno-0-973"></a>
<a id="__codelineno-0-974" name="__codelineno-0-974"></a><span class="sd"> Idempotent — safe to run repeatedly on the same database. Requires SQLite</span>
<a id="__codelineno-0-975" name="__codelineno-0-975"></a><span class="sd"> output. Does not connect to MetaTrader 5.</span>
<a id="__codelineno-0-976" name="__codelineno-0-976"></a>
<a id="__codelineno-0-977" name="__codelineno-0-977"></a><span class="sd"> Raises:</span>
<a id="__codelineno-0-978" name="__codelineno-0-978"></a><span class="sd"> typer.BadParameter: If the output format is not SQLite3.</span>
<a id="__codelineno-0-979" name="__codelineno-0-979"></a><span class="sd"> &quot;&quot;&quot;</span>
<a id="__codelineno-0-980" name="__codelineno-0-980"></a> <span class="kn">import</span><span class="w"> </span><span class="nn">sqlite3</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">_sqlite3</span> <span class="c1"># noqa: PLC0415</span>
<a id="__codelineno-0-981" name="__codelineno-0-981"></a>
<a id="__codelineno-0-982" name="__codelineno-0-982"></a> <span class="kn">from</span><span class="w"> </span><span class="nn">.grafana</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span> <span class="c1"># noqa: PLC0415</span>
<a id="__codelineno-0-983" name="__codelineno-0-983"></a> <span class="n">create_snapshot_tables</span><span class="p">,</span>
<a id="__codelineno-0-984" name="__codelineno-0-984"></a> <span class="n">ensure_grafana_schema</span><span class="p">,</span>
<a id="__codelineno-0-985" name="__codelineno-0-985"></a> <span class="n">publish_grafana_copy</span><span class="p">,</span>
<a id="__codelineno-0-986" name="__codelineno-0-986"></a> <span class="p">)</span>
<a id="__codelineno-0-987" name="__codelineno-0-987"></a>
<a id="__codelineno-0-988" name="__codelineno-0-988"></a> <span class="n">export_ctx</span> <span class="o">=</span> <span class="n">_get_export_context</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
<a id="__codelineno-0-989" name="__codelineno-0-989"></a> <span class="k">if</span> <span class="n">export_ctx</span><span class="o">.</span><span class="n">output_format</span> <span class="o">!=</span> <span class="s2">&quot;sqlite3&quot;</span><span class="p">:</span>
<a id="__codelineno-0-990" name="__codelineno-0-990"></a> <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
<a id="__codelineno-0-991" name="__codelineno-0-991"></a> <span class="s2">&quot;grafana-schema requires SQLite3 output.&quot;</span>
<a id="__codelineno-0-992" name="__codelineno-0-992"></a> <span class="s2">&quot; Use a .db/.sqlite/.sqlite3 extension or --format sqlite3.&quot;</span>
<a id="__codelineno-0-993" name="__codelineno-0-993"></a> <span class="p">)</span>
<a id="__codelineno-0-994" name="__codelineno-0-994"></a> <span class="k">raise</span> <span class="n">typer</span><span class="o">.</span><span class="n">BadParameter</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<a id="__codelineno-0-995" name="__codelineno-0-995"></a> <span class="k">with</span> <span class="n">_sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">export_ctx</span><span class="o">.</span><span class="n">output</span><span class="p">)</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
<a id="__codelineno-0-996" name="__codelineno-0-996"></a> <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">&quot;PRAGMA journal_mode=WAL&quot;</span><span class="p">)</span>
<a id="__codelineno-0-997" name="__codelineno-0-997"></a> <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">&quot;PRAGMA synchronous=NORMAL&quot;</span><span class="p">)</span>
<a id="__codelineno-0-998" name="__codelineno-0-998"></a> <span class="n">create_snapshot_tables</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
<a id="__codelineno-0-999" name="__codelineno-0-999"></a> <span class="n">ensure_grafana_schema</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
<a id="__codelineno-0-1000" name="__codelineno-0-1000"></a> <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Grafana schema applied to </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">export_ctx</span><span class="o">.</span><span class="n">output</span><span class="p">)</span>
<a id="__codelineno-0-1001" name="__codelineno-0-1001"></a> <span class="k">if</span> <span class="n">publish_copy</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-1002" name="__codelineno-0-1002"></a> <span class="n">publish_grafana_copy</span><span class="p">(</span><span class="n">export_ctx</span><span class="o">.</span><span class="n">output</span><span class="p">,</span> <span class="n">publish_copy</span><span class="p">)</span>
<a id="__codelineno-0-1003" name="__codelineno-0-1003"></a> <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Grafana copy published to </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">publish_copy</span><span class="p">)</span>
2026-06-27 22:56:08 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
2026-06-08 13:55:22 +00:00
<h3 id="mt5cli.cli.history_deals" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">history_deals</span>
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
<a href="#mt5cli.cli.history_deals" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">history_deals</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
module-attribute
(mt5cli.utils.DATETIME_TYPE)" href="../utils/#mt5cli.utils.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Start date.&quot;</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="p">),</span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
module-attribute
(mt5cli.utils.DATETIME_TYPE)" href="../utils/#mt5cli.utils.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;End date.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="n">group</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Group filter.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Symbol filter.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Order ticket.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a> <span class="n">position</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Position ticket.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-24" name="__codelineno-0-24" href="#__codelineno-0-24"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-25" name="__codelineno-0-25" href="#__codelineno-0-25"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
2026-04-22 17:11:38 +00:00
</code></pre></div>
<div class="doc doc-contents ">
2026-06-08 13:55:22 +00:00
<p>Export historical deals.</p>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-554">554</a></span>
<span class="normal"><a href="#__codelineno-0-555">555</a></span>
<span class="normal"><a href="#__codelineno-0-556">556</a></span>
<span class="normal"><a href="#__codelineno-0-557">557</a></span>
<span class="normal"><a href="#__codelineno-0-558">558</a></span>
<span class="normal"><a href="#__codelineno-0-559">559</a></span>
<span class="normal"><a href="#__codelineno-0-560">560</a></span>
<span class="normal"><a href="#__codelineno-0-561">561</a></span>
<span class="normal"><a href="#__codelineno-0-562">562</a></span>
<span class="normal"><a href="#__codelineno-0-563">563</a></span>
<span class="normal"><a href="#__codelineno-0-564">564</a></span>
<span class="normal"><a href="#__codelineno-0-565">565</a></span>
<span class="normal"><a href="#__codelineno-0-566">566</a></span>
<span class="normal"><a href="#__codelineno-0-567">567</a></span>
<span class="normal"><a href="#__codelineno-0-568">568</a></span>
<span class="normal"><a href="#__codelineno-0-569">569</a></span>
<span class="normal"><a href="#__codelineno-0-570">570</a></span>
<span class="normal"><a href="#__codelineno-0-571">571</a></span>
<span class="normal"><a href="#__codelineno-0-572">572</a></span>
<span class="normal"><a href="#__codelineno-0-573">573</a></span>
<span class="normal"><a href="#__codelineno-0-574">574</a></span>
<span class="normal"><a href="#__codelineno-0-575">575</a></span>
<span class="normal"><a href="#__codelineno-0-576">576</a></span>
<span class="normal"><a href="#__codelineno-0-577">577</a></span>
<span class="normal"><a href="#__codelineno-0-578">578</a></span>
<span class="normal"><a href="#__codelineno-0-579">579</a></span>
<span class="normal"><a href="#__codelineno-0-580">580</a></span>
<span class="normal"><a href="#__codelineno-0-581">581</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-554" name="__codelineno-0-554"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-555" name="__codelineno-0-555"></a><span class="k">def</span><span class="w"> </span><span class="nf">history_deals</span><span class="p">(</span>
<a id="__codelineno-0-556" name="__codelineno-0-556"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-557" name="__codelineno-0-557"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-558" name="__codelineno-0-558"></a> <span class="n">datetime</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-559" name="__codelineno-0-559"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Start date.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-560" name="__codelineno-0-560"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-561" name="__codelineno-0-561"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-562" name="__codelineno-0-562"></a> <span class="n">datetime</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-563" name="__codelineno-0-563"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;End date.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-564" name="__codelineno-0-564"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-565" name="__codelineno-0-565"></a> <span class="n">group</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Group filter.&quot;</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-566" name="__codelineno-0-566"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Symbol filter.&quot;</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-567" name="__codelineno-0-567"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Order ticket.&quot;</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-568" name="__codelineno-0-568"></a> <span class="n">position</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Position ticket.&quot;</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-569" name="__codelineno-0-569"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-570" name="__codelineno-0-570"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export historical deals.&quot;&quot;&quot;</span>
<a id="__codelineno-0-571" name="__codelineno-0-571"></a> <span class="n">_export_command</span><span class="p">(</span>
<a id="__codelineno-0-572" name="__codelineno-0-572"></a> <span class="n">ctx</span><span class="p">,</span>
<a id="__codelineno-0-573" name="__codelineno-0-573"></a> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">history_deals</span><span class="p">(</span>
<a id="__codelineno-0-574" name="__codelineno-0-574"></a> <span class="n">date_from</span><span class="o">=</span><span class="n">date_from</span><span class="p">,</span>
<a id="__codelineno-0-575" name="__codelineno-0-575"></a> <span class="n">date_to</span><span class="o">=</span><span class="n">date_to</span><span class="p">,</span>
<a id="__codelineno-0-576" name="__codelineno-0-576"></a> <span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span>
<a id="__codelineno-0-577" name="__codelineno-0-577"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
<a id="__codelineno-0-578" name="__codelineno-0-578"></a> <span class="n">ticket</span><span class="o">=</span><span class="n">ticket</span><span class="p">,</span>
<a id="__codelineno-0-579" name="__codelineno-0-579"></a> <span class="n">position</span><span class="o">=</span><span class="n">position</span><span class="p">,</span>
<a id="__codelineno-0-580" name="__codelineno-0-580"></a> <span class="p">),</span>
<a id="__codelineno-0-581" name="__codelineno-0-581"></a> <span class="p">)</span>
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="mt5cli.cli.history_gaps" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">history_gaps</span>
<a href="#mt5cli.cli.history_gaps" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">history_gaps</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">sqlite3_path</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n"><span title="pathlib.Path">Path</span></span><span class="p">,</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="s2">&quot;--sqlite3&quot;</span><span class="p">,</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Source SQLite history database to analyze.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">),</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="p">],</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n">table</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n"><span title="list">list</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="s2">&quot;--table&quot;</span><span class="p">,</span>
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Rate table or compatibility view to inspect (repeat for multiple).&quot;</span><span class="p">,</span>
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="p">),</span>
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> <span class="n">granularity_seconds</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Explicit bar interval in seconds for custom tables/views.&quot;</span>
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a> <span class="p">),</span>
<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a> <span class="n">min_gap_intervals</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-24" name="__codelineno-0-24" href="#__codelineno-0-24"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span>
<a id="__codelineno-0-25" name="__codelineno-0-25" href="#__codelineno-0-25"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-26" name="__codelineno-0-26" href="#__codelineno-0-26"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Minimum missing-bar count required to emit a gap row.&quot;</span>
<a id="__codelineno-0-27" name="__codelineno-0-27" href="#__codelineno-0-27"></a> <span class="p">),</span>
<a id="__codelineno-0-28" name="__codelineno-0-28" href="#__codelineno-0-28"></a> <span class="p">]</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
<a id="__codelineno-0-29" name="__codelineno-0-29" href="#__codelineno-0-29"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Export SQLite rate gaps without connecting to MT5.</p>
<p><span class="doc-section-title">Raises:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code><span title="typer.BadParameter">BadParameter</span></code>
</td>
<td>
<div class="doc-md-description">
<p>If no compatible rate view is available and no
explicit table is provided, or if granularity inference fails.</p>
</div>
</td>
</tr>
</tbody>
</table>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-791">791</a></span>
<span class="normal"><a href="#__codelineno-0-792">792</a></span>
<span class="normal"><a href="#__codelineno-0-793">793</a></span>
<span class="normal"><a href="#__codelineno-0-794">794</a></span>
<span class="normal"><a href="#__codelineno-0-795">795</a></span>
<span class="normal"><a href="#__codelineno-0-796">796</a></span>
<span class="normal"><a href="#__codelineno-0-797">797</a></span>
<span class="normal"><a href="#__codelineno-0-798">798</a></span>
<span class="normal"><a href="#__codelineno-0-799">799</a></span>
<span class="normal"><a href="#__codelineno-0-800">800</a></span>
<span class="normal"><a href="#__codelineno-0-801">801</a></span>
<span class="normal"><a href="#__codelineno-0-802">802</a></span>
<span class="normal"><a href="#__codelineno-0-803">803</a></span>
<span class="normal"><a href="#__codelineno-0-804">804</a></span>
<span class="normal"><a href="#__codelineno-0-805">805</a></span>
<span class="normal"><a href="#__codelineno-0-806">806</a></span>
<span class="normal"><a href="#__codelineno-0-807">807</a></span>
<span class="normal"><a href="#__codelineno-0-808">808</a></span>
<span class="normal"><a href="#__codelineno-0-809">809</a></span>
<span class="normal"><a href="#__codelineno-0-810">810</a></span>
<span class="normal"><a href="#__codelineno-0-811">811</a></span>
<span class="normal"><a href="#__codelineno-0-812">812</a></span>
<span class="normal"><a href="#__codelineno-0-813">813</a></span>
<span class="normal"><a href="#__codelineno-0-814">814</a></span>
<span class="normal"><a href="#__codelineno-0-815">815</a></span>
<span class="normal"><a href="#__codelineno-0-816">816</a></span>
<span class="normal"><a href="#__codelineno-0-817">817</a></span>
<span class="normal"><a href="#__codelineno-0-818">818</a></span>
<span class="normal"><a href="#__codelineno-0-819">819</a></span>
<span class="normal"><a href="#__codelineno-0-820">820</a></span>
<span class="normal"><a href="#__codelineno-0-821">821</a></span>
<span class="normal"><a href="#__codelineno-0-822">822</a></span>
<span class="normal"><a href="#__codelineno-0-823">823</a></span>
<span class="normal"><a href="#__codelineno-0-824">824</a></span>
<span class="normal"><a href="#__codelineno-0-825">825</a></span>
<span class="normal"><a href="#__codelineno-0-826">826</a></span>
<span class="normal"><a href="#__codelineno-0-827">827</a></span>
<span class="normal"><a href="#__codelineno-0-828">828</a></span>
<span class="normal"><a href="#__codelineno-0-829">829</a></span>
<span class="normal"><a href="#__codelineno-0-830">830</a></span>
<span class="normal"><a href="#__codelineno-0-831">831</a></span>
<span class="normal"><a href="#__codelineno-0-832">832</a></span>
<span class="normal"><a href="#__codelineno-0-833">833</a></span>
<span class="normal"><a href="#__codelineno-0-834">834</a></span>
<span class="normal"><a href="#__codelineno-0-835">835</a></span>
<span class="normal"><a href="#__codelineno-0-836">836</a></span>
<span class="normal"><a href="#__codelineno-0-837">837</a></span>
<span class="normal"><a href="#__codelineno-0-838">838</a></span>
<span class="normal"><a href="#__codelineno-0-839">839</a></span>
<span class="normal"><a href="#__codelineno-0-840">840</a></span>
<span class="normal"><a href="#__codelineno-0-841">841</a></span>
<span class="normal"><a href="#__codelineno-0-842">842</a></span>
<span class="normal"><a href="#__codelineno-0-843">843</a></span>
<span class="normal"><a href="#__codelineno-0-844">844</a></span>
<span class="normal"><a href="#__codelineno-0-845">845</a></span>
<span class="normal"><a href="#__codelineno-0-846">846</a></span>
<span class="normal"><a href="#__codelineno-0-847">847</a></span>
<span class="normal"><a href="#__codelineno-0-848">848</a></span>
<span class="normal"><a href="#__codelineno-0-849">849</a></span>
<span class="normal"><a href="#__codelineno-0-850">850</a></span>
<span class="normal"><a href="#__codelineno-0-851">851</a></span>
<span class="normal"><a href="#__codelineno-0-852">852</a></span>
<span class="normal"><a href="#__codelineno-0-853">853</a></span>
<span class="normal"><a href="#__codelineno-0-854">854</a></span>
<span class="normal"><a href="#__codelineno-0-855">855</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-791" name="__codelineno-0-791"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="s2">&quot;history-gaps&quot;</span><span class="p">,</span> <span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Collection&quot;</span><span class="p">)</span>
<a id="__codelineno-0-792" name="__codelineno-0-792"></a><span class="k">def</span><span class="w"> </span><span class="nf">history_gaps</span><span class="p">(</span>
<a id="__codelineno-0-793" name="__codelineno-0-793"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-794" name="__codelineno-0-794"></a> <span class="n">sqlite3_path</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-795" name="__codelineno-0-795"></a> <span class="n">Path</span><span class="p">,</span>
<a id="__codelineno-0-796" name="__codelineno-0-796"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-797" name="__codelineno-0-797"></a> <span class="s2">&quot;--sqlite3&quot;</span><span class="p">,</span>
<a id="__codelineno-0-798" name="__codelineno-0-798"></a> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Source SQLite history database to analyze.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-799" name="__codelineno-0-799"></a> <span class="p">),</span>
<a id="__codelineno-0-800" name="__codelineno-0-800"></a> <span class="p">],</span>
<a id="__codelineno-0-801" name="__codelineno-0-801"></a> <span class="n">table</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-802" name="__codelineno-0-802"></a> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-803" name="__codelineno-0-803"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-804" name="__codelineno-0-804"></a> <span class="s2">&quot;--table&quot;</span><span class="p">,</span>
<a id="__codelineno-0-805" name="__codelineno-0-805"></a> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Rate table or compatibility view to inspect (repeat for multiple).&quot;</span><span class="p">,</span>
<a id="__codelineno-0-806" name="__codelineno-0-806"></a> <span class="p">),</span>
<a id="__codelineno-0-807" name="__codelineno-0-807"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-808" name="__codelineno-0-808"></a> <span class="n">granularity_seconds</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-809" name="__codelineno-0-809"></a> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-810" name="__codelineno-0-810"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Explicit bar interval in seconds for custom tables/views.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-811" name="__codelineno-0-811"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-812" name="__codelineno-0-812"></a> <span class="n">min_gap_intervals</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-813" name="__codelineno-0-813"></a> <span class="nb">int</span><span class="p">,</span>
<a id="__codelineno-0-814" name="__codelineno-0-814"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Minimum missing-bar count required to emit a gap row.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-815" name="__codelineno-0-815"></a> <span class="p">]</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
<a id="__codelineno-0-816" name="__codelineno-0-816"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-817" name="__codelineno-0-817"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export SQLite rate gaps without connecting to MT5.</span>
<a id="__codelineno-0-818" name="__codelineno-0-818"></a>
<a id="__codelineno-0-819" name="__codelineno-0-819"></a><span class="sd"> Raises:</span>
<a id="__codelineno-0-820" name="__codelineno-0-820"></a><span class="sd"> typer.BadParameter: If no compatible rate view is available and no</span>
<a id="__codelineno-0-821" name="__codelineno-0-821"></a><span class="sd"> explicit table is provided, or if granularity inference fails.</span>
<a id="__codelineno-0-822" name="__codelineno-0-822"></a><span class="sd"> &quot;&quot;&quot;</span>
<a id="__codelineno-0-823" name="__codelineno-0-823"></a> <span class="k">with</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">sqlite3_path</span><span class="p">)</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
<a id="__codelineno-0-824" name="__codelineno-0-824"></a> <span class="n">tables</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">table</span><span class="p">)</span> <span class="k">if</span> <span class="n">table</span> <span class="k">else</span> <span class="n">_default_gap_tables</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
<a id="__codelineno-0-825" name="__codelineno-0-825"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">tables</span><span class="p">:</span>
<a id="__codelineno-0-826" name="__codelineno-0-826"></a> <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
<a id="__codelineno-0-827" name="__codelineno-0-827"></a> <span class="s2">&quot;No managed rate compatibility views found; pass --table for a rate &quot;</span>
<a id="__codelineno-0-828" name="__codelineno-0-828"></a> <span class="s2">&quot;table or view.&quot;</span>
<a id="__codelineno-0-829" name="__codelineno-0-829"></a> <span class="p">)</span>
<a id="__codelineno-0-830" name="__codelineno-0-830"></a> <span class="k">raise</span> <span class="n">typer</span><span class="o">.</span><span class="n">BadParameter</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">param_hint</span><span class="o">=</span><span class="s2">&quot;--table&quot;</span><span class="p">)</span>
<a id="__codelineno-0-831" name="__codelineno-0-831"></a> <span class="n">frames</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
<a id="__codelineno-0-832" name="__codelineno-0-832"></a> <span class="k">for</span> <span class="n">table_name</span> <span class="ow">in</span> <span class="n">tables</span><span class="p">:</span>
<a id="__codelineno-0-833" name="__codelineno-0-833"></a> <span class="n">interval_seconds</span> <span class="o">=</span> <span class="p">(</span>
<a id="__codelineno-0-834" name="__codelineno-0-834"></a> <span class="n">granularity_seconds</span> <span class="ow">or</span> <span class="n">_infer_gap_table_granularity_seconds</span><span class="p">(</span><span class="n">table_name</span><span class="p">)</span>
<a id="__codelineno-0-835" name="__codelineno-0-835"></a> <span class="p">)</span>
<a id="__codelineno-0-836" name="__codelineno-0-836"></a> <span class="k">if</span> <span class="n">interval_seconds</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-837" name="__codelineno-0-837"></a> <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
<a id="__codelineno-0-838" name="__codelineno-0-838"></a> <span class="sa">f</span><span class="s2">&quot;Could not infer granularity for </span><span class="si">{</span><span class="n">table_name</span><span class="si">!r}</span><span class="s2">; pass &quot;</span>
<a id="__codelineno-0-839" name="__codelineno-0-839"></a> <span class="s2">&quot;--granularity-seconds.&quot;</span>
<a id="__codelineno-0-840" name="__codelineno-0-840"></a> <span class="p">)</span>
<a id="__codelineno-0-841" name="__codelineno-0-841"></a> <span class="k">raise</span> <span class="n">typer</span><span class="o">.</span><span class="n">BadParameter</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">param_hint</span><span class="o">=</span><span class="s2">&quot;--granularity-seconds&quot;</span><span class="p">)</span>
<a id="__codelineno-0-842" name="__codelineno-0-842"></a> <span class="n">frames</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
<a id="__codelineno-0-843" name="__codelineno-0-843"></a> <span class="n">report_rate_gaps</span><span class="p">(</span>
<a id="__codelineno-0-844" name="__codelineno-0-844"></a> <span class="n">conn</span><span class="p">,</span>
<a id="__codelineno-0-845" name="__codelineno-0-845"></a> <span class="n">table_name</span><span class="p">,</span>
<a id="__codelineno-0-846" name="__codelineno-0-846"></a> <span class="n">granularity_seconds</span><span class="o">=</span><span class="n">interval_seconds</span><span class="p">,</span>
<a id="__codelineno-0-847" name="__codelineno-0-847"></a> <span class="n">min_gap_intervals</span><span class="o">=</span><span class="n">min_gap_intervals</span><span class="p">,</span>
<a id="__codelineno-0-848" name="__codelineno-0-848"></a> <span class="p">)</span>
<a id="__codelineno-0-849" name="__codelineno-0-849"></a> <span class="p">)</span>
<a id="__codelineno-0-850" name="__codelineno-0-850"></a> <span class="n">df</span> <span class="o">=</span> <span class="p">(</span>
<a id="__codelineno-0-851" name="__codelineno-0-851"></a> <span class="n">pd</span><span class="o">.</span><span class="n">concat</span><span class="p">(</span><span class="n">frames</span><span class="p">,</span> <span class="n">ignore_index</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<a id="__codelineno-0-852" name="__codelineno-0-852"></a> <span class="k">if</span> <span class="n">frames</span>
<a id="__codelineno-0-853" name="__codelineno-0-853"></a> <span class="k">else</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">columns</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;table&quot;</span><span class="p">])</span>
<a id="__codelineno-0-854" name="__codelineno-0-854"></a> <span class="p">)</span>
<a id="__codelineno-0-855" name="__codelineno-0-855"></a> <span class="n">_execute_export</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="k">lambda</span><span class="p">:</span> <span class="n">df</span><span class="p">)</span>
2026-06-08 13:55:22 +00:00
</code></pre></div></td></tr></table></div>
</details>
2026-04-22 17:11:38 +00:00
</div>
</div>
2026-06-08 13:55:22 +00:00
<div class="doc doc-object doc-function">
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
<h3 id="mt5cli.cli.history_orders" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">history_orders</span>
2026-04-22 17:11:38 +00:00
<a href="#mt5cli.cli.history_orders" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">history_orders</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
module-attribute
2026-06-08 13:55:22 +00:00
(mt5cli.utils.DATETIME_TYPE)" href="../utils/#mt5cli.utils.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Start date.&quot;</span>
2026-04-22 17:11:38 +00:00
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="p">),</span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
module-attribute
2026-06-08 13:55:22 +00:00
(mt5cli.utils.DATETIME_TYPE)" href="../utils/#mt5cli.utils.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;End date.&quot;</span><span class="p">),</span>
2026-04-22 17:11:38 +00:00
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="n">group</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Group filter.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Symbol filter.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Order ticket.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a> <span class="n">position</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Position ticket.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-24" name="__codelineno-0-24" href="#__codelineno-0-24"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-25" name="__codelineno-0-25" href="#__codelineno-0-25"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Export historical orders.</p>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-524">524</a></span>
<span class="normal"><a href="#__codelineno-0-525">525</a></span>
<span class="normal"><a href="#__codelineno-0-526">526</a></span>
<span class="normal"><a href="#__codelineno-0-527">527</a></span>
<span class="normal"><a href="#__codelineno-0-528">528</a></span>
<span class="normal"><a href="#__codelineno-0-529">529</a></span>
<span class="normal"><a href="#__codelineno-0-530">530</a></span>
<span class="normal"><a href="#__codelineno-0-531">531</a></span>
<span class="normal"><a href="#__codelineno-0-532">532</a></span>
<span class="normal"><a href="#__codelineno-0-533">533</a></span>
<span class="normal"><a href="#__codelineno-0-534">534</a></span>
<span class="normal"><a href="#__codelineno-0-535">535</a></span>
<span class="normal"><a href="#__codelineno-0-536">536</a></span>
<span class="normal"><a href="#__codelineno-0-537">537</a></span>
<span class="normal"><a href="#__codelineno-0-538">538</a></span>
<span class="normal"><a href="#__codelineno-0-539">539</a></span>
<span class="normal"><a href="#__codelineno-0-540">540</a></span>
<span class="normal"><a href="#__codelineno-0-541">541</a></span>
<span class="normal"><a href="#__codelineno-0-542">542</a></span>
<span class="normal"><a href="#__codelineno-0-543">543</a></span>
<span class="normal"><a href="#__codelineno-0-544">544</a></span>
<span class="normal"><a href="#__codelineno-0-545">545</a></span>
<span class="normal"><a href="#__codelineno-0-546">546</a></span>
<span class="normal"><a href="#__codelineno-0-547">547</a></span>
<span class="normal"><a href="#__codelineno-0-548">548</a></span>
<span class="normal"><a href="#__codelineno-0-549">549</a></span>
<span class="normal"><a href="#__codelineno-0-550">550</a></span>
<span class="normal"><a href="#__codelineno-0-551">551</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-524" name="__codelineno-0-524"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-525" name="__codelineno-0-525"></a><span class="k">def</span><span class="w"> </span><span class="nf">history_orders</span><span class="p">(</span>
<a id="__codelineno-0-526" name="__codelineno-0-526"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-527" name="__codelineno-0-527"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-528" name="__codelineno-0-528"></a> <span class="n">datetime</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-529" name="__codelineno-0-529"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Start date.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-530" name="__codelineno-0-530"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-531" name="__codelineno-0-531"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-532" name="__codelineno-0-532"></a> <span class="n">datetime</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-533" name="__codelineno-0-533"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;End date.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-534" name="__codelineno-0-534"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-535" name="__codelineno-0-535"></a> <span class="n">group</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Group filter.&quot;</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-536" name="__codelineno-0-536"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Symbol filter.&quot;</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-537" name="__codelineno-0-537"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Order ticket.&quot;</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-538" name="__codelineno-0-538"></a> <span class="n">position</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Position ticket.&quot;</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-539" name="__codelineno-0-539"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-540" name="__codelineno-0-540"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export historical orders.&quot;&quot;&quot;</span>
<a id="__codelineno-0-541" name="__codelineno-0-541"></a> <span class="n">_export_command</span><span class="p">(</span>
<a id="__codelineno-0-542" name="__codelineno-0-542"></a> <span class="n">ctx</span><span class="p">,</span>
<a id="__codelineno-0-543" name="__codelineno-0-543"></a> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">history_orders</span><span class="p">(</span>
<a id="__codelineno-0-544" name="__codelineno-0-544"></a> <span class="n">date_from</span><span class="o">=</span><span class="n">date_from</span><span class="p">,</span>
<a id="__codelineno-0-545" name="__codelineno-0-545"></a> <span class="n">date_to</span><span class="o">=</span><span class="n">date_to</span><span class="p">,</span>
<a id="__codelineno-0-546" name="__codelineno-0-546"></a> <span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span>
<a id="__codelineno-0-547" name="__codelineno-0-547"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
<a id="__codelineno-0-548" name="__codelineno-0-548"></a> <span class="n">ticket</span><span class="o">=</span><span class="n">ticket</span><span class="p">,</span>
<a id="__codelineno-0-549" name="__codelineno-0-549"></a> <span class="n">position</span><span class="o">=</span><span class="n">position</span><span class="p">,</span>
<a id="__codelineno-0-550" name="__codelineno-0-550"></a> <span class="p">),</span>
<a id="__codelineno-0-551" name="__codelineno-0-551"></a> <span class="p">)</span>
2026-04-22 17:11:38 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
2026-06-08 13:55:22 +00:00
<h3 id="mt5cli.cli.last_error" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">last_error</span>
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
<a href="#mt5cli.cli.last_error" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">last_error</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
2026-04-22 17:11:38 +00:00
</code></pre></div>
<div class="doc doc-contents ">
2026-06-08 13:55:22 +00:00
<p>Export the last error information.</p>
2026-04-22 17:11:38 +00:00
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-619">619</a></span>
<span class="normal"><a href="#__codelineno-0-620">620</a></span>
<span class="normal"><a href="#__codelineno-0-621">621</a></span>
<span class="normal"><a href="#__codelineno-0-622">622</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-619" name="__codelineno-0-619"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-620" name="__codelineno-0-620"></a><span class="k">def</span><span class="w"> </span><span class="nf">last_error</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-621" name="__codelineno-0-621"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export the last error information.&quot;&quot;&quot;</span>
<a id="__codelineno-0-622" name="__codelineno-0-622"></a> <span class="n">_export_command</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">last_error</span><span class="p">())</span>
2026-06-09 02:27:54 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="mt5cli.cli.latest_rates" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">latest_rates</span>
<a href="#mt5cli.cli.latest_rates" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">latest_rates</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="TIMEFRAME_TYPE
module-attribute
(mt5cli.utils.TIMEFRAME_TYPE)" href="../utils/#mt5cli.utils.TIMEFRAME_TYPE">TIMEFRAME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Timeframe.&quot;</span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">),</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="p">],</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n">count</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Number of records.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="p">],</span>
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="n">start_pos</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span>
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Start position (0 = current bar).&quot;</span><span class="p">),</span>
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="p">]</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Export latest rates from a start position.</p>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-313">313</a></span>
<span class="normal"><a href="#__codelineno-0-314">314</a></span>
<span class="normal"><a href="#__codelineno-0-315">315</a></span>
<span class="normal"><a href="#__codelineno-0-316">316</a></span>
<span class="normal"><a href="#__codelineno-0-317">317</a></span>
<span class="normal"><a href="#__codelineno-0-318">318</a></span>
<span class="normal"><a href="#__codelineno-0-319">319</a></span>
<span class="normal"><a href="#__codelineno-0-320">320</a></span>
<span class="normal"><a href="#__codelineno-0-321">321</a></span>
<span class="normal"><a href="#__codelineno-0-322">322</a></span>
<span class="normal"><a href="#__codelineno-0-323">323</a></span>
<span class="normal"><a href="#__codelineno-0-324">324</a></span>
<span class="normal"><a href="#__codelineno-0-325">325</a></span>
<span class="normal"><a href="#__codelineno-0-326">326</a></span>
<span class="normal"><a href="#__codelineno-0-327">327</a></span>
<span class="normal"><a href="#__codelineno-0-328">328</a></span>
<span class="normal"><a href="#__codelineno-0-329">329</a></span>
<span class="normal"><a href="#__codelineno-0-330">330</a></span>
<span class="normal"><a href="#__codelineno-0-331">331</a></span>
<span class="normal"><a href="#__codelineno-0-332">332</a></span>
<span class="normal"><a href="#__codelineno-0-333">333</a></span>
<span class="normal"><a href="#__codelineno-0-334">334</a></span>
<span class="normal"><a href="#__codelineno-0-335">335</a></span>
<span class="normal"><a href="#__codelineno-0-336">336</a></span>
<span class="normal"><a href="#__codelineno-0-337">337</a></span>
<span class="normal"><a href="#__codelineno-0-338">338</a></span>
<span class="normal"><a href="#__codelineno-0-339">339</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-313" name="__codelineno-0-313"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-314" name="__codelineno-0-314"></a><span class="k">def</span><span class="w"> </span><span class="nf">latest_rates</span><span class="p">(</span>
<a id="__codelineno-0-315" name="__codelineno-0-315"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-316" name="__codelineno-0-316"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-317" name="__codelineno-0-317"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-318" name="__codelineno-0-318"></a> <span class="nb">int</span><span class="p">,</span>
<a id="__codelineno-0-319" name="__codelineno-0-319"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-320" name="__codelineno-0-320"></a> <span class="n">click_type</span><span class="o">=</span><span class="n">TIMEFRAME_TYPE</span><span class="p">,</span>
<a id="__codelineno-0-321" name="__codelineno-0-321"></a> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Timeframe.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-322" name="__codelineno-0-322"></a> <span class="p">),</span>
<a id="__codelineno-0-323" name="__codelineno-0-323"></a> <span class="p">],</span>
<a id="__codelineno-0-324" name="__codelineno-0-324"></a> <span class="n">count</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Number of records.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-325" name="__codelineno-0-325"></a> <span class="n">start_pos</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-326" name="__codelineno-0-326"></a> <span class="nb">int</span><span class="p">,</span>
<a id="__codelineno-0-327" name="__codelineno-0-327"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Start position (0 = current bar).&quot;</span><span class="p">),</span>
<a id="__codelineno-0-328" name="__codelineno-0-328"></a> <span class="p">]</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
<a id="__codelineno-0-329" name="__codelineno-0-329"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-330" name="__codelineno-0-330"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export latest rates from a start position.&quot;&quot;&quot;</span>
<a id="__codelineno-0-331" name="__codelineno-0-331"></a> <span class="n">_export_command</span><span class="p">(</span>
<a id="__codelineno-0-332" name="__codelineno-0-332"></a> <span class="n">ctx</span><span class="p">,</span>
<a id="__codelineno-0-333" name="__codelineno-0-333"></a> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">latest_rates</span><span class="p">(</span>
<a id="__codelineno-0-334" name="__codelineno-0-334"></a> <span class="n">symbol</span><span class="p">,</span>
<a id="__codelineno-0-335" name="__codelineno-0-335"></a> <span class="n">timeframe</span><span class="p">,</span>
<a id="__codelineno-0-336" name="__codelineno-0-336"></a> <span class="n">count</span><span class="p">,</span>
<a id="__codelineno-0-337" name="__codelineno-0-337"></a> <span class="n">start_pos</span><span class="o">=</span><span class="n">start_pos</span><span class="p">,</span>
<a id="__codelineno-0-338" name="__codelineno-0-338"></a> <span class="p">),</span>
<a id="__codelineno-0-339" name="__codelineno-0-339"></a> <span class="p">)</span>
2026-04-22 17:11:38 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
2026-06-08 13:55:22 +00:00
<h3 id="mt5cli.cli.main" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">main</span>
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
<a href="#mt5cli.cli.main" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">main</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span>
2026-04-22 17:11:38 +00:00
</code></pre></div>
<div class="doc doc-contents ">
2026-06-08 13:55:22 +00:00
<p>Run the mt5cli CLI.</p>
2026-04-22 17:11:38 +00:00
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1083">1083</a></span>
<span class="normal"><a href="#__codelineno-0-1084">1084</a></span>
<span class="normal"><a href="#__codelineno-0-1085">1085</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-1083" name="__codelineno-0-1083"></a><span class="k">def</span><span class="w"> </span><span class="nf">main</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-1084" name="__codelineno-0-1084"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Run the mt5cli CLI.&quot;&quot;&quot;</span>
<a id="__codelineno-0-1085" name="__codelineno-0-1085"></a> <span class="n">app</span><span class="p">()</span>
2026-04-22 17:11:38 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
2026-06-08 13:55:22 +00:00
<h3 id="mt5cli.cli.market_book" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">market_book</span>
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
<a href="#mt5cli.cli.market_book" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">market_book</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
2026-04-22 17:11:38 +00:00
</code></pre></div>
<div class="doc doc-contents ">
2026-06-08 13:55:22 +00:00
<p>Export market depth (order book) for a symbol.</p>
2026-04-22 17:11:38 +00:00
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-634">634</a></span>
<span class="normal"><a href="#__codelineno-0-635">635</a></span>
<span class="normal"><a href="#__codelineno-0-636">636</a></span>
<span class="normal"><a href="#__codelineno-0-637">637</a></span>
<span class="normal"><a href="#__codelineno-0-638">638</a></span>
<span class="normal"><a href="#__codelineno-0-639">639</a></span>
<span class="normal"><a href="#__codelineno-0-640">640</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-634" name="__codelineno-0-634"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-635" name="__codelineno-0-635"></a><span class="k">def</span><span class="w"> </span><span class="nf">market_book</span><span class="p">(</span>
<a id="__codelineno-0-636" name="__codelineno-0-636"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-637" name="__codelineno-0-637"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-638" name="__codelineno-0-638"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-639" name="__codelineno-0-639"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export market depth (order book) for a symbol.&quot;&quot;&quot;</span>
<a id="__codelineno-0-640" name="__codelineno-0-640"></a> <span class="n">_export_command</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">market_book</span><span class="p">(</span><span class="n">symbol</span><span class="p">))</span>
2026-06-08 18:29:32 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="mt5cli.cli.minimum_margins" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">minimum_margins</span>
<a href="#mt5cli.cli.minimum_margins" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">minimum_margins</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Export minimum-volume buy and sell margin requirements.</p>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-487">487</a></span>
<span class="normal"><a href="#__codelineno-0-488">488</a></span>
<span class="normal"><a href="#__codelineno-0-489">489</a></span>
<span class="normal"><a href="#__codelineno-0-490">490</a></span>
<span class="normal"><a href="#__codelineno-0-491">491</a></span>
<span class="normal"><a href="#__codelineno-0-492">492</a></span>
<span class="normal"><a href="#__codelineno-0-493">493</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-487" name="__codelineno-0-487"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-488" name="__codelineno-0-488"></a><span class="k">def</span><span class="w"> </span><span class="nf">minimum_margins</span><span class="p">(</span>
<a id="__codelineno-0-489" name="__codelineno-0-489"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-490" name="__codelineno-0-490"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-491" name="__codelineno-0-491"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-492" name="__codelineno-0-492"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export minimum-volume buy and sell margin requirements.&quot;&quot;&quot;</span>
<a id="__codelineno-0-493" name="__codelineno-0-493"></a> <span class="n">_export_command</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">minimum_margins</span><span class="p">(</span><span class="n">symbol</span><span class="p">))</span>
2026-06-09 02:27:54 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="mt5cli.cli.mt5_summary" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">mt5_summary</span>
<a href="#mt5cli.cli.mt5_summary" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">mt5_summary</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Export a compact terminal/account status summary.</p>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-607">607</a></span>
<span class="normal"><a href="#__codelineno-0-608">608</a></span>
<span class="normal"><a href="#__codelineno-0-609">609</a></span>
<span class="normal"><a href="#__codelineno-0-610">610</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-607" name="__codelineno-0-607"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-608" name="__codelineno-0-608"></a><span class="k">def</span><span class="w"> </span><span class="nf">mt5_summary</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-609" name="__codelineno-0-609"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export a compact terminal/account status summary.&quot;&quot;&quot;</span>
<a id="__codelineno-0-610" name="__codelineno-0-610"></a> <span class="n">_export_command</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">mt5_summary_as_df</span><span class="p">())</span>
2026-04-22 17:11:38 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
2026-06-08 13:55:22 +00:00
<h3 id="mt5cli.cli.order_check" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">order_check</span>
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
<a href="#mt5cli.cli.order_check" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">order_check</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">request</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n"><span title="dict">dict</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typing.Any">Any</span></span><span class="p">],</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="REQUEST_TYPE
2026-04-22 17:11:38 +00:00
2026-06-08 13:55:22 +00:00
module-attribute
(mt5cli.utils.REQUEST_TYPE)" href="../utils/#mt5cli.utils.REQUEST_TYPE">REQUEST_TYPE</a></span><span class="p">,</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="n"><span title="mt5cli.cli._REQUEST_OPTION_HELP">_REQUEST_OPTION_HELP</span></span><span class="p">,</span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">),</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="p">],</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Check funds sufficiency for a trading operation.</p>
2026-04-22 17:11:38 +00:00
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-643">643</a></span>
<span class="normal"><a href="#__codelineno-0-644">644</a></span>
<span class="normal"><a href="#__codelineno-0-645">645</a></span>
<span class="normal"><a href="#__codelineno-0-646">646</a></span>
<span class="normal"><a href="#__codelineno-0-647">647</a></span>
<span class="normal"><a href="#__codelineno-0-648">648</a></span>
<span class="normal"><a href="#__codelineno-0-649">649</a></span>
<span class="normal"><a href="#__codelineno-0-650">650</a></span>
<span class="normal"><a href="#__codelineno-0-651">651</a></span>
<span class="normal"><a href="#__codelineno-0-652">652</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-643" name="__codelineno-0-643"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-644" name="__codelineno-0-644"></a><span class="k">def</span><span class="w"> </span><span class="nf">order_check</span><span class="p">(</span>
<a id="__codelineno-0-645" name="__codelineno-0-645"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-646" name="__codelineno-0-646"></a> <span class="n">request</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-647" name="__codelineno-0-647"></a> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">],</span>
<a id="__codelineno-0-648" name="__codelineno-0-648"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">REQUEST_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="n">_REQUEST_OPTION_HELP</span><span class="p">),</span>
<a id="__codelineno-0-649" name="__codelineno-0-649"></a> <span class="p">],</span>
<a id="__codelineno-0-650" name="__codelineno-0-650"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-651" name="__codelineno-0-651"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Check funds sufficiency for a trading operation.&quot;&quot;&quot;</span>
<a id="__codelineno-0-652" name="__codelineno-0-652"></a> <span class="n">_export_command</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">order_check</span><span class="p">(</span><span class="n">request</span><span class="p">))</span>
2026-04-26 12:50:38 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
2026-06-08 13:55:22 +00:00
<h3 id="mt5cli.cli.order_send" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">order_send</span>
<a href="#mt5cli.cli.order_send" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">order_send</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">request</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n"><span title="dict">dict</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typing.Any">Any</span></span><span class="p">],</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="REQUEST_TYPE
2026-04-26 12:50:38 +00:00
2026-06-08 13:55:22 +00:00
module-attribute
(mt5cli.utils.REQUEST_TYPE)" href="../utils/#mt5cli.utils.REQUEST_TYPE">REQUEST_TYPE</a></span><span class="p">,</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="n"><span title="mt5cli.cli._REQUEST_OPTION_HELP">_REQUEST_OPTION_HELP</span></span><span class="p">,</span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">),</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="p">],</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n">yes</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n"><span title="bool">bool</span></span><span class="p">,</span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="s2">&quot;--yes&quot;</span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Confirm the live trade request.&quot;</span>
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="p">),</span>
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
2026-04-26 12:50:38 +00:00
</code></pre></div>
<div class="doc doc-contents ">
2026-06-27 16:23:59 +00:00
<p>Send a raw trade request to the trade server (expert path, live execution).</p>
<p>Passes the request JSON directly to MT5 <code>order_send</code>. This is the
low-level expert path — it places real trades on the connected account
with no additional validation beyond what MT5 itself performs. Use
<code>order-check</code> first to validate funds sufficiency. Prefer
<code>close-positions</code> for closing open positions. <code>--yes</code> is required.</p>
2026-04-26 12:50:38 +00:00
2026-06-08 13:55:22 +00:00
<p><span class="doc-section-title">Raises:</span></p>
2026-04-26 12:50:38 +00:00
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
2026-06-08 13:55:22 +00:00
<code><span title="typer.BadParameter">BadParameter</span></code>
2026-04-26 12:50:38 +00:00
</td>
<td>
<div class="doc-md-description">
2026-06-08 13:55:22 +00:00
<p>If --yes is not provided.</p>
2026-04-26 12:50:38 +00:00
</div>
</td>
</tr>
</tbody>
</table>
2026-06-08 13:55:22 +00:00
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-655">655</a></span>
<span class="normal"><a href="#__codelineno-0-656">656</a></span>
<span class="normal"><a href="#__codelineno-0-657">657</a></span>
<span class="normal"><a href="#__codelineno-0-658">658</a></span>
<span class="normal"><a href="#__codelineno-0-659">659</a></span>
<span class="normal"><a href="#__codelineno-0-660">660</a></span>
<span class="normal"><a href="#__codelineno-0-661">661</a></span>
<span class="normal"><a href="#__codelineno-0-662">662</a></span>
<span class="normal"><a href="#__codelineno-0-663">663</a></span>
<span class="normal"><a href="#__codelineno-0-664">664</a></span>
<span class="normal"><a href="#__codelineno-0-665">665</a></span>
<span class="normal"><a href="#__codelineno-0-666">666</a></span>
<span class="normal"><a href="#__codelineno-0-667">667</a></span>
<span class="normal"><a href="#__codelineno-0-668">668</a></span>
<span class="normal"><a href="#__codelineno-0-669">669</a></span>
<span class="normal"><a href="#__codelineno-0-670">670</a></span>
<span class="normal"><a href="#__codelineno-0-671">671</a></span>
<span class="normal"><a href="#__codelineno-0-672">672</a></span>
<span class="normal"><a href="#__codelineno-0-673">673</a></span>
<span class="normal"><a href="#__codelineno-0-674">674</a></span>
<span class="normal"><a href="#__codelineno-0-675">675</a></span>
<span class="normal"><a href="#__codelineno-0-676">676</a></span>
<span class="normal"><a href="#__codelineno-0-677">677</a></span>
<span class="normal"><a href="#__codelineno-0-678">678</a></span>
<span class="normal"><a href="#__codelineno-0-679">679</a></span>
<span class="normal"><a href="#__codelineno-0-680">680</a></span>
<span class="normal"><a href="#__codelineno-0-681">681</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-655" name="__codelineno-0-655"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Execution&quot;</span><span class="p">)</span>
<a id="__codelineno-0-656" name="__codelineno-0-656"></a><span class="k">def</span><span class="w"> </span><span class="nf">order_send</span><span class="p">(</span>
<a id="__codelineno-0-657" name="__codelineno-0-657"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-658" name="__codelineno-0-658"></a> <span class="n">request</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-659" name="__codelineno-0-659"></a> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">],</span>
<a id="__codelineno-0-660" name="__codelineno-0-660"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">REQUEST_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="n">_REQUEST_OPTION_HELP</span><span class="p">),</span>
<a id="__codelineno-0-661" name="__codelineno-0-661"></a> <span class="p">],</span>
<a id="__codelineno-0-662" name="__codelineno-0-662"></a> <span class="n">yes</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-663" name="__codelineno-0-663"></a> <span class="nb">bool</span><span class="p">,</span>
<a id="__codelineno-0-664" name="__codelineno-0-664"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="s2">&quot;--yes&quot;</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Confirm the live trade request.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-665" name="__codelineno-0-665"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
<a id="__codelineno-0-666" name="__codelineno-0-666"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-667" name="__codelineno-0-667"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Send a raw trade request to the trade server (expert path, live execution).</span>
<a id="__codelineno-0-668" name="__codelineno-0-668"></a>
<a id="__codelineno-0-669" name="__codelineno-0-669"></a><span class="sd"> Passes the request JSON directly to MT5 ``order_send``. This is the</span>
<a id="__codelineno-0-670" name="__codelineno-0-670"></a><span class="sd"> low-level expert path — it places real trades on the connected account</span>
<a id="__codelineno-0-671" name="__codelineno-0-671"></a><span class="sd"> with no additional validation beyond what MT5 itself performs. Use</span>
<a id="__codelineno-0-672" name="__codelineno-0-672"></a><span class="sd"> ``order-check`` first to validate funds sufficiency. Prefer</span>
<a id="__codelineno-0-673" name="__codelineno-0-673"></a><span class="sd"> ``close-positions`` for closing open positions. ``--yes`` is required.</span>
<a id="__codelineno-0-674" name="__codelineno-0-674"></a>
<a id="__codelineno-0-675" name="__codelineno-0-675"></a><span class="sd"> Raises:</span>
<a id="__codelineno-0-676" name="__codelineno-0-676"></a><span class="sd"> typer.BadParameter: If --yes is not provided.</span>
<a id="__codelineno-0-677" name="__codelineno-0-677"></a><span class="sd"> &quot;&quot;&quot;</span>
<a id="__codelineno-0-678" name="__codelineno-0-678"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">yes</span><span class="p">:</span>
<a id="__codelineno-0-679" name="__codelineno-0-679"></a> <span class="n">msg</span> <span class="o">=</span> <span class="s2">&quot;Pass --yes to send a live trade request.&quot;</span>
<a id="__codelineno-0-680" name="__codelineno-0-680"></a> <span class="k">raise</span> <span class="n">typer</span><span class="o">.</span><span class="n">BadParameter</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">param_hint</span><span class="o">=</span><span class="s2">&quot;--yes&quot;</span><span class="p">)</span>
<a id="__codelineno-0-681" name="__codelineno-0-681"></a> <span class="n">_export_command</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">order_send</span><span class="p">(</span><span class="n">request</span><span class="p">))</span>
2026-06-08 13:55:22 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
2026-04-26 12:50:38 +00:00
2026-06-08 13:55:22 +00:00
</div>
2026-04-26 12:50:38 +00:00
2026-06-08 13:55:22 +00:00
<div class="doc doc-object doc-function">
<h3 id="mt5cli.cli.orders" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">orders</span>
<a href="#mt5cli.cli.orders" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">orders</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Symbol filter.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">group</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Group filter.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Ticket filter.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Export active orders.</p>
2026-04-26 12:50:38 +00:00
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-496">496</a></span>
<span class="normal"><a href="#__codelineno-0-497">497</a></span>
<span class="normal"><a href="#__codelineno-0-498">498</a></span>
<span class="normal"><a href="#__codelineno-0-499">499</a></span>
<span class="normal"><a href="#__codelineno-0-500">500</a></span>
<span class="normal"><a href="#__codelineno-0-501">501</a></span>
<span class="normal"><a href="#__codelineno-0-502">502</a></span>
<span class="normal"><a href="#__codelineno-0-503">503</a></span>
<span class="normal"><a href="#__codelineno-0-504">504</a></span>
<span class="normal"><a href="#__codelineno-0-505">505</a></span>
<span class="normal"><a href="#__codelineno-0-506">506</a></span>
<span class="normal"><a href="#__codelineno-0-507">507</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-496" name="__codelineno-0-496"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-497" name="__codelineno-0-497"></a><span class="k">def</span><span class="w"> </span><span class="nf">orders</span><span class="p">(</span>
<a id="__codelineno-0-498" name="__codelineno-0-498"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-499" name="__codelineno-0-499"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Symbol filter.&quot;</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-500" name="__codelineno-0-500"></a> <span class="n">group</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Group filter.&quot;</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-501" name="__codelineno-0-501"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Ticket filter.&quot;</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-502" name="__codelineno-0-502"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-503" name="__codelineno-0-503"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export active orders.&quot;&quot;&quot;</span>
<a id="__codelineno-0-504" name="__codelineno-0-504"></a> <span class="n">_export_command</span><span class="p">(</span>
<a id="__codelineno-0-505" name="__codelineno-0-505"></a> <span class="n">ctx</span><span class="p">,</span>
<a id="__codelineno-0-506" name="__codelineno-0-506"></a> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">orders</span><span class="p">(</span><span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span> <span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span> <span class="n">ticket</span><span class="o">=</span><span class="n">ticket</span><span class="p">),</span>
<a id="__codelineno-0-507" name="__codelineno-0-507"></a> <span class="p">)</span>
2026-04-22 17:11:38 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="mt5cli.cli.positions" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">positions</span>
<a href="#mt5cli.cli.positions" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">positions</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Symbol filter.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">group</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Group filter.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Ticket filter.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
2026-05-28 16:23:36 +00:00
<div class="doc doc-contents ">
<p>Export open positions.</p>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-510">510</a></span>
<span class="normal"><a href="#__codelineno-0-511">511</a></span>
<span class="normal"><a href="#__codelineno-0-512">512</a></span>
<span class="normal"><a href="#__codelineno-0-513">513</a></span>
<span class="normal"><a href="#__codelineno-0-514">514</a></span>
<span class="normal"><a href="#__codelineno-0-515">515</a></span>
<span class="normal"><a href="#__codelineno-0-516">516</a></span>
<span class="normal"><a href="#__codelineno-0-517">517</a></span>
<span class="normal"><a href="#__codelineno-0-518">518</a></span>
<span class="normal"><a href="#__codelineno-0-519">519</a></span>
<span class="normal"><a href="#__codelineno-0-520">520</a></span>
<span class="normal"><a href="#__codelineno-0-521">521</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-510" name="__codelineno-0-510"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-511" name="__codelineno-0-511"></a><span class="k">def</span><span class="w"> </span><span class="nf">positions</span><span class="p">(</span>
<a id="__codelineno-0-512" name="__codelineno-0-512"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-513" name="__codelineno-0-513"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Symbol filter.&quot;</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-514" name="__codelineno-0-514"></a> <span class="n">group</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Group filter.&quot;</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-515" name="__codelineno-0-515"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Ticket filter.&quot;</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-516" name="__codelineno-0-516"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-517" name="__codelineno-0-517"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export open positions.&quot;&quot;&quot;</span>
<a id="__codelineno-0-518" name="__codelineno-0-518"></a> <span class="n">_export_command</span><span class="p">(</span>
<a id="__codelineno-0-519" name="__codelineno-0-519"></a> <span class="n">ctx</span><span class="p">,</span>
<a id="__codelineno-0-520" name="__codelineno-0-520"></a> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">positions</span><span class="p">(</span><span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span> <span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span> <span class="n">ticket</span><span class="o">=</span><span class="n">ticket</span><span class="p">),</span>
<a id="__codelineno-0-521" name="__codelineno-0-521"></a> <span class="p">)</span>
2026-04-22 17:11:38 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="mt5cli.cli.rates_from" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">rates_from</span>
<a href="#mt5cli.cli.rates_from" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">rates_from</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="TIMEFRAME_TYPE
module-attribute
2026-06-08 13:55:22 +00:00
(mt5cli.utils.TIMEFRAME_TYPE)" href="../utils/#mt5cli.utils.TIMEFRAME_TYPE">TIMEFRAME_TYPE</a></span><span class="p">,</span>
2026-04-22 17:11:38 +00:00
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Timeframe (e.g., M1, H1, D1, or integer).&quot;</span><span class="p">,</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="p">),</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="p">],</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n"><span title="datetime.datetime">datetime</span></span><span class="p">,</span>
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
module-attribute
2026-06-08 13:55:22 +00:00
(mt5cli.utils.DATETIME_TYPE)" href="../utils/#mt5cli.utils.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span>
2026-04-22 17:11:38 +00:00
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Start date in ISO 8601 format.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="p">),</span>
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> <span class="p">],</span>
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> <span class="n">count</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Number of records.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a> <span class="p">],</span>
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Export rates from a start date.</p>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-260">260</a></span>
<span class="normal"><a href="#__codelineno-0-261">261</a></span>
<span class="normal"><a href="#__codelineno-0-262">262</a></span>
<span class="normal"><a href="#__codelineno-0-263">263</a></span>
<span class="normal"><a href="#__codelineno-0-264">264</a></span>
<span class="normal"><a href="#__codelineno-0-265">265</a></span>
<span class="normal"><a href="#__codelineno-0-266">266</a></span>
<span class="normal"><a href="#__codelineno-0-267">267</a></span>
<span class="normal"><a href="#__codelineno-0-268">268</a></span>
<span class="normal"><a href="#__codelineno-0-269">269</a></span>
<span class="normal"><a href="#__codelineno-0-270">270</a></span>
<span class="normal"><a href="#__codelineno-0-271">271</a></span>
<span class="normal"><a href="#__codelineno-0-272">272</a></span>
<span class="normal"><a href="#__codelineno-0-273">273</a></span>
<span class="normal"><a href="#__codelineno-0-274">274</a></span>
<span class="normal"><a href="#__codelineno-0-275">275</a></span>
<span class="normal"><a href="#__codelineno-0-276">276</a></span>
<span class="normal"><a href="#__codelineno-0-277">277</a></span>
<span class="normal"><a href="#__codelineno-0-278">278</a></span>
<span class="normal"><a href="#__codelineno-0-279">279</a></span>
<span class="normal"><a href="#__codelineno-0-280">280</a></span>
<span class="normal"><a href="#__codelineno-0-281">281</a></span>
<span class="normal"><a href="#__codelineno-0-282">282</a></span>
<span class="normal"><a href="#__codelineno-0-283">283</a></span>
<span class="normal"><a href="#__codelineno-0-284">284</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-260" name="__codelineno-0-260"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-261" name="__codelineno-0-261"></a><span class="k">def</span><span class="w"> </span><span class="nf">rates_from</span><span class="p">(</span>
<a id="__codelineno-0-262" name="__codelineno-0-262"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-263" name="__codelineno-0-263"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-264" name="__codelineno-0-264"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-265" name="__codelineno-0-265"></a> <span class="nb">int</span><span class="p">,</span>
<a id="__codelineno-0-266" name="__codelineno-0-266"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-267" name="__codelineno-0-267"></a> <span class="n">click_type</span><span class="o">=</span><span class="n">TIMEFRAME_TYPE</span><span class="p">,</span>
<a id="__codelineno-0-268" name="__codelineno-0-268"></a> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Timeframe (e.g., M1, H1, D1, or integer).&quot;</span><span class="p">,</span>
<a id="__codelineno-0-269" name="__codelineno-0-269"></a> <span class="p">),</span>
<a id="__codelineno-0-270" name="__codelineno-0-270"></a> <span class="p">],</span>
<a id="__codelineno-0-271" name="__codelineno-0-271"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-272" name="__codelineno-0-272"></a> <span class="n">datetime</span><span class="p">,</span>
<a id="__codelineno-0-273" name="__codelineno-0-273"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-274" name="__codelineno-0-274"></a> <span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span>
<a id="__codelineno-0-275" name="__codelineno-0-275"></a> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Start date in ISO 8601 format.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-276" name="__codelineno-0-276"></a> <span class="p">),</span>
<a id="__codelineno-0-277" name="__codelineno-0-277"></a> <span class="p">],</span>
<a id="__codelineno-0-278" name="__codelineno-0-278"></a> <span class="n">count</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Number of records.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-279" name="__codelineno-0-279"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-280" name="__codelineno-0-280"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export rates from a start date.&quot;&quot;&quot;</span>
<a id="__codelineno-0-281" name="__codelineno-0-281"></a> <span class="n">_export_command</span><span class="p">(</span>
<a id="__codelineno-0-282" name="__codelineno-0-282"></a> <span class="n">ctx</span><span class="p">,</span>
<a id="__codelineno-0-283" name="__codelineno-0-283"></a> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">copy_rates_from</span><span class="p">(</span><span class="n">symbol</span><span class="p">,</span> <span class="n">timeframe</span><span class="p">,</span> <span class="n">date_from</span><span class="p">,</span> <span class="n">count</span><span class="p">),</span>
<a id="__codelineno-0-284" name="__codelineno-0-284"></a> <span class="p">)</span>
2026-04-22 17:11:38 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="mt5cli.cli.rates_from_pos" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">rates_from_pos</span>
<a href="#mt5cli.cli.rates_from_pos" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">rates_from_pos</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="TIMEFRAME_TYPE
module-attribute
2026-06-08 13:55:22 +00:00
(mt5cli.utils.TIMEFRAME_TYPE)" href="../utils/#mt5cli.utils.TIMEFRAME_TYPE">TIMEFRAME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Timeframe.&quot;</span>
2026-04-22 17:11:38 +00:00
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">),</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="p">],</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n">start_pos</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Start position (0 = current bar).&quot;</span><span class="p">),</span>
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="p">],</span>
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n">count</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Number of records.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="p">],</span>
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Export rates from a start position.</p>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-287">287</a></span>
<span class="normal"><a href="#__codelineno-0-288">288</a></span>
<span class="normal"><a href="#__codelineno-0-289">289</a></span>
<span class="normal"><a href="#__codelineno-0-290">290</a></span>
<span class="normal"><a href="#__codelineno-0-291">291</a></span>
<span class="normal"><a href="#__codelineno-0-292">292</a></span>
<span class="normal"><a href="#__codelineno-0-293">293</a></span>
<span class="normal"><a href="#__codelineno-0-294">294</a></span>
<span class="normal"><a href="#__codelineno-0-295">295</a></span>
<span class="normal"><a href="#__codelineno-0-296">296</a></span>
<span class="normal"><a href="#__codelineno-0-297">297</a></span>
<span class="normal"><a href="#__codelineno-0-298">298</a></span>
<span class="normal"><a href="#__codelineno-0-299">299</a></span>
<span class="normal"><a href="#__codelineno-0-300">300</a></span>
<span class="normal"><a href="#__codelineno-0-301">301</a></span>
<span class="normal"><a href="#__codelineno-0-302">302</a></span>
<span class="normal"><a href="#__codelineno-0-303">303</a></span>
<span class="normal"><a href="#__codelineno-0-304">304</a></span>
<span class="normal"><a href="#__codelineno-0-305">305</a></span>
<span class="normal"><a href="#__codelineno-0-306">306</a></span>
<span class="normal"><a href="#__codelineno-0-307">307</a></span>
<span class="normal"><a href="#__codelineno-0-308">308</a></span>
<span class="normal"><a href="#__codelineno-0-309">309</a></span>
<span class="normal"><a href="#__codelineno-0-310">310</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-287" name="__codelineno-0-287"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-288" name="__codelineno-0-288"></a><span class="k">def</span><span class="w"> </span><span class="nf">rates_from_pos</span><span class="p">(</span>
<a id="__codelineno-0-289" name="__codelineno-0-289"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-290" name="__codelineno-0-290"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-291" name="__codelineno-0-291"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-292" name="__codelineno-0-292"></a> <span class="nb">int</span><span class="p">,</span>
<a id="__codelineno-0-293" name="__codelineno-0-293"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-294" name="__codelineno-0-294"></a> <span class="n">click_type</span><span class="o">=</span><span class="n">TIMEFRAME_TYPE</span><span class="p">,</span>
<a id="__codelineno-0-295" name="__codelineno-0-295"></a> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Timeframe.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-296" name="__codelineno-0-296"></a> <span class="p">),</span>
<a id="__codelineno-0-297" name="__codelineno-0-297"></a> <span class="p">],</span>
<a id="__codelineno-0-298" name="__codelineno-0-298"></a> <span class="n">start_pos</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Start position (0 = current bar).&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-299" name="__codelineno-0-299"></a> <span class="n">count</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Number of records.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-300" name="__codelineno-0-300"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-301" name="__codelineno-0-301"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export rates from a start position.&quot;&quot;&quot;</span>
<a id="__codelineno-0-302" name="__codelineno-0-302"></a> <span class="n">_export_command</span><span class="p">(</span>
<a id="__codelineno-0-303" name="__codelineno-0-303"></a> <span class="n">ctx</span><span class="p">,</span>
<a id="__codelineno-0-304" name="__codelineno-0-304"></a> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">copy_rates_from_pos</span><span class="p">(</span>
<a id="__codelineno-0-305" name="__codelineno-0-305"></a> <span class="n">symbol</span><span class="p">,</span>
<a id="__codelineno-0-306" name="__codelineno-0-306"></a> <span class="n">timeframe</span><span class="p">,</span>
<a id="__codelineno-0-307" name="__codelineno-0-307"></a> <span class="n">start_pos</span><span class="p">,</span>
<a id="__codelineno-0-308" name="__codelineno-0-308"></a> <span class="n">count</span><span class="p">,</span>
<a id="__codelineno-0-309" name="__codelineno-0-309"></a> <span class="p">),</span>
<a id="__codelineno-0-310" name="__codelineno-0-310"></a> <span class="p">)</span>
2026-04-22 17:11:38 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="mt5cli.cli.rates_range" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">rates_range</span>
<a href="#mt5cli.cli.rates_range" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">rates_range</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="TIMEFRAME_TYPE
module-attribute
2026-06-08 13:55:22 +00:00
(mt5cli.utils.TIMEFRAME_TYPE)" href="../utils/#mt5cli.utils.TIMEFRAME_TYPE">TIMEFRAME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Timeframe.&quot;</span>
2026-04-22 17:11:38 +00:00
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">),</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="p">],</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n"><span title="datetime.datetime">datetime</span></span><span class="p">,</span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
module-attribute
2026-06-08 13:55:22 +00:00
(mt5cli.utils.DATETIME_TYPE)" href="../utils/#mt5cli.utils.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Start date.&quot;</span>
2026-04-22 17:11:38 +00:00
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="p">),</span>
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="p">],</span>
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> <span class="n"><span title="datetime.datetime">datetime</span></span><span class="p">,</span>
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
module-attribute
2026-06-08 13:55:22 +00:00
(mt5cli.utils.DATETIME_TYPE)" href="../utils/#mt5cli.utils.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;End date.&quot;</span><span class="p">),</span>
2026-04-22 17:11:38 +00:00
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> <span class="p">],</span>
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Export rates for a date range.</p>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-342">342</a></span>
<span class="normal"><a href="#__codelineno-0-343">343</a></span>
<span class="normal"><a href="#__codelineno-0-344">344</a></span>
<span class="normal"><a href="#__codelineno-0-345">345</a></span>
<span class="normal"><a href="#__codelineno-0-346">346</a></span>
<span class="normal"><a href="#__codelineno-0-347">347</a></span>
<span class="normal"><a href="#__codelineno-0-348">348</a></span>
<span class="normal"><a href="#__codelineno-0-349">349</a></span>
<span class="normal"><a href="#__codelineno-0-350">350</a></span>
<span class="normal"><a href="#__codelineno-0-351">351</a></span>
<span class="normal"><a href="#__codelineno-0-352">352</a></span>
<span class="normal"><a href="#__codelineno-0-353">353</a></span>
<span class="normal"><a href="#__codelineno-0-354">354</a></span>
<span class="normal"><a href="#__codelineno-0-355">355</a></span>
<span class="normal"><a href="#__codelineno-0-356">356</a></span>
<span class="normal"><a href="#__codelineno-0-357">357</a></span>
<span class="normal"><a href="#__codelineno-0-358">358</a></span>
<span class="normal"><a href="#__codelineno-0-359">359</a></span>
<span class="normal"><a href="#__codelineno-0-360">360</a></span>
<span class="normal"><a href="#__codelineno-0-361">361</a></span>
<span class="normal"><a href="#__codelineno-0-362">362</a></span>
<span class="normal"><a href="#__codelineno-0-363">363</a></span>
<span class="normal"><a href="#__codelineno-0-364">364</a></span>
<span class="normal"><a href="#__codelineno-0-365">365</a></span>
<span class="normal"><a href="#__codelineno-0-366">366</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-342" name="__codelineno-0-342"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-343" name="__codelineno-0-343"></a><span class="k">def</span><span class="w"> </span><span class="nf">rates_range</span><span class="p">(</span>
<a id="__codelineno-0-344" name="__codelineno-0-344"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-345" name="__codelineno-0-345"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-346" name="__codelineno-0-346"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-347" name="__codelineno-0-347"></a> <span class="nb">int</span><span class="p">,</span>
<a id="__codelineno-0-348" name="__codelineno-0-348"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-349" name="__codelineno-0-349"></a> <span class="n">click_type</span><span class="o">=</span><span class="n">TIMEFRAME_TYPE</span><span class="p">,</span>
<a id="__codelineno-0-350" name="__codelineno-0-350"></a> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Timeframe.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-351" name="__codelineno-0-351"></a> <span class="p">),</span>
<a id="__codelineno-0-352" name="__codelineno-0-352"></a> <span class="p">],</span>
<a id="__codelineno-0-353" name="__codelineno-0-353"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-354" name="__codelineno-0-354"></a> <span class="n">datetime</span><span class="p">,</span>
<a id="__codelineno-0-355" name="__codelineno-0-355"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Start date.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-356" name="__codelineno-0-356"></a> <span class="p">],</span>
<a id="__codelineno-0-357" name="__codelineno-0-357"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-358" name="__codelineno-0-358"></a> <span class="n">datetime</span><span class="p">,</span>
<a id="__codelineno-0-359" name="__codelineno-0-359"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;End date.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-360" name="__codelineno-0-360"></a> <span class="p">],</span>
<a id="__codelineno-0-361" name="__codelineno-0-361"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-362" name="__codelineno-0-362"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export rates for a date range.&quot;&quot;&quot;</span>
<a id="__codelineno-0-363" name="__codelineno-0-363"></a> <span class="n">_export_command</span><span class="p">(</span>
<a id="__codelineno-0-364" name="__codelineno-0-364"></a> <span class="n">ctx</span><span class="p">,</span>
<a id="__codelineno-0-365" name="__codelineno-0-365"></a> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">copy_rates_range</span><span class="p">(</span><span class="n">symbol</span><span class="p">,</span> <span class="n">timeframe</span><span class="p">,</span> <span class="n">date_from</span><span class="p">,</span> <span class="n">date_to</span><span class="p">),</span>
<a id="__codelineno-0-366" name="__codelineno-0-366"></a> <span class="p">)</span>
2026-06-09 02:27:54 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="mt5cli.cli.recent_history_deals" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">recent_history_deals</span>
<a href="#mt5cli.cli.recent_history_deals" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">recent_history_deals</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">hours</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n"><span title="float">float</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Lookback window in hours.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="p">],</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
module-attribute
(mt5cli.utils.DATETIME_TYPE)" href="../utils/#mt5cli.utils.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Window end date.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="p">),</span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="n">group</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Group filter.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Symbol filter.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Export historical deals from a recent trailing window.</p>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-584">584</a></span>
<span class="normal"><a href="#__codelineno-0-585">585</a></span>
<span class="normal"><a href="#__codelineno-0-586">586</a></span>
<span class="normal"><a href="#__codelineno-0-587">587</a></span>
<span class="normal"><a href="#__codelineno-0-588">588</a></span>
<span class="normal"><a href="#__codelineno-0-589">589</a></span>
<span class="normal"><a href="#__codelineno-0-590">590</a></span>
<span class="normal"><a href="#__codelineno-0-591">591</a></span>
<span class="normal"><a href="#__codelineno-0-592">592</a></span>
<span class="normal"><a href="#__codelineno-0-593">593</a></span>
<span class="normal"><a href="#__codelineno-0-594">594</a></span>
<span class="normal"><a href="#__codelineno-0-595">595</a></span>
<span class="normal"><a href="#__codelineno-0-596">596</a></span>
<span class="normal"><a href="#__codelineno-0-597">597</a></span>
<span class="normal"><a href="#__codelineno-0-598">598</a></span>
<span class="normal"><a href="#__codelineno-0-599">599</a></span>
<span class="normal"><a href="#__codelineno-0-600">600</a></span>
<span class="normal"><a href="#__codelineno-0-601">601</a></span>
<span class="normal"><a href="#__codelineno-0-602">602</a></span>
<span class="normal"><a href="#__codelineno-0-603">603</a></span>
<span class="normal"><a href="#__codelineno-0-604">604</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-584" name="__codelineno-0-584"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-585" name="__codelineno-0-585"></a><span class="k">def</span><span class="w"> </span><span class="nf">recent_history_deals</span><span class="p">(</span>
<a id="__codelineno-0-586" name="__codelineno-0-586"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-587" name="__codelineno-0-587"></a> <span class="n">hours</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">float</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Lookback window in hours.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-588" name="__codelineno-0-588"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-589" name="__codelineno-0-589"></a> <span class="n">datetime</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-590" name="__codelineno-0-590"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Window end date.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-591" name="__codelineno-0-591"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-592" name="__codelineno-0-592"></a> <span class="n">group</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Group filter.&quot;</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-593" name="__codelineno-0-593"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Symbol filter.&quot;</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-594" name="__codelineno-0-594"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-595" name="__codelineno-0-595"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export historical deals from a recent trailing window.&quot;&quot;&quot;</span>
<a id="__codelineno-0-596" name="__codelineno-0-596"></a> <span class="n">_export_command</span><span class="p">(</span>
<a id="__codelineno-0-597" name="__codelineno-0-597"></a> <span class="n">ctx</span><span class="p">,</span>
<a id="__codelineno-0-598" name="__codelineno-0-598"></a> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">recent_history_deals</span><span class="p">(</span>
<a id="__codelineno-0-599" name="__codelineno-0-599"></a> <span class="n">hours</span><span class="p">,</span>
<a id="__codelineno-0-600" name="__codelineno-0-600"></a> <span class="n">date_to</span><span class="o">=</span><span class="n">date_to</span><span class="p">,</span>
<a id="__codelineno-0-601" name="__codelineno-0-601"></a> <span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span>
<a id="__codelineno-0-602" name="__codelineno-0-602"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
<a id="__codelineno-0-603" name="__codelineno-0-603"></a> <span class="p">),</span>
<a id="__codelineno-0-604" name="__codelineno-0-604"></a> <span class="p">)</span>
2026-04-22 17:11:38 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
2026-06-27 22:56:08 +00:00
<h3 id="mt5cli.cli.snapshot" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">snapshot</span>
<a href="#mt5cli.cli.snapshot" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">snapshot</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n"><span title="list">list</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="s2">&quot;--symbol&quot;</span><span class="p">,</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="s2">&quot;-s&quot;</span><span class="p">,</span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Symbol filter for positions/orders (repeat for multiple).&quot;</span><span class="p">,</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="p">),</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n">with_account</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n"><span title="bool">bool</span></span><span class="p">,</span>
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="s2">&quot;--with-account/--no-account&quot;</span><span class="p">,</span>
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Snapshot account info.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="p">),</span>
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> <span class="n">with_positions</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> <span class="n"><span title="bool">bool</span></span><span class="p">,</span>
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a> <span class="s2">&quot;--with-positions/--no-positions&quot;</span><span class="p">,</span>
<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Snapshot open positions.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a> <span class="p">),</span>
<a id="__codelineno-0-24" name="__codelineno-0-24" href="#__codelineno-0-24"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
<a id="__codelineno-0-25" name="__codelineno-0-25" href="#__codelineno-0-25"></a> <span class="n">with_orders</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-26" name="__codelineno-0-26" href="#__codelineno-0-26"></a> <span class="n"><span title="bool">bool</span></span><span class="p">,</span>
<a id="__codelineno-0-27" name="__codelineno-0-27" href="#__codelineno-0-27"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-28" name="__codelineno-0-28" href="#__codelineno-0-28"></a> <span class="s2">&quot;--with-orders/--no-orders&quot;</span><span class="p">,</span>
<a id="__codelineno-0-29" name="__codelineno-0-29" href="#__codelineno-0-29"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Snapshot active orders.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-30" name="__codelineno-0-30" href="#__codelineno-0-30"></a> <span class="p">),</span>
<a id="__codelineno-0-31" name="__codelineno-0-31" href="#__codelineno-0-31"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
<a id="__codelineno-0-32" name="__codelineno-0-32" href="#__codelineno-0-32"></a> <span class="n">with_terminal</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-33" name="__codelineno-0-33" href="#__codelineno-0-33"></a> <span class="n"><span title="bool">bool</span></span><span class="p">,</span>
<a id="__codelineno-0-34" name="__codelineno-0-34" href="#__codelineno-0-34"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-35" name="__codelineno-0-35" href="#__codelineno-0-35"></a> <span class="s2">&quot;--with-terminal/--no-terminal&quot;</span><span class="p">,</span>
<a id="__codelineno-0-36" name="__codelineno-0-36" href="#__codelineno-0-36"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Snapshot terminal info.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-37" name="__codelineno-0-37" href="#__codelineno-0-37"></a> <span class="p">),</span>
<a id="__codelineno-0-38" name="__codelineno-0-38" href="#__codelineno-0-38"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
<a id="__codelineno-0-39" name="__codelineno-0-39" href="#__codelineno-0-39"></a> <span class="n">with_grafana_schema</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-40" name="__codelineno-0-40" href="#__codelineno-0-40"></a> <span class="n"><span title="bool">bool</span></span><span class="p">,</span>
<a id="__codelineno-0-41" name="__codelineno-0-41" href="#__codelineno-0-41"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-42" name="__codelineno-0-42" href="#__codelineno-0-42"></a> <span class="s2">&quot;--with-grafana-schema/--no-grafana-schema&quot;</span><span class="p">,</span>
<a id="__codelineno-0-43" name="__codelineno-0-43" href="#__codelineno-0-43"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Ensure Grafana views and indexes exist.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-44" name="__codelineno-0-44" href="#__codelineno-0-44"></a> <span class="p">),</span>
<a id="__codelineno-0-45" name="__codelineno-0-45" href="#__codelineno-0-45"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
2026-06-28 08:14:55 +00:00
<a id="__codelineno-0-46" name="__codelineno-0-46" href="#__codelineno-0-46"></a> <span class="n">publish_copy</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-47" name="__codelineno-0-47" href="#__codelineno-0-47"></a> <span class="n"><span title="pathlib.Path">Path</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-48" name="__codelineno-0-48" href="#__codelineno-0-48"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-49" name="__codelineno-0-49" href="#__codelineno-0-49"></a> <span class="s2">&quot;--publish-copy&quot;</span><span class="p">,</span>
<a id="__codelineno-0-50" name="__codelineno-0-50" href="#__codelineno-0-50"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Publish a Grafana-ready SQLite copy to this path after snapshot.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-51" name="__codelineno-0-51" href="#__codelineno-0-51"></a> <span class="p">),</span>
<a id="__codelineno-0-52" name="__codelineno-0-52" href="#__codelineno-0-52"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-53" name="__codelineno-0-53" href="#__codelineno-0-53"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
2026-06-27 22:56:08 +00:00
</code></pre></div>
<div class="doc doc-contents ">
<p>Snapshot current account, position, order, and terminal state into SQLite.</p>
<p>Appends a timestamped snapshot row for each data type. Never places
orders or modifies trading state.</p>
<p><span class="doc-section-title">Raises:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code><span title="typer.BadParameter">BadParameter</span></code>
</td>
<td>
<div class="doc-md-description">
<p>If the output format is not SQLite3.</p>
</div>
</td>
</tr>
</tbody>
</table>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1006">1006</a></span>
<span class="normal"><a href="#__codelineno-0-1007">1007</a></span>
<span class="normal"><a href="#__codelineno-0-1008">1008</a></span>
<span class="normal"><a href="#__codelineno-0-1009">1009</a></span>
<span class="normal"><a href="#__codelineno-0-1010">1010</a></span>
<span class="normal"><a href="#__codelineno-0-1011">1011</a></span>
<span class="normal"><a href="#__codelineno-0-1012">1012</a></span>
<span class="normal"><a href="#__codelineno-0-1013">1013</a></span>
<span class="normal"><a href="#__codelineno-0-1014">1014</a></span>
<span class="normal"><a href="#__codelineno-0-1015">1015</a></span>
<span class="normal"><a href="#__codelineno-0-1016">1016</a></span>
<span class="normal"><a href="#__codelineno-0-1017">1017</a></span>
<span class="normal"><a href="#__codelineno-0-1018">1018</a></span>
<span class="normal"><a href="#__codelineno-0-1019">1019</a></span>
<span class="normal"><a href="#__codelineno-0-1020">1020</a></span>
<span class="normal"><a href="#__codelineno-0-1021">1021</a></span>
<span class="normal"><a href="#__codelineno-0-1022">1022</a></span>
<span class="normal"><a href="#__codelineno-0-1023">1023</a></span>
<span class="normal"><a href="#__codelineno-0-1024">1024</a></span>
<span class="normal"><a href="#__codelineno-0-1025">1025</a></span>
<span class="normal"><a href="#__codelineno-0-1026">1026</a></span>
<span class="normal"><a href="#__codelineno-0-1027">1027</a></span>
<span class="normal"><a href="#__codelineno-0-1028">1028</a></span>
<span class="normal"><a href="#__codelineno-0-1029">1029</a></span>
<span class="normal"><a href="#__codelineno-0-1030">1030</a></span>
<span class="normal"><a href="#__codelineno-0-1031">1031</a></span>
<span class="normal"><a href="#__codelineno-0-1032">1032</a></span>
<span class="normal"><a href="#__codelineno-0-1033">1033</a></span>
<span class="normal"><a href="#__codelineno-0-1034">1034</a></span>
<span class="normal"><a href="#__codelineno-0-1035">1035</a></span>
<span class="normal"><a href="#__codelineno-0-1036">1036</a></span>
<span class="normal"><a href="#__codelineno-0-1037">1037</a></span>
<span class="normal"><a href="#__codelineno-0-1038">1038</a></span>
<span class="normal"><a href="#__codelineno-0-1039">1039</a></span>
<span class="normal"><a href="#__codelineno-0-1040">1040</a></span>
<span class="normal"><a href="#__codelineno-0-1041">1041</a></span>
<span class="normal"><a href="#__codelineno-0-1042">1042</a></span>
<span class="normal"><a href="#__codelineno-0-1043">1043</a></span>
<span class="normal"><a href="#__codelineno-0-1044">1044</a></span>
<span class="normal"><a href="#__codelineno-0-1045">1045</a></span>
<span class="normal"><a href="#__codelineno-0-1046">1046</a></span>
<span class="normal"><a href="#__codelineno-0-1047">1047</a></span>
<span class="normal"><a href="#__codelineno-0-1048">1048</a></span>
<span class="normal"><a href="#__codelineno-0-1049">1049</a></span>
<span class="normal"><a href="#__codelineno-0-1050">1050</a></span>
<span class="normal"><a href="#__codelineno-0-1051">1051</a></span>
<span class="normal"><a href="#__codelineno-0-1052">1052</a></span>
<span class="normal"><a href="#__codelineno-0-1053">1053</a></span>
<span class="normal"><a href="#__codelineno-0-1054">1054</a></span>
<span class="normal"><a href="#__codelineno-0-1055">1055</a></span>
<span class="normal"><a href="#__codelineno-0-1056">1056</a></span>
<span class="normal"><a href="#__codelineno-0-1057">1057</a></span>
<span class="normal"><a href="#__codelineno-0-1058">1058</a></span>
<span class="normal"><a href="#__codelineno-0-1059">1059</a></span>
<span class="normal"><a href="#__codelineno-0-1060">1060</a></span>
<span class="normal"><a href="#__codelineno-0-1061">1061</a></span>
<span class="normal"><a href="#__codelineno-0-1062">1062</a></span>
<span class="normal"><a href="#__codelineno-0-1063">1063</a></span>
<span class="normal"><a href="#__codelineno-0-1064">1064</a></span>
<span class="normal"><a href="#__codelineno-0-1065">1065</a></span>
<span class="normal"><a href="#__codelineno-0-1066">1066</a></span>
<span class="normal"><a href="#__codelineno-0-1067">1067</a></span>
<span class="normal"><a href="#__codelineno-0-1068">1068</a></span>
<span class="normal"><a href="#__codelineno-0-1069">1069</a></span>
<span class="normal"><a href="#__codelineno-0-1070">1070</a></span>
<span class="normal"><a href="#__codelineno-0-1071">1071</a></span>
<span class="normal"><a href="#__codelineno-0-1072">1072</a></span>
<span class="normal"><a href="#__codelineno-0-1073">1073</a></span>
<span class="normal"><a href="#__codelineno-0-1074">1074</a></span>
<span class="normal"><a href="#__codelineno-0-1075">1075</a></span>
<span class="normal"><a href="#__codelineno-0-1076">1076</a></span>
<span class="normal"><a href="#__codelineno-0-1077">1077</a></span>
<span class="normal"><a href="#__codelineno-0-1078">1078</a></span>
<span class="normal"><a href="#__codelineno-0-1079">1079</a></span>
<span class="normal"><a href="#__codelineno-0-1080">1080</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-1006" name="__codelineno-0-1006"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Collection&quot;</span><span class="p">)</span>
<a id="__codelineno-0-1007" name="__codelineno-0-1007"></a><span class="k">def</span><span class="w"> </span><span class="nf">snapshot</span><span class="p">(</span>
<a id="__codelineno-0-1008" name="__codelineno-0-1008"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-1009" name="__codelineno-0-1009"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-1010" name="__codelineno-0-1010"></a> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-1011" name="__codelineno-0-1011"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-1012" name="__codelineno-0-1012"></a> <span class="s2">&quot;--symbol&quot;</span><span class="p">,</span>
<a id="__codelineno-0-1013" name="__codelineno-0-1013"></a> <span class="s2">&quot;-s&quot;</span><span class="p">,</span>
<a id="__codelineno-0-1014" name="__codelineno-0-1014"></a> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Symbol filter for positions/orders (repeat for multiple).&quot;</span><span class="p">,</span>
<a id="__codelineno-0-1015" name="__codelineno-0-1015"></a> <span class="p">),</span>
<a id="__codelineno-0-1016" name="__codelineno-0-1016"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-1017" name="__codelineno-0-1017"></a> <span class="n">with_account</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-1018" name="__codelineno-0-1018"></a> <span class="nb">bool</span><span class="p">,</span>
<a id="__codelineno-0-1019" name="__codelineno-0-1019"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="s2">&quot;--with-account/--no-account&quot;</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Snapshot account info.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-1020" name="__codelineno-0-1020"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
<a id="__codelineno-0-1021" name="__codelineno-0-1021"></a> <span class="n">with_positions</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-1022" name="__codelineno-0-1022"></a> <span class="nb">bool</span><span class="p">,</span>
<a id="__codelineno-0-1023" name="__codelineno-0-1023"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-1024" name="__codelineno-0-1024"></a> <span class="s2">&quot;--with-positions/--no-positions&quot;</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Snapshot open positions.&quot;</span>
<a id="__codelineno-0-1025" name="__codelineno-0-1025"></a> <span class="p">),</span>
<a id="__codelineno-0-1026" name="__codelineno-0-1026"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
<a id="__codelineno-0-1027" name="__codelineno-0-1027"></a> <span class="n">with_orders</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-1028" name="__codelineno-0-1028"></a> <span class="nb">bool</span><span class="p">,</span>
<a id="__codelineno-0-1029" name="__codelineno-0-1029"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="s2">&quot;--with-orders/--no-orders&quot;</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Snapshot active orders.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-1030" name="__codelineno-0-1030"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
<a id="__codelineno-0-1031" name="__codelineno-0-1031"></a> <span class="n">with_terminal</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-1032" name="__codelineno-0-1032"></a> <span class="nb">bool</span><span class="p">,</span>
<a id="__codelineno-0-1033" name="__codelineno-0-1033"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="s2">&quot;--with-terminal/--no-terminal&quot;</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Snapshot terminal info.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-1034" name="__codelineno-0-1034"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
<a id="__codelineno-0-1035" name="__codelineno-0-1035"></a> <span class="n">with_grafana_schema</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-1036" name="__codelineno-0-1036"></a> <span class="nb">bool</span><span class="p">,</span>
<a id="__codelineno-0-1037" name="__codelineno-0-1037"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-1038" name="__codelineno-0-1038"></a> <span class="s2">&quot;--with-grafana-schema/--no-grafana-schema&quot;</span><span class="p">,</span>
<a id="__codelineno-0-1039" name="__codelineno-0-1039"></a> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Ensure Grafana views and indexes exist.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-1040" name="__codelineno-0-1040"></a> <span class="p">),</span>
<a id="__codelineno-0-1041" name="__codelineno-0-1041"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
<a id="__codelineno-0-1042" name="__codelineno-0-1042"></a> <span class="n">publish_copy</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-1043" name="__codelineno-0-1043"></a> <span class="n">Path</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-1044" name="__codelineno-0-1044"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-1045" name="__codelineno-0-1045"></a> <span class="s2">&quot;--publish-copy&quot;</span><span class="p">,</span>
<a id="__codelineno-0-1046" name="__codelineno-0-1046"></a> <span class="n">help</span><span class="o">=</span><span class="p">(</span><span class="s2">&quot;Publish a Grafana-ready SQLite copy to this path after snapshot.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-1047" name="__codelineno-0-1047"></a> <span class="p">),</span>
<a id="__codelineno-0-1048" name="__codelineno-0-1048"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-1049" name="__codelineno-0-1049"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-1050" name="__codelineno-0-1050"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Snapshot current account, position, order, and terminal state into SQLite.</span>
<a id="__codelineno-0-1051" name="__codelineno-0-1051"></a>
<a id="__codelineno-0-1052" name="__codelineno-0-1052"></a><span class="sd"> Appends a timestamped snapshot row for each data type. Never places</span>
<a id="__codelineno-0-1053" name="__codelineno-0-1053"></a><span class="sd"> orders or modifies trading state.</span>
<a id="__codelineno-0-1054" name="__codelineno-0-1054"></a>
<a id="__codelineno-0-1055" name="__codelineno-0-1055"></a><span class="sd"> Raises:</span>
<a id="__codelineno-0-1056" name="__codelineno-0-1056"></a><span class="sd"> typer.BadParameter: If the output format is not SQLite3.</span>
<a id="__codelineno-0-1057" name="__codelineno-0-1057"></a><span class="sd"> &quot;&quot;&quot;</span>
<a id="__codelineno-0-1058" name="__codelineno-0-1058"></a> <span class="n">export_ctx</span> <span class="o">=</span> <span class="n">_get_export_context</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
<a id="__codelineno-0-1059" name="__codelineno-0-1059"></a> <span class="k">if</span> <span class="n">export_ctx</span><span class="o">.</span><span class="n">output_format</span> <span class="o">!=</span> <span class="s2">&quot;sqlite3&quot;</span><span class="p">:</span>
<a id="__codelineno-0-1060" name="__codelineno-0-1060"></a> <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
<a id="__codelineno-0-1061" name="__codelineno-0-1061"></a> <span class="s2">&quot;snapshot requires SQLite3 output.&quot;</span>
<a id="__codelineno-0-1062" name="__codelineno-0-1062"></a> <span class="s2">&quot; Use a .db/.sqlite/.sqlite3 extension or --format sqlite3.&quot;</span>
<a id="__codelineno-0-1063" name="__codelineno-0-1063"></a> <span class="p">)</span>
<a id="__codelineno-0-1064" name="__codelineno-0-1064"></a> <span class="k">raise</span> <span class="n">typer</span><span class="o">.</span><span class="n">BadParameter</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<a id="__codelineno-0-1065" name="__codelineno-0-1065"></a> <span class="n">sdk</span><span class="o">.</span><span class="n">update_observability_with_config</span><span class="p">(</span>
<a id="__codelineno-0-1066" name="__codelineno-0-1066"></a> <span class="n">output</span><span class="o">=</span><span class="n">export_ctx</span><span class="o">.</span><span class="n">output</span><span class="p">,</span>
<a id="__codelineno-0-1067" name="__codelineno-0-1067"></a> <span class="n">config</span><span class="o">=</span><span class="n">export_ctx</span><span class="o">.</span><span class="n">config</span><span class="p">,</span>
<a id="__codelineno-0-1068" name="__codelineno-0-1068"></a> <span class="n">symbols</span><span class="o">=</span><span class="nb">list</span><span class="p">(</span><span class="n">symbol</span><span class="p">)</span> <span class="k">if</span> <span class="n">symbol</span> <span class="k">else</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-1069" name="__codelineno-0-1069"></a> <span class="n">include_account</span><span class="o">=</span><span class="n">with_account</span><span class="p">,</span>
<a id="__codelineno-0-1070" name="__codelineno-0-1070"></a> <span class="n">include_positions</span><span class="o">=</span><span class="n">with_positions</span><span class="p">,</span>
<a id="__codelineno-0-1071" name="__codelineno-0-1071"></a> <span class="n">include_orders</span><span class="o">=</span><span class="n">with_orders</span><span class="p">,</span>
<a id="__codelineno-0-1072" name="__codelineno-0-1072"></a> <span class="n">include_terminal</span><span class="o">=</span><span class="n">with_terminal</span><span class="p">,</span>
<a id="__codelineno-0-1073" name="__codelineno-0-1073"></a> <span class="n">with_grafana_schema</span><span class="o">=</span><span class="n">with_grafana_schema</span><span class="p">,</span>
<a id="__codelineno-0-1074" name="__codelineno-0-1074"></a> <span class="p">)</span>
<a id="__codelineno-0-1075" name="__codelineno-0-1075"></a> <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Snapshot written to </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">export_ctx</span><span class="o">.</span><span class="n">output</span><span class="p">)</span>
<a id="__codelineno-0-1076" name="__codelineno-0-1076"></a> <span class="k">if</span> <span class="n">publish_copy</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-1077" name="__codelineno-0-1077"></a> <span class="kn">from</span><span class="w"> </span><span class="nn">.grafana</span><span class="w"> </span><span class="kn">import</span> <span class="n">publish_grafana_copy</span> <span class="c1"># noqa: PLC0415</span>
<a id="__codelineno-0-1078" name="__codelineno-0-1078"></a>
<a id="__codelineno-0-1079" name="__codelineno-0-1079"></a> <span class="n">publish_grafana_copy</span><span class="p">(</span><span class="n">export_ctx</span><span class="o">.</span><span class="n">output</span><span class="p">,</span> <span class="n">publish_copy</span><span class="p">)</span>
<a id="__codelineno-0-1080" name="__codelineno-0-1080"></a> <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Grafana copy published to </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">publish_copy</span><span class="p">)</span>
2026-06-27 22:56:08 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
2026-04-22 17:11:38 +00:00
<h3 id="mt5cli.cli.symbol_info" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">symbol_info</span>
<a href="#mt5cli.cli.symbol_info" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">symbol_info</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Export symbol details.</p>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-478">478</a></span>
<span class="normal"><a href="#__codelineno-0-479">479</a></span>
<span class="normal"><a href="#__codelineno-0-480">480</a></span>
<span class="normal"><a href="#__codelineno-0-481">481</a></span>
<span class="normal"><a href="#__codelineno-0-482">482</a></span>
<span class="normal"><a href="#__codelineno-0-483">483</a></span>
<span class="normal"><a href="#__codelineno-0-484">484</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-478" name="__codelineno-0-478"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-479" name="__codelineno-0-479"></a><span class="k">def</span><span class="w"> </span><span class="nf">symbol_info</span><span class="p">(</span>
<a id="__codelineno-0-480" name="__codelineno-0-480"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-481" name="__codelineno-0-481"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-482" name="__codelineno-0-482"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-483" name="__codelineno-0-483"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export symbol details.&quot;&quot;&quot;</span>
<a id="__codelineno-0-484" name="__codelineno-0-484"></a> <span class="n">_export_command</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">symbol_info</span><span class="p">(</span><span class="n">symbol</span><span class="p">))</span>
2026-04-26 12:50:38 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="mt5cli.cli.symbol_info_tick" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">symbol_info_tick</span>
<a href="#mt5cli.cli.symbol_info_tick" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">symbol_info_tick</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Export the last tick for a symbol.</p>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-625">625</a></span>
<span class="normal"><a href="#__codelineno-0-626">626</a></span>
<span class="normal"><a href="#__codelineno-0-627">627</a></span>
<span class="normal"><a href="#__codelineno-0-628">628</a></span>
<span class="normal"><a href="#__codelineno-0-629">629</a></span>
<span class="normal"><a href="#__codelineno-0-630">630</a></span>
<span class="normal"><a href="#__codelineno-0-631">631</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-625" name="__codelineno-0-625"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-626" name="__codelineno-0-626"></a><span class="k">def</span><span class="w"> </span><span class="nf">symbol_info_tick</span><span class="p">(</span>
<a id="__codelineno-0-627" name="__codelineno-0-627"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-628" name="__codelineno-0-628"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-629" name="__codelineno-0-629"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-630" name="__codelineno-0-630"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export the last tick for a symbol.&quot;&quot;&quot;</span>
<a id="__codelineno-0-631" name="__codelineno-0-631"></a> <span class="n">_export_command</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">symbol_info_tick</span><span class="p">(</span><span class="n">symbol</span><span class="p">))</span>
2026-04-22 17:11:38 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="mt5cli.cli.symbols" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">symbols</span>
<a href="#mt5cli.cli.symbols" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">symbols</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">group</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Symbol group filter (e.g., *USD*).&quot;</span><span class="p">),</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Export symbol list.</p>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-466">466</a></span>
<span class="normal"><a href="#__codelineno-0-467">467</a></span>
<span class="normal"><a href="#__codelineno-0-468">468</a></span>
<span class="normal"><a href="#__codelineno-0-469">469</a></span>
<span class="normal"><a href="#__codelineno-0-470">470</a></span>
<span class="normal"><a href="#__codelineno-0-471">471</a></span>
<span class="normal"><a href="#__codelineno-0-472">472</a></span>
<span class="normal"><a href="#__codelineno-0-473">473</a></span>
<span class="normal"><a href="#__codelineno-0-474">474</a></span>
<span class="normal"><a href="#__codelineno-0-475">475</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-466" name="__codelineno-0-466"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-467" name="__codelineno-0-467"></a><span class="k">def</span><span class="w"> </span><span class="nf">symbols</span><span class="p">(</span>
<a id="__codelineno-0-468" name="__codelineno-0-468"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-469" name="__codelineno-0-469"></a> <span class="n">group</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-470" name="__codelineno-0-470"></a> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-471" name="__codelineno-0-471"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Symbol group filter (e.g., *USD*).&quot;</span><span class="p">),</span>
<a id="__codelineno-0-472" name="__codelineno-0-472"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-473" name="__codelineno-0-473"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-474" name="__codelineno-0-474"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export symbol list.&quot;&quot;&quot;</span>
<a id="__codelineno-0-475" name="__codelineno-0-475"></a> <span class="n">_export_command</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">symbols</span><span class="p">(</span><span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">))</span>
2026-04-22 17:11:38 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="mt5cli.cli.terminal_info" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">terminal_info</span>
<a href="#mt5cli.cli.terminal_info" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">terminal_info</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Export terminal information.</p>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-460">460</a></span>
<span class="normal"><a href="#__codelineno-0-461">461</a></span>
<span class="normal"><a href="#__codelineno-0-462">462</a></span>
<span class="normal"><a href="#__codelineno-0-463">463</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-460" name="__codelineno-0-460"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-461" name="__codelineno-0-461"></a><span class="k">def</span><span class="w"> </span><span class="nf">terminal_info</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-462" name="__codelineno-0-462"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export terminal information.&quot;&quot;&quot;</span>
<a id="__codelineno-0-463" name="__codelineno-0-463"></a> <span class="n">_export_command</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">terminal_info</span><span class="p">())</span>
2026-04-22 17:11:38 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="mt5cli.cli.ticks_from" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">ticks_from</span>
<a href="#mt5cli.cli.ticks_from" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">ticks_from</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="datetime.datetime">datetime</span></span><span class="p">,</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
module-attribute
2026-06-08 13:55:22 +00:00
(mt5cli.utils.DATETIME_TYPE)" href="../utils/#mt5cli.utils.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Start date.&quot;</span>
2026-04-22 17:11:38 +00:00
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">),</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="p">],</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n">count</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="int">int</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Number of ticks.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n">flags</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span>
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="TICK_FLAGS_TYPE
module-attribute
2026-06-08 13:55:22 +00:00
(mt5cli.utils.TICK_FLAGS_TYPE)" href="../utils/#mt5cli.utils.TICK_FLAGS_TYPE">TICK_FLAGS_TYPE</a></span><span class="p">,</span>
2026-04-22 17:11:38 +00:00
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Tick flags (ALL, INFO, TRADE, or integer).&quot;</span><span class="p">,</span>
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="p">),</span>
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> <span class="p">],</span>
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Export ticks from a start date.</p>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-369">369</a></span>
<span class="normal"><a href="#__codelineno-0-370">370</a></span>
<span class="normal"><a href="#__codelineno-0-371">371</a></span>
<span class="normal"><a href="#__codelineno-0-372">372</a></span>
<span class="normal"><a href="#__codelineno-0-373">373</a></span>
<span class="normal"><a href="#__codelineno-0-374">374</a></span>
<span class="normal"><a href="#__codelineno-0-375">375</a></span>
<span class="normal"><a href="#__codelineno-0-376">376</a></span>
<span class="normal"><a href="#__codelineno-0-377">377</a></span>
<span class="normal"><a href="#__codelineno-0-378">378</a></span>
<span class="normal"><a href="#__codelineno-0-379">379</a></span>
<span class="normal"><a href="#__codelineno-0-380">380</a></span>
<span class="normal"><a href="#__codelineno-0-381">381</a></span>
<span class="normal"><a href="#__codelineno-0-382">382</a></span>
<span class="normal"><a href="#__codelineno-0-383">383</a></span>
<span class="normal"><a href="#__codelineno-0-384">384</a></span>
<span class="normal"><a href="#__codelineno-0-385">385</a></span>
<span class="normal"><a href="#__codelineno-0-386">386</a></span>
<span class="normal"><a href="#__codelineno-0-387">387</a></span>
<span class="normal"><a href="#__codelineno-0-388">388</a></span>
<span class="normal"><a href="#__codelineno-0-389">389</a></span>
<span class="normal"><a href="#__codelineno-0-390">390</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-369" name="__codelineno-0-369"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-370" name="__codelineno-0-370"></a><span class="k">def</span><span class="w"> </span><span class="nf">ticks_from</span><span class="p">(</span>
<a id="__codelineno-0-371" name="__codelineno-0-371"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-372" name="__codelineno-0-372"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-373" name="__codelineno-0-373"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-374" name="__codelineno-0-374"></a> <span class="n">datetime</span><span class="p">,</span>
<a id="__codelineno-0-375" name="__codelineno-0-375"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Start date.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-376" name="__codelineno-0-376"></a> <span class="p">],</span>
<a id="__codelineno-0-377" name="__codelineno-0-377"></a> <span class="n">count</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Number of ticks.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-378" name="__codelineno-0-378"></a> <span class="n">flags</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-379" name="__codelineno-0-379"></a> <span class="nb">int</span><span class="p">,</span>
<a id="__codelineno-0-380" name="__codelineno-0-380"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-381" name="__codelineno-0-381"></a> <span class="n">click_type</span><span class="o">=</span><span class="n">TICK_FLAGS_TYPE</span><span class="p">,</span>
<a id="__codelineno-0-382" name="__codelineno-0-382"></a> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Tick flags (ALL, INFO, TRADE, or integer).&quot;</span><span class="p">,</span>
<a id="__codelineno-0-383" name="__codelineno-0-383"></a> <span class="p">),</span>
<a id="__codelineno-0-384" name="__codelineno-0-384"></a> <span class="p">],</span>
<a id="__codelineno-0-385" name="__codelineno-0-385"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-386" name="__codelineno-0-386"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export ticks from a start date.&quot;&quot;&quot;</span>
<a id="__codelineno-0-387" name="__codelineno-0-387"></a> <span class="n">_export_command</span><span class="p">(</span>
<a id="__codelineno-0-388" name="__codelineno-0-388"></a> <span class="n">ctx</span><span class="p">,</span>
<a id="__codelineno-0-389" name="__codelineno-0-389"></a> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">copy_ticks_from</span><span class="p">(</span><span class="n">symbol</span><span class="p">,</span> <span class="n">date_from</span><span class="p">,</span> <span class="n">count</span><span class="p">,</span> <span class="n">flags</span><span class="p">),</span>
<a id="__codelineno-0-390" name="__codelineno-0-390"></a> <span class="p">)</span>
2026-04-22 17:11:38 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="mt5cli.cli.ticks_range" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">ticks_range</span>
<a href="#mt5cli.cli.ticks_range" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">ticks_range</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="datetime.datetime">datetime</span></span><span class="p">,</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
module-attribute
2026-06-08 13:55:22 +00:00
(mt5cli.utils.DATETIME_TYPE)" href="../utils/#mt5cli.utils.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Start date.&quot;</span>
2026-04-22 17:11:38 +00:00
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">),</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="p">],</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n"><span title="datetime.datetime">datetime</span></span><span class="p">,</span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
module-attribute
2026-06-08 13:55:22 +00:00
(mt5cli.utils.DATETIME_TYPE)" href="../utils/#mt5cli.utils.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;End date.&quot;</span><span class="p">),</span>
2026-04-22 17:11:38 +00:00
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="p">],</span>
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n">flags</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span>
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="TICK_FLAGS_TYPE
module-attribute
2026-06-08 13:55:22 +00:00
(mt5cli.utils.TICK_FLAGS_TYPE)" href="../utils/#mt5cli.utils.TICK_FLAGS_TYPE">TICK_FLAGS_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Tick flags.&quot;</span>
2026-04-22 17:11:38 +00:00
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> <span class="p">),</span>
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> <span class="p">],</span>
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Export ticks for a date range.</p>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-393">393</a></span>
<span class="normal"><a href="#__codelineno-0-394">394</a></span>
<span class="normal"><a href="#__codelineno-0-395">395</a></span>
<span class="normal"><a href="#__codelineno-0-396">396</a></span>
<span class="normal"><a href="#__codelineno-0-397">397</a></span>
<span class="normal"><a href="#__codelineno-0-398">398</a></span>
<span class="normal"><a href="#__codelineno-0-399">399</a></span>
<span class="normal"><a href="#__codelineno-0-400">400</a></span>
<span class="normal"><a href="#__codelineno-0-401">401</a></span>
<span class="normal"><a href="#__codelineno-0-402">402</a></span>
<span class="normal"><a href="#__codelineno-0-403">403</a></span>
<span class="normal"><a href="#__codelineno-0-404">404</a></span>
<span class="normal"><a href="#__codelineno-0-405">405</a></span>
<span class="normal"><a href="#__codelineno-0-406">406</a></span>
<span class="normal"><a href="#__codelineno-0-407">407</a></span>
<span class="normal"><a href="#__codelineno-0-408">408</a></span>
<span class="normal"><a href="#__codelineno-0-409">409</a></span>
<span class="normal"><a href="#__codelineno-0-410">410</a></span>
<span class="normal"><a href="#__codelineno-0-411">411</a></span>
<span class="normal"><a href="#__codelineno-0-412">412</a></span>
<span class="normal"><a href="#__codelineno-0-413">413</a></span>
<span class="normal"><a href="#__codelineno-0-414">414</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-393" name="__codelineno-0-393"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-394" name="__codelineno-0-394"></a><span class="k">def</span><span class="w"> </span><span class="nf">ticks_range</span><span class="p">(</span>
<a id="__codelineno-0-395" name="__codelineno-0-395"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-396" name="__codelineno-0-396"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-397" name="__codelineno-0-397"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-398" name="__codelineno-0-398"></a> <span class="n">datetime</span><span class="p">,</span>
<a id="__codelineno-0-399" name="__codelineno-0-399"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Start date.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-400" name="__codelineno-0-400"></a> <span class="p">],</span>
<a id="__codelineno-0-401" name="__codelineno-0-401"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-402" name="__codelineno-0-402"></a> <span class="n">datetime</span><span class="p">,</span>
<a id="__codelineno-0-403" name="__codelineno-0-403"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;End date.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-404" name="__codelineno-0-404"></a> <span class="p">],</span>
<a id="__codelineno-0-405" name="__codelineno-0-405"></a> <span class="n">flags</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-406" name="__codelineno-0-406"></a> <span class="nb">int</span><span class="p">,</span>
<a id="__codelineno-0-407" name="__codelineno-0-407"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">TICK_FLAGS_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Tick flags.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-408" name="__codelineno-0-408"></a> <span class="p">],</span>
<a id="__codelineno-0-409" name="__codelineno-0-409"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-410" name="__codelineno-0-410"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export ticks for a date range.&quot;&quot;&quot;</span>
<a id="__codelineno-0-411" name="__codelineno-0-411"></a> <span class="n">_export_command</span><span class="p">(</span>
<a id="__codelineno-0-412" name="__codelineno-0-412"></a> <span class="n">ctx</span><span class="p">,</span>
<a id="__codelineno-0-413" name="__codelineno-0-413"></a> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">copy_ticks_range</span><span class="p">(</span><span class="n">symbol</span><span class="p">,</span> <span class="n">date_from</span><span class="p">,</span> <span class="n">date_to</span><span class="p">,</span> <span class="n">flags</span><span class="p">),</span>
<a id="__codelineno-0-414" name="__codelineno-0-414"></a> <span class="p">)</span>
2026-04-26 12:50:38 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
2026-06-08 18:29:32 +00:00
<h3 id="mt5cli.cli.ticks_recent" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">ticks_recent</span>
<a href="#mt5cli.cli.ticks_recent" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">ticks_recent</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">seconds</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="float">float</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Lookback window in seconds.&quot;</span><span class="p">)</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="p">],</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
module-attribute
(mt5cli.utils.DATETIME_TYPE)" href="../utils/#mt5cli.utils.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Window end date.&quot;</span><span class="p">,</span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="p">),</span>
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n">count</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span>
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Maximum number of ticks to return.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> <span class="p">]</span> <span class="o">=</span> <span class="mi">10000</span><span class="p">,</span>
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> <span class="n">flags</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span>
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="TICK_FLAGS_TYPE
module-attribute
(mt5cli.utils.TICK_FLAGS_TYPE)" href="../utils/#mt5cli.utils.TICK_FLAGS_TYPE">TICK_FLAGS_TYPE</a></span><span class="p">,</span>
<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">&quot;Tick flags (ALL, INFO, TRADE, or integer).&quot;</span><span class="p">,</span>
<a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a> <span class="p">),</span>
2026-06-11 14:23:26 +00:00
<a id="__codelineno-0-24" name="__codelineno-0-24" href="#__codelineno-0-24"></a> <span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;ALL&quot;</span><span class="p">,</span>
2026-06-08 18:29:32 +00:00
<a id="__codelineno-0-25" name="__codelineno-0-25" href="#__codelineno-0-25"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Export ticks from a recent time window.</p>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-417">417</a></span>
<span class="normal"><a href="#__codelineno-0-418">418</a></span>
<span class="normal"><a href="#__codelineno-0-419">419</a></span>
<span class="normal"><a href="#__codelineno-0-420">420</a></span>
<span class="normal"><a href="#__codelineno-0-421">421</a></span>
<span class="normal"><a href="#__codelineno-0-422">422</a></span>
<span class="normal"><a href="#__codelineno-0-423">423</a></span>
<span class="normal"><a href="#__codelineno-0-424">424</a></span>
<span class="normal"><a href="#__codelineno-0-425">425</a></span>
<span class="normal"><a href="#__codelineno-0-426">426</a></span>
<span class="normal"><a href="#__codelineno-0-427">427</a></span>
<span class="normal"><a href="#__codelineno-0-428">428</a></span>
<span class="normal"><a href="#__codelineno-0-429">429</a></span>
<span class="normal"><a href="#__codelineno-0-430">430</a></span>
<span class="normal"><a href="#__codelineno-0-431">431</a></span>
<span class="normal"><a href="#__codelineno-0-432">432</a></span>
<span class="normal"><a href="#__codelineno-0-433">433</a></span>
<span class="normal"><a href="#__codelineno-0-434">434</a></span>
<span class="normal"><a href="#__codelineno-0-435">435</a></span>
<span class="normal"><a href="#__codelineno-0-436">436</a></span>
<span class="normal"><a href="#__codelineno-0-437">437</a></span>
<span class="normal"><a href="#__codelineno-0-438">438</a></span>
<span class="normal"><a href="#__codelineno-0-439">439</a></span>
<span class="normal"><a href="#__codelineno-0-440">440</a></span>
<span class="normal"><a href="#__codelineno-0-441">441</a></span>
<span class="normal"><a href="#__codelineno-0-442">442</a></span>
<span class="normal"><a href="#__codelineno-0-443">443</a></span>
<span class="normal"><a href="#__codelineno-0-444">444</a></span>
<span class="normal"><a href="#__codelineno-0-445">445</a></span>
<span class="normal"><a href="#__codelineno-0-446">446</a></span>
<span class="normal"><a href="#__codelineno-0-447">447</a></span>
<span class="normal"><a href="#__codelineno-0-448">448</a></span>
<span class="normal"><a href="#__codelineno-0-449">449</a></span>
<span class="normal"><a href="#__codelineno-0-450">450</a></span>
<span class="normal"><a href="#__codelineno-0-451">451</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-417" name="__codelineno-0-417"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-418" name="__codelineno-0-418"></a><span class="k">def</span><span class="w"> </span><span class="nf">ticks_recent</span><span class="p">(</span>
<a id="__codelineno-0-419" name="__codelineno-0-419"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
<a id="__codelineno-0-420" name="__codelineno-0-420"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Symbol name.&quot;</span><span class="p">)],</span>
<a id="__codelineno-0-421" name="__codelineno-0-421"></a> <span class="n">seconds</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-422" name="__codelineno-0-422"></a> <span class="nb">float</span><span class="p">,</span>
<a id="__codelineno-0-423" name="__codelineno-0-423"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Lookback window in seconds.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-424" name="__codelineno-0-424"></a> <span class="p">],</span>
<a id="__codelineno-0-425" name="__codelineno-0-425"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-426" name="__codelineno-0-426"></a> <span class="n">datetime</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-427" name="__codelineno-0-427"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Window end date.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-428" name="__codelineno-0-428"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-429" name="__codelineno-0-429"></a> <span class="n">count</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-430" name="__codelineno-0-430"></a> <span class="nb">int</span><span class="p">,</span>
<a id="__codelineno-0-431" name="__codelineno-0-431"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;Maximum number of ticks to return.&quot;</span><span class="p">),</span>
<a id="__codelineno-0-432" name="__codelineno-0-432"></a> <span class="p">]</span> <span class="o">=</span> <span class="mi">10000</span><span class="p">,</span>
<a id="__codelineno-0-433" name="__codelineno-0-433"></a> <span class="n">flags</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<a id="__codelineno-0-434" name="__codelineno-0-434"></a> <span class="nb">int</span><span class="p">,</span>
<a id="__codelineno-0-435" name="__codelineno-0-435"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<a id="__codelineno-0-436" name="__codelineno-0-436"></a> <span class="n">click_type</span><span class="o">=</span><span class="n">TICK_FLAGS_TYPE</span><span class="p">,</span>
<a id="__codelineno-0-437" name="__codelineno-0-437"></a> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Tick flags (ALL, INFO, TRADE, or integer).&quot;</span><span class="p">,</span>
<a id="__codelineno-0-438" name="__codelineno-0-438"></a> <span class="p">),</span>
<a id="__codelineno-0-439" name="__codelineno-0-439"></a> <span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;ALL&quot;</span><span class="p">,</span> <span class="c1"># pyright: ignore[reportArgumentType]</span>
<a id="__codelineno-0-440" name="__codelineno-0-440"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-441" name="__codelineno-0-441"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export ticks from a recent time window.&quot;&quot;&quot;</span>
<a id="__codelineno-0-442" name="__codelineno-0-442"></a> <span class="n">_export_command</span><span class="p">(</span>
<a id="__codelineno-0-443" name="__codelineno-0-443"></a> <span class="n">ctx</span><span class="p">,</span>
<a id="__codelineno-0-444" name="__codelineno-0-444"></a> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">recent_ticks</span><span class="p">(</span>
<a id="__codelineno-0-445" name="__codelineno-0-445"></a> <span class="n">symbol</span><span class="p">,</span>
<a id="__codelineno-0-446" name="__codelineno-0-446"></a> <span class="n">seconds</span><span class="p">,</span>
<a id="__codelineno-0-447" name="__codelineno-0-447"></a> <span class="n">date_to</span><span class="o">=</span><span class="n">date_to</span><span class="p">,</span>
<a id="__codelineno-0-448" name="__codelineno-0-448"></a> <span class="n">count</span><span class="o">=</span><span class="n">count</span><span class="p">,</span>
<a id="__codelineno-0-449" name="__codelineno-0-449"></a> <span class="n">flags</span><span class="o">=</span><span class="n">flags</span><span class="p">,</span>
<a id="__codelineno-0-450" name="__codelineno-0-450"></a> <span class="p">),</span>
<a id="__codelineno-0-451" name="__codelineno-0-451"></a> <span class="p">)</span>
2026-06-08 18:29:32 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<div class="doc doc-object doc-function">
2026-04-26 12:50:38 +00:00
<h3 id="mt5cli.cli.version" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">version</span>
<a href="#mt5cli.cli.version" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">version</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Export MetaTrader5 version information.</p>
<details class="mkdocstrings-source">
<summary>Source code in <code>mt5cli/cli.py</code></summary>
2026-07-04 05:20:25 +00:00
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-613">613</a></span>
<span class="normal"><a href="#__codelineno-0-614">614</a></span>
<span class="normal"><a href="#__codelineno-0-615">615</a></span>
<span class="normal"><a href="#__codelineno-0-616">616</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-613" name="__codelineno-0-613"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">rich_help_panel</span><span class="o">=</span><span class="s2">&quot;Data / Export&quot;</span><span class="p">)</span>
<a id="__codelineno-0-614" name="__codelineno-0-614"></a><span class="k">def</span><span class="w"> </span><span class="nf">version</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<a id="__codelineno-0-615" name="__codelineno-0-615"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Export MetaTrader5 version information.&quot;&quot;&quot;</span>
<a id="__codelineno-0-616" name="__codelineno-0-616"></a> <span class="n">_export_command</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">client</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">version</span><span class="p">())</span>
2026-04-22 17:11:38 +00:00
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
</div>
</div>
2026-05-24 16:49:15 +00:00
</div></div>
</div>
</div>
2026-04-22 17:11:38 +00:00
2026-05-24 16:49:15 +00:00
<footer class="col-md-12">
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script src="../../js/bootstrap.bundle.min.js"></script>
<script>
var base_url = "../..",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="../../js/base.js"></script>
<script src="../../search/main.js"></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
<div class="modal-dialog modal-lg">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="searchModalLabel">Search</h4>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
<p>From here you can search these documents. Enter your search terms below.</p>
<form>
<div class="form-group">
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
</div>
</form>
<div id="mkdocs-search-results" data-no-results-text="No results found"></div>
</div>
<div class="modal-footer">
2026-04-22 17:11:38 +00:00
</div>
</div>
</div>
2026-05-24 16:49:15 +00:00
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
<table class="table">
<thead>
<tr>
<th style="width: 20%;">Keys</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td class="help shortcut"><kbd>?</kbd></td>
<td>Open this help</td>
</tr>
<tr>
<td class="next shortcut"><kbd>n</kbd></td>
<td>Next page</td>
</tr>
<tr>
<td class="prev shortcut"><kbd>p</kbd></td>
<td>Previous page</td>
</tr>
<tr>
<td class="search shortcut"><kbd>s</kbd></td>
<td>Search</td>
</tr>
</tbody>
</table>
</div>
<div class="modal-footer">
</div>
</div>
2026-04-22 17:11:38 +00:00
</div>
2026-05-24 16:49:15 +00:00
</div>
</body>
</html>