dceoy
1982 lines
203 KiB
HTML
1982 lines
203 KiB
HTML
<!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">
|
|
|
|
<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>
|
|
|
|
<li>
|
|
<a href="./" class="dropdown-item active" aria-current="page">CLI</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../sdk/" class="dropdown-item">SDK</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../utils/" class="dropdown-item">Utils</a>
|
|
</li>
|
|
</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">
|
|
<a rel="prev" href="../" class="nav-link">
|
|
<i class="fa fa-arrow-left"></i> Previous
|
|
</a>
|
|
</li>
|
|
<li class="nav-item">
|
|
<a rel="next" href="../sdk/" class="nav-link">
|
|
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>
|
|
</div>
|
|
</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>
|
|
|
|
|
|
<div id="toc-collapse" class="navbar-collapse collapse card bg-body-tertiary">
|
|
<ul class="nav flex-column">
|
|
|
|
<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">
|
|
|
|
<h1 id="cli-module">CLI Module<a class="headerlink" href="#cli-module" title="Permanent link">¶</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">¶</a></h2>
|
|
|
|
<div class="doc doc-contents first">
|
|
|
|
<p>Command-line interface for MetaTrader 5 data export.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="mt5cli.cli.app" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">app</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.cli.app" class="headerlink" title="Permanent link">¶</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">"mt5cli"</span><span class="p">,</span>
|
|
<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">"Export MetaTrader5 data to CSV, JSON, Parquet, or SQLite3."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="p">)</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="mt5cli.cli.logger" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">logger</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.cli.logger" class="headerlink" title="Permanent link">¶</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>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.account_info" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">account_info</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.account_info" class="headerlink" title="Permanent link">¶</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">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export account information.</p>
|
|
|
|
|
|
<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-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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-303" name="__codelineno-0-303"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-304" name="__codelineno-0-304"></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">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-305" name="__codelineno-0-305"></a><span class="w"> </span><span class="sd">"""Export account information."""</span>
|
|
<a id="__codelineno-0-306" name="__codelineno-0-306"></a> <span class="n">_execute_export</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="n">_sdk_client</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span><span class="o">.</span><span class="n">account_info</span><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.collect_history" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">collect_history</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.collect_history" class="headerlink" title="Permanent link">¶</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">"--symbol"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="s2">"-s"</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">"Symbol to collect (repeat for multiple symbols)."</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
|
|
(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">"Start date."</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
|
|
|
|
|
|
|
|
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">"End date."</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">"--dataset"</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(help)">help</span></span><span class="o">=</span><span class="s2">"Dataset to include (repeat for multiple). Defaults to all: rates, ticks, history-orders, history-deals."</span><span class="p">,</span>
|
|
<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
|
|
|
|
|
|
|
|
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">"Rates timeframe (e.g., M1, H1, D1)."</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
|
|
|
|
|
|
|
|
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">"Tick copy flags (ALL, INFO, TRADE, or integer)."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-40" name="__codelineno-0-40" href="#__codelineno-0-40"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-41" name="__codelineno-0-41" href="#__codelineno-0-41"></a> <span class="p">]</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
|
|
<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">"--if-exists"</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">"Behavior when a target table already exists."</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
|
|
|
|
|
|
|
|
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">"--with-views"</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">"Add cash_events and positions_reconstructed SQLite views derived from history_deals."</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">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Collect historical datasets into a single SQLite database.</p>
|
|
<p>Tables written depend on <code>--dataset</code>: <code>rates</code>, <code>ticks</code>,
|
|
<code>history_orders</code>, <code>history_deals</code>. 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>
|
|
<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>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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>
|
|
<span class="normal"><a href="#__codelineno-0-522">522</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-523">523</a></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>
|
|
<span class="normal"><a href="#__codelineno-0-552">552</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-553">553</a></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>
|
|
<span class="normal"><a href="#__codelineno-0-582">582</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-583">583</a></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>
|
|
<span class="normal"><a href="#__codelineno-0-605">605</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-606">606</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-607">607</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-513" name="__codelineno-0-513"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-514" name="__codelineno-0-514"></a><span class="k">def</span><span class="w"> </span><span class="nf">collect_history</span><span class="p">(</span>
|
|
<a id="__codelineno-0-515" name="__codelineno-0-515"></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-516" name="__codelineno-0-516"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-517" name="__codelineno-0-517"></a> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span>
|
|
<a id="__codelineno-0-518" name="__codelineno-0-518"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
|
|
<a id="__codelineno-0-519" name="__codelineno-0-519"></a> <span class="s2">"--symbol"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-520" name="__codelineno-0-520"></a> <span class="s2">"-s"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-521" name="__codelineno-0-521"></a> <span class="n">help</span><span class="o">=</span><span class="s2">"Symbol to collect (repeat for multiple symbols)."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-522" name="__codelineno-0-522"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-523" name="__codelineno-0-523"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-524" name="__codelineno-0-524"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-525" name="__codelineno-0-525"></a> <span class="n">datetime</span><span class="p">,</span>
|
|
<a id="__codelineno-0-526" name="__codelineno-0-526"></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">"Start date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-527" name="__codelineno-0-527"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-528" name="__codelineno-0-528"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-529" name="__codelineno-0-529"></a> <span class="n">datetime</span><span class="p">,</span>
|
|
<a id="__codelineno-0-530" name="__codelineno-0-530"></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">"End date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-531" name="__codelineno-0-531"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-532" name="__codelineno-0-532"></a> <span class="n">dataset</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-533" name="__codelineno-0-533"></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-534" name="__codelineno-0-534"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
|
|
<a id="__codelineno-0-535" name="__codelineno-0-535"></a> <span class="s2">"--dataset"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-536" name="__codelineno-0-536"></a> <span class="n">help</span><span class="o">=</span><span class="p">(</span>
|
|
<a id="__codelineno-0-537" name="__codelineno-0-537"></a> <span class="s2">"Dataset to include (repeat for multiple)."</span>
|
|
<a id="__codelineno-0-538" name="__codelineno-0-538"></a> <span class="s2">" Defaults to all: rates, ticks, history-orders, history-deals."</span>
|
|
<a id="__codelineno-0-539" name="__codelineno-0-539"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-540" name="__codelineno-0-540"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-541" name="__codelineno-0-541"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-542" name="__codelineno-0-542"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-543" name="__codelineno-0-543"></a> <span class="nb">int</span><span class="p">,</span>
|
|
<a id="__codelineno-0-544" name="__codelineno-0-544"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
|
|
<a id="__codelineno-0-545" name="__codelineno-0-545"></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-546" name="__codelineno-0-546"></a> <span class="n">help</span><span class="o">=</span><span class="s2">"Rates timeframe (e.g., M1, H1, D1)."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-547" name="__codelineno-0-547"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-548" name="__codelineno-0-548"></a> <span class="p">]</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
|
|
<a id="__codelineno-0-549" name="__codelineno-0-549"></a> <span class="n">flags</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-550" name="__codelineno-0-550"></a> <span class="nb">int</span><span class="p">,</span>
|
|
<a id="__codelineno-0-551" name="__codelineno-0-551"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
|
|
<a id="__codelineno-0-552" name="__codelineno-0-552"></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-553" name="__codelineno-0-553"></a> <span class="n">help</span><span class="o">=</span><span class="s2">"Tick copy flags (ALL, INFO, TRADE, or integer)."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-554" name="__codelineno-0-554"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-555" name="__codelineno-0-555"></a> <span class="p">]</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
|
|
<a id="__codelineno-0-556" name="__codelineno-0-556"></a> <span class="n">if_exists</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-557" name="__codelineno-0-557"></a> <span class="n">IfExists</span><span class="p">,</span>
|
|
<a id="__codelineno-0-558" name="__codelineno-0-558"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
|
|
<a id="__codelineno-0-559" name="__codelineno-0-559"></a> <span class="s2">"--if-exists"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-560" name="__codelineno-0-560"></a> <span class="n">help</span><span class="o">=</span><span class="s2">"Behavior when a target table already exists."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-561" name="__codelineno-0-561"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-562" name="__codelineno-0-562"></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-563" name="__codelineno-0-563"></a> <span class="n">with_views</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-564" name="__codelineno-0-564"></a> <span class="nb">bool</span><span class="p">,</span>
|
|
<a id="__codelineno-0-565" name="__codelineno-0-565"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
|
|
<a id="__codelineno-0-566" name="__codelineno-0-566"></a> <span class="s2">"--with-views"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-567" name="__codelineno-0-567"></a> <span class="n">help</span><span class="o">=</span><span class="p">(</span>
|
|
<a id="__codelineno-0-568" name="__codelineno-0-568"></a> <span class="s2">"Add cash_events and positions_reconstructed SQLite views"</span>
|
|
<a id="__codelineno-0-569" name="__codelineno-0-569"></a> <span class="s2">" derived from history_deals."</span>
|
|
<a id="__codelineno-0-570" name="__codelineno-0-570"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-571" name="__codelineno-0-571"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-572" name="__codelineno-0-572"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<a id="__codelineno-0-573" name="__codelineno-0-573"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-574" name="__codelineno-0-574"></a><span class="w"> </span><span class="sd">"""Collect historical datasets into a single SQLite database.</span>
|
|
<a id="__codelineno-0-575" name="__codelineno-0-575"></a>
|
|
<a id="__codelineno-0-576" name="__codelineno-0-576"></a><span class="sd"> Tables written depend on ``--dataset``: ``rates``, ``ticks``,</span>
|
|
<a id="__codelineno-0-577" name="__codelineno-0-577"></a><span class="sd"> ``history_orders``, ``history_deals``. History datasets are fetched per</span>
|
|
<a id="__codelineno-0-578" name="__codelineno-0-578"></a><span class="sd"> symbol and concatenated. Rates rows carry the requested ``timeframe`` so</span>
|
|
<a id="__codelineno-0-579" name="__codelineno-0-579"></a><span class="sd"> appended runs at different timeframes remain distinguishable.</span>
|
|
<a id="__codelineno-0-580" name="__codelineno-0-580"></a>
|
|
<a id="__codelineno-0-581" name="__codelineno-0-581"></a><span class="sd"> With ``--with-views`` (requires the ``history-deals`` dataset), optional</span>
|
|
<a id="__codelineno-0-582" name="__codelineno-0-582"></a><span class="sd"> views ``cash_events`` and ``positions_reconstructed`` are derived from</span>
|
|
<a id="__codelineno-0-583" name="__codelineno-0-583"></a><span class="sd"> ``history_deals`` when the required columns are present.</span>
|
|
<a id="__codelineno-0-584" name="__codelineno-0-584"></a>
|
|
<a id="__codelineno-0-585" name="__codelineno-0-585"></a><span class="sd"> Raises:</span>
|
|
<a id="__codelineno-0-586" name="__codelineno-0-586"></a><span class="sd"> typer.BadParameter: If the output format is not SQLite3.</span>
|
|
<a id="__codelineno-0-587" name="__codelineno-0-587"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-588" name="__codelineno-0-588"></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-589" name="__codelineno-0-589"></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">"sqlite3"</span><span class="p">:</span>
|
|
<a id="__codelineno-0-590" name="__codelineno-0-590"></a> <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
|
|
<a id="__codelineno-0-591" name="__codelineno-0-591"></a> <span class="s2">"collect-history requires SQLite3 output."</span>
|
|
<a id="__codelineno-0-592" name="__codelineno-0-592"></a> <span class="s2">" Use a .db/.sqlite/.sqlite3 extension or --format sqlite3."</span>
|
|
<a id="__codelineno-0-593" name="__codelineno-0-593"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-594" name="__codelineno-0-594"></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-595" name="__codelineno-0-595"></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="k">else</span> <span class="nb">set</span><span class="p">(</span><span class="n">Dataset</span><span class="p">)</span>
|
|
<a id="__codelineno-0-596" name="__codelineno-0-596"></a> <span class="n">sdk</span><span class="o">.</span><span class="n">collect_history</span><span class="p">(</span>
|
|
<a id="__codelineno-0-597" name="__codelineno-0-597"></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-598" name="__codelineno-0-598"></a> <span class="n">symbols</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-599" name="__codelineno-0-599"></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-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">datasets</span><span class="o">=</span><span class="n">datasets</span><span class="p">,</span>
|
|
<a id="__codelineno-0-602" name="__codelineno-0-602"></a> <span class="n">timeframe</span><span class="o">=</span><span class="n">timeframe</span><span class="p">,</span>
|
|
<a id="__codelineno-0-603" name="__codelineno-0-603"></a> <span class="n">flags</span><span class="o">=</span><span class="n">flags</span><span class="p">,</span>
|
|
<a id="__codelineno-0-604" name="__codelineno-0-604"></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-605" name="__codelineno-0-605"></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-606" name="__codelineno-0-606"></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-607" name="__codelineno-0-607"></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_deals" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">history_deals</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.history_deals" class="headerlink" title="Permanent link">¶</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
|
|
|
|
|
|
|
|
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">"Start date."</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
|
|
|
|
|
|
|
|
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">"End date."</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">"Group filter."</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">"Symbol filter."</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">"Order ticket."</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">"Position ticket."</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">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export historical deals.</p>
|
|
|
|
|
|
<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-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>
|
|
<span class="normal"><a href="#__codelineno-0-415">415</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-416">416</a></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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-399" name="__codelineno-0-399"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-400" name="__codelineno-0-400"></a><span class="k">def</span><span class="w"> </span><span class="nf">history_deals</span><span class="p">(</span>
|
|
<a id="__codelineno-0-401" name="__codelineno-0-401"></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-402" name="__codelineno-0-402"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-403" name="__codelineno-0-403"></a> <span class="n">datetime</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-404" name="__codelineno-0-404"></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">"Start date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-405" name="__codelineno-0-405"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-406" name="__codelineno-0-406"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-407" name="__codelineno-0-407"></a> <span class="n">datetime</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-408" name="__codelineno-0-408"></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">"End date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-409" name="__codelineno-0-409"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-410" name="__codelineno-0-410"></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">"Group filter."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-411" name="__codelineno-0-411"></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">"Symbol filter."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-412" name="__codelineno-0-412"></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">"Order ticket."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-413" name="__codelineno-0-413"></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">"Position ticket."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-414" name="__codelineno-0-414"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-415" name="__codelineno-0-415"></a><span class="w"> </span><span class="sd">"""Export historical deals."""</span>
|
|
<a id="__codelineno-0-416" name="__codelineno-0-416"></a> <span class="n">client</span> <span class="o">=</span> <span class="n">_sdk_client</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
|
|
<a id="__codelineno-0-417" name="__codelineno-0-417"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-418" name="__codelineno-0-418"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-419" name="__codelineno-0-419"></a> <span class="k">lambda</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-420" name="__codelineno-0-420"></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-421" name="__codelineno-0-421"></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-422" name="__codelineno-0-422"></a> <span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span>
|
|
<a id="__codelineno-0-423" name="__codelineno-0-423"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-424" name="__codelineno-0-424"></a> <span class="n">ticket</span><span class="o">=</span><span class="n">ticket</span><span class="p">,</span>
|
|
<a id="__codelineno-0-425" name="__codelineno-0-425"></a> <span class="n">position</span><span class="o">=</span><span class="n">position</span><span class="p">,</span>
|
|
<a id="__codelineno-0-426" name="__codelineno-0-426"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-427" name="__codelineno-0-427"></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_orders" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">history_orders</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.history_orders" class="headerlink" title="Permanent link">¶</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
|
|
(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">"Start date."</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
|
|
|
|
|
|
|
|
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">"End date."</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">"Group filter."</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">"Symbol filter."</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">"Order ticket."</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">"Position ticket."</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">-></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>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-368">368</a></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>
|
|
<span class="normal"><a href="#__codelineno-0-391">391</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-392">392</a></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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-368" name="__codelineno-0-368"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-369" name="__codelineno-0-369"></a><span class="k">def</span><span class="w"> </span><span class="nf">history_orders</span><span class="p">(</span>
|
|
<a id="__codelineno-0-370" name="__codelineno-0-370"></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-371" name="__codelineno-0-371"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-372" name="__codelineno-0-372"></a> <span class="n">datetime</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-373" name="__codelineno-0-373"></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">"Start date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-374" name="__codelineno-0-374"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-375" name="__codelineno-0-375"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-376" name="__codelineno-0-376"></a> <span class="n">datetime</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-377" name="__codelineno-0-377"></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">"End date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-378" name="__codelineno-0-378"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-379" name="__codelineno-0-379"></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">"Group filter."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-380" name="__codelineno-0-380"></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">"Symbol filter."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-381" name="__codelineno-0-381"></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">"Order ticket."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-382" name="__codelineno-0-382"></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">"Position ticket."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-383" name="__codelineno-0-383"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-384" name="__codelineno-0-384"></a><span class="w"> </span><span class="sd">"""Export historical orders."""</span>
|
|
<a id="__codelineno-0-385" name="__codelineno-0-385"></a> <span class="n">client</span> <span class="o">=</span> <span class="n">_sdk_client</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
|
|
<a id="__codelineno-0-386" name="__codelineno-0-386"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-387" name="__codelineno-0-387"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-388" name="__codelineno-0-388"></a> <span class="k">lambda</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-389" name="__codelineno-0-389"></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-390" name="__codelineno-0-390"></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-391" name="__codelineno-0-391"></a> <span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span>
|
|
<a id="__codelineno-0-392" name="__codelineno-0-392"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-393" name="__codelineno-0-393"></a> <span class="n">ticket</span><span class="o">=</span><span class="n">ticket</span><span class="p">,</span>
|
|
<a id="__codelineno-0-394" name="__codelineno-0-394"></a> <span class="n">position</span><span class="o">=</span><span class="n">position</span><span class="p">,</span>
|
|
<a id="__codelineno-0-395" name="__codelineno-0-395"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-396" name="__codelineno-0-396"></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.last_error" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">last_error</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.last_error" class="headerlink" title="Permanent link">¶</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">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export the last error information.</p>
|
|
|
|
|
|
<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-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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-436" name="__codelineno-0-436"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-437" name="__codelineno-0-437"></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">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-438" name="__codelineno-0-438"></a><span class="w"> </span><span class="sd">"""Export the last error information."""</span>
|
|
<a id="__codelineno-0-439" name="__codelineno-0-439"></a> <span class="n">_execute_export</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="n">_sdk_client</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span><span class="o">.</span><span class="n">last_error</span><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.main" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">main</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.main" class="headerlink" title="Permanent link">¶</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">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Run the mt5cli CLI.</p>
|
|
|
|
|
|
<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-610">610</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-611">611</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-612">612</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-610" name="__codelineno-0-610"></a><span class="k">def</span><span class="w"> </span><span class="nf">main</span><span class="p">()</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-611" name="__codelineno-0-611"></a><span class="w"> </span><span class="sd">"""Run the mt5cli CLI."""</span>
|
|
<a id="__codelineno-0-612" name="__codelineno-0-612"></a> <span class="n">app</span><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.market_book" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">market_book</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.market_book" class="headerlink" title="Permanent link">¶</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">"Symbol name."</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">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export market depth (order book) for a symbol.</p>
|
|
|
|
|
|
<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-452">452</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-453">453</a></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>
|
|
<span class="normal"><a href="#__codelineno-0-458">458</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-459">459</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-452" name="__codelineno-0-452"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-453" name="__codelineno-0-453"></a><span class="k">def</span><span class="w"> </span><span class="nf">market_book</span><span class="p">(</span>
|
|
<a id="__codelineno-0-454" name="__codelineno-0-454"></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-455" name="__codelineno-0-455"></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">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-456" name="__codelineno-0-456"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-457" name="__codelineno-0-457"></a><span class="w"> </span><span class="sd">"""Export market depth (order book) for a symbol."""</span>
|
|
<a id="__codelineno-0-458" name="__codelineno-0-458"></a> <span class="n">client</span> <span class="o">=</span> <span class="n">_sdk_client</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
|
|
<a id="__codelineno-0-459" name="__codelineno-0-459"></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">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>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.order_check" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">order_check</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.order_check" class="headerlink" title="Permanent link">¶</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
|
|
|
|
|
|
|
|
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">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Check funds sufficiency for a trading operation.</p>
|
|
|
|
|
|
<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-462">462</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-463">463</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-464">464</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-465">465</a></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>
|
|
<span class="normal"><a href="#__codelineno-0-476">476</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-477">477</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-478">478</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-479">479</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-462" name="__codelineno-0-462"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-463" name="__codelineno-0-463"></a><span class="k">def</span><span class="w"> </span><span class="nf">order_check</span><span class="p">(</span>
|
|
<a id="__codelineno-0-464" name="__codelineno-0-464"></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-465" name="__codelineno-0-465"></a> <span class="n">request</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-466" name="__codelineno-0-466"></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-467" name="__codelineno-0-467"></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-468" name="__codelineno-0-468"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-469" name="__codelineno-0-469"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-470" name="__codelineno-0-470"></a><span class="w"> </span><span class="sd">"""Check funds sufficiency for a trading operation."""</span>
|
|
<a id="__codelineno-0-471" name="__codelineno-0-471"></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-472" name="__codelineno-0-472"></a>
|
|
<a id="__codelineno-0-473" name="__codelineno-0-473"></a> <span class="k">def</span><span class="w"> </span><span class="nf">_fetch</span><span class="p">()</span> <span class="o">-></span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">:</span>
|
|
<a id="__codelineno-0-474" name="__codelineno-0-474"></a> <span class="k">return</span> <span class="n">sdk</span><span class="o">.</span><span class="n">_run_with_client</span><span class="p">(</span> <span class="c1"># noqa: SLF001 # pyright: ignore[reportPrivateUsage]</span>
|
|
<a id="__codelineno-0-475" name="__codelineno-0-475"></a> <span class="n">export_ctx</span><span class="o">.</span><span class="n">config</span><span class="p">,</span>
|
|
<a id="__codelineno-0-476" name="__codelineno-0-476"></a> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">order_check_as_df</span><span class="p">(</span><span class="n">request</span><span class="o">=</span><span class="n">request</span><span class="p">),</span>
|
|
<a id="__codelineno-0-477" name="__codelineno-0-477"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-478" name="__codelineno-0-478"></a>
|
|
<a id="__codelineno-0-479" name="__codelineno-0-479"></a> <span class="n">_execute_export</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="n">_fetch</span><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.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">¶</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
|
|
|
|
|
|
|
|
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">"--yes"</span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Confirm the live trade request."</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">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Send a trading operation request to the trade server.</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 --yes is not provided.</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-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>
|
|
<span class="normal"><a href="#__codelineno-0-485">485</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-486">486</a></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>
|
|
<span class="normal"><a href="#__codelineno-0-494">494</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-495">495</a></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>
|
|
<span class="normal"><a href="#__codelineno-0-508">508</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-509">509</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-510">510</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-482" name="__codelineno-0-482"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-483" name="__codelineno-0-483"></a><span class="k">def</span><span class="w"> </span><span class="nf">order_send</span><span class="p">(</span>
|
|
<a id="__codelineno-0-484" name="__codelineno-0-484"></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-485" name="__codelineno-0-485"></a> <span class="n">request</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-486" name="__codelineno-0-486"></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-487" name="__codelineno-0-487"></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-488" name="__codelineno-0-488"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-489" name="__codelineno-0-489"></a> <span class="n">yes</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-490" name="__codelineno-0-490"></a> <span class="nb">bool</span><span class="p">,</span>
|
|
<a id="__codelineno-0-491" name="__codelineno-0-491"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="s2">"--yes"</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"Confirm the live trade request."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-492" name="__codelineno-0-492"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<a id="__codelineno-0-493" name="__codelineno-0-493"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-494" name="__codelineno-0-494"></a><span class="w"> </span><span class="sd">"""Send a trading operation request to the trade server.</span>
|
|
<a id="__codelineno-0-495" name="__codelineno-0-495"></a>
|
|
<a id="__codelineno-0-496" name="__codelineno-0-496"></a><span class="sd"> Raises:</span>
|
|
<a id="__codelineno-0-497" name="__codelineno-0-497"></a><span class="sd"> typer.BadParameter: If --yes is not provided.</span>
|
|
<a id="__codelineno-0-498" name="__codelineno-0-498"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-499" name="__codelineno-0-499"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">yes</span><span class="p">:</span>
|
|
<a id="__codelineno-0-500" name="__codelineno-0-500"></a> <span class="n">msg</span> <span class="o">=</span> <span class="s2">"Pass --yes to send a live trade request."</span>
|
|
<a id="__codelineno-0-501" name="__codelineno-0-501"></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">"--yes"</span><span class="p">)</span>
|
|
<a id="__codelineno-0-502" name="__codelineno-0-502"></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-503" name="__codelineno-0-503"></a>
|
|
<a id="__codelineno-0-504" name="__codelineno-0-504"></a> <span class="k">def</span><span class="w"> </span><span class="nf">_fetch</span><span class="p">()</span> <span class="o">-></span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">:</span>
|
|
<a id="__codelineno-0-505" name="__codelineno-0-505"></a> <span class="k">return</span> <span class="n">sdk</span><span class="o">.</span><span class="n">_run_with_client</span><span class="p">(</span> <span class="c1"># noqa: SLF001 # pyright: ignore[reportPrivateUsage]</span>
|
|
<a id="__codelineno-0-506" name="__codelineno-0-506"></a> <span class="n">export_ctx</span><span class="o">.</span><span class="n">config</span><span class="p">,</span>
|
|
<a id="__codelineno-0-507" name="__codelineno-0-507"></a> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">order_send_as_df</span><span class="p">(</span><span class="n">request</span><span class="o">=</span><span class="n">request</span><span class="p">),</span>
|
|
<a id="__codelineno-0-508" name="__codelineno-0-508"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-509" name="__codelineno-0-509"></a>
|
|
<a id="__codelineno-0-510" name="__codelineno-0-510"></a> <span class="n">_execute_export</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="n">_fetch</span><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.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">¶</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">"Symbol filter."</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">"Group filter."</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">"Ticket filter."</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">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export active orders.</p>
|
|
|
|
|
|
<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-338">338</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-339">339</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-340">340</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-341">341</a></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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-338" name="__codelineno-0-338"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-339" name="__codelineno-0-339"></a><span class="k">def</span><span class="w"> </span><span class="nf">orders</span><span class="p">(</span>
|
|
<a id="__codelineno-0-340" name="__codelineno-0-340"></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-341" name="__codelineno-0-341"></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">"Symbol filter."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-342" name="__codelineno-0-342"></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">"Group filter."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-343" name="__codelineno-0-343"></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">"Ticket filter."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-344" name="__codelineno-0-344"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-345" name="__codelineno-0-345"></a><span class="w"> </span><span class="sd">"""Export active orders."""</span>
|
|
<a id="__codelineno-0-346" name="__codelineno-0-346"></a> <span class="n">client</span> <span class="o">=</span> <span class="n">_sdk_client</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
|
|
<a id="__codelineno-0-347" name="__codelineno-0-347"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-348" name="__codelineno-0-348"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-349" name="__codelineno-0-349"></a> <span class="k">lambda</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-350" name="__codelineno-0-350"></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.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">¶</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">"Symbol filter."</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">"Group filter."</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">"Ticket filter."</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">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export open positions.</p>
|
|
|
|
|
|
<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-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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-353" name="__codelineno-0-353"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-354" name="__codelineno-0-354"></a><span class="k">def</span><span class="w"> </span><span class="nf">positions</span><span class="p">(</span>
|
|
<a id="__codelineno-0-355" name="__codelineno-0-355"></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-356" name="__codelineno-0-356"></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">"Symbol filter."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-357" name="__codelineno-0-357"></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">"Group filter."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-358" name="__codelineno-0-358"></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">"Ticket filter."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-359" name="__codelineno-0-359"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-360" name="__codelineno-0-360"></a><span class="w"> </span><span class="sd">"""Export open positions."""</span>
|
|
<a id="__codelineno-0-361" name="__codelineno-0-361"></a> <span class="n">client</span> <span class="o">=</span> <span class="n">_sdk_client</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
|
|
<a id="__codelineno-0-362" name="__codelineno-0-362"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-363" name="__codelineno-0-363"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-364" name="__codelineno-0-364"></a> <span class="k">lambda</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-365" name="__codelineno-0-365"></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.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">¶</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">"Symbol name."</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>
|
|
<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">"Timeframe (e.g., M1, H1, D1, or integer)."</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
|
|
(mt5cli.utils.DATETIME_TYPE)" href="../utils/#mt5cli.utils.DATETIME_TYPE">DATETIME_TYPE</a></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">"Start date in ISO 8601 format."</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">"Number of records."</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">-></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>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-175">175</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-176">176</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-177">177</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-178">178</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-179">179</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-180">180</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-181">181</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-182">182</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-183">183</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-184">184</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-185">185</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-186">186</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-187">187</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-188">188</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-189">189</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-190">190</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-191">191</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-192">192</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-193">193</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-194">194</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-195">195</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-196">196</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-197">197</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-198">198</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-199">199</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-200">200</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-175" name="__codelineno-0-175"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-176" name="__codelineno-0-176"></a><span class="k">def</span><span class="w"> </span><span class="nf">rates_from</span><span class="p">(</span>
|
|
<a id="__codelineno-0-177" name="__codelineno-0-177"></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-178" name="__codelineno-0-178"></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">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-179" name="__codelineno-0-179"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-180" name="__codelineno-0-180"></a> <span class="nb">int</span><span class="p">,</span>
|
|
<a id="__codelineno-0-181" name="__codelineno-0-181"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
|
|
<a id="__codelineno-0-182" name="__codelineno-0-182"></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-183" name="__codelineno-0-183"></a> <span class="n">help</span><span class="o">=</span><span class="s2">"Timeframe (e.g., M1, H1, D1, or integer)."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-184" name="__codelineno-0-184"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-185" name="__codelineno-0-185"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-186" name="__codelineno-0-186"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-187" name="__codelineno-0-187"></a> <span class="n">datetime</span><span class="p">,</span>
|
|
<a id="__codelineno-0-188" name="__codelineno-0-188"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
|
|
<a id="__codelineno-0-189" name="__codelineno-0-189"></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-190" name="__codelineno-0-190"></a> <span class="n">help</span><span class="o">=</span><span class="s2">"Start date in ISO 8601 format."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-191" name="__codelineno-0-191"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-192" name="__codelineno-0-192"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-193" name="__codelineno-0-193"></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">"Number of records."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-194" name="__codelineno-0-194"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-195" name="__codelineno-0-195"></a><span class="w"> </span><span class="sd">"""Export rates from a start date."""</span>
|
|
<a id="__codelineno-0-196" name="__codelineno-0-196"></a> <span class="n">client</span> <span class="o">=</span> <span class="n">_sdk_client</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
|
|
<a id="__codelineno-0-197" name="__codelineno-0-197"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-198" name="__codelineno-0-198"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-199" name="__codelineno-0-199"></a> <span class="k">lambda</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-200" name="__codelineno-0-200"></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.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">¶</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">"Symbol name."</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">"Timeframe."</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">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">"Start position (0 = current bar)."</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">"Number of records."</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">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>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-203">203</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-204">204</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-205">205</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-206">206</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-207">207</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-208">208</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-209">209</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-210">210</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-211">211</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-212">212</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-213">213</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-214">214</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-215">215</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-216">216</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-217">217</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-218">218</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-219">219</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-220">220</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-221">221</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-222">222</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-203" name="__codelineno-0-203"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-204" name="__codelineno-0-204"></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-205" name="__codelineno-0-205"></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-206" name="__codelineno-0-206"></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">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-207" name="__codelineno-0-207"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-208" name="__codelineno-0-208"></a> <span class="nb">int</span><span class="p">,</span>
|
|
<a id="__codelineno-0-209" name="__codelineno-0-209"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
|
|
<a id="__codelineno-0-210" name="__codelineno-0-210"></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-211" name="__codelineno-0-211"></a> <span class="n">help</span><span class="o">=</span><span class="s2">"Timeframe."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-212" name="__codelineno-0-212"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-213" name="__codelineno-0-213"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-214" name="__codelineno-0-214"></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">"Start position (0 = current bar)."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-215" name="__codelineno-0-215"></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">"Number of records."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-216" name="__codelineno-0-216"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-217" name="__codelineno-0-217"></a><span class="w"> </span><span class="sd">"""Export rates from a start position."""</span>
|
|
<a id="__codelineno-0-218" name="__codelineno-0-218"></a> <span class="n">client</span> <span class="o">=</span> <span class="n">_sdk_client</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
|
|
<a id="__codelineno-0-219" name="__codelineno-0-219"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-220" name="__codelineno-0-220"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-221" name="__codelineno-0-221"></a> <span class="k">lambda</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><span class="n">symbol</span><span class="p">,</span> <span class="n">timeframe</span><span class="p">,</span> <span class="n">start_pos</span><span class="p">,</span> <span class="n">count</span><span class="p">),</span>
|
|
<a id="__codelineno-0-222" name="__codelineno-0-222"></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.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">¶</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">"Symbol name."</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">"Timeframe."</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">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
|
|
(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">"Start date."</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>
|
|
<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
|
|
(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">"End date."</span><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">-></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>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-225">225</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-226">226</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-227">227</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-228">228</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-229">229</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-230">230</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-231">231</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-232">232</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-233">233</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-234">234</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-235">235</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-236">236</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-237">237</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-238">238</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-239">239</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-240">240</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-241">241</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-242">242</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-243">243</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-244">244</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-245">245</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-246">246</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-247">247</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-248">248</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-249">249</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-250">250</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-225" name="__codelineno-0-225"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-226" name="__codelineno-0-226"></a><span class="k">def</span><span class="w"> </span><span class="nf">rates_range</span><span class="p">(</span>
|
|
<a id="__codelineno-0-227" name="__codelineno-0-227"></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-228" name="__codelineno-0-228"></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">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-229" name="__codelineno-0-229"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-230" name="__codelineno-0-230"></a> <span class="nb">int</span><span class="p">,</span>
|
|
<a id="__codelineno-0-231" name="__codelineno-0-231"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
|
|
<a id="__codelineno-0-232" name="__codelineno-0-232"></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-233" name="__codelineno-0-233"></a> <span class="n">help</span><span class="o">=</span><span class="s2">"Timeframe."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-234" name="__codelineno-0-234"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-235" name="__codelineno-0-235"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-236" name="__codelineno-0-236"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-237" name="__codelineno-0-237"></a> <span class="n">datetime</span><span class="p">,</span>
|
|
<a id="__codelineno-0-238" name="__codelineno-0-238"></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">"Start date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-239" name="__codelineno-0-239"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-240" name="__codelineno-0-240"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-241" name="__codelineno-0-241"></a> <span class="n">datetime</span><span class="p">,</span>
|
|
<a id="__codelineno-0-242" name="__codelineno-0-242"></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">"End date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-243" name="__codelineno-0-243"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-244" name="__codelineno-0-244"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-245" name="__codelineno-0-245"></a><span class="w"> </span><span class="sd">"""Export rates for a date range."""</span>
|
|
<a id="__codelineno-0-246" name="__codelineno-0-246"></a> <span class="n">client</span> <span class="o">=</span> <span class="n">_sdk_client</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
|
|
<a id="__codelineno-0-247" name="__codelineno-0-247"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-248" name="__codelineno-0-248"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-249" name="__codelineno-0-249"></a> <span class="k">lambda</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-250" name="__codelineno-0-250"></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.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">¶</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">"Symbol name."</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">-></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>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-328" name="__codelineno-0-328"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-329" name="__codelineno-0-329"></a><span class="k">def</span><span class="w"> </span><span class="nf">symbol_info</span><span class="p">(</span>
|
|
<a id="__codelineno-0-330" name="__codelineno-0-330"></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-331" name="__codelineno-0-331"></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">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-332" name="__codelineno-0-332"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-333" name="__codelineno-0-333"></a><span class="w"> </span><span class="sd">"""Export symbol details."""</span>
|
|
<a id="__codelineno-0-334" name="__codelineno-0-334"></a> <span class="n">client</span> <span class="o">=</span> <span class="n">_sdk_client</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
|
|
<a id="__codelineno-0-335" name="__codelineno-0-335"></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">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>
|
|
</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">¶</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">"Symbol name."</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">-></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>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-442" name="__codelineno-0-442"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-443" name="__codelineno-0-443"></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-444" name="__codelineno-0-444"></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-445" name="__codelineno-0-445"></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">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-446" name="__codelineno-0-446"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-447" name="__codelineno-0-447"></a><span class="w"> </span><span class="sd">"""Export the last tick for a symbol."""</span>
|
|
<a id="__codelineno-0-448" name="__codelineno-0-448"></a> <span class="n">client</span> <span class="o">=</span> <span class="n">_sdk_client</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
|
|
<a id="__codelineno-0-449" name="__codelineno-0-449"></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">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>
|
|
</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">¶</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">"Symbol group filter (e.g., *USD*)."</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">-></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>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-315" name="__codelineno-0-315"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-316" name="__codelineno-0-316"></a><span class="k">def</span><span class="w"> </span><span class="nf">symbols</span><span class="p">(</span>
|
|
<a id="__codelineno-0-317" name="__codelineno-0-317"></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-318" name="__codelineno-0-318"></a> <span class="n">group</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-319" name="__codelineno-0-319"></a> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-320" name="__codelineno-0-320"></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">"Symbol group filter (e.g., *USD*)."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-321" name="__codelineno-0-321"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-322" name="__codelineno-0-322"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-323" name="__codelineno-0-323"></a><span class="w"> </span><span class="sd">"""Export symbol list."""</span>
|
|
<a id="__codelineno-0-324" name="__codelineno-0-324"></a> <span class="n">client</span> <span class="o">=</span> <span class="n">_sdk_client</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
|
|
<a id="__codelineno-0-325" name="__codelineno-0-325"></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">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>
|
|
</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">¶</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">-></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>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-309">309</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-310">310</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-311">311</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-312">312</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-309" name="__codelineno-0-309"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-310" name="__codelineno-0-310"></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">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-311" name="__codelineno-0-311"></a><span class="w"> </span><span class="sd">"""Export terminal information."""</span>
|
|
<a id="__codelineno-0-312" name="__codelineno-0-312"></a> <span class="n">_execute_export</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="n">_sdk_client</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span><span class="o">.</span><span class="n">terminal_info</span><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.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">¶</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">"Symbol name."</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
|
|
(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">"Start date."</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><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">"Number of ticks."</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
|
|
(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-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">"Tick flags (ALL, INFO, TRADE, or integer)."</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">-></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>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-253">253</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-254">254</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-255">255</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-256">256</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-257">257</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-258">258</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-259">259</a></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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-253" name="__codelineno-0-253"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-254" name="__codelineno-0-254"></a><span class="k">def</span><span class="w"> </span><span class="nf">ticks_from</span><span class="p">(</span>
|
|
<a id="__codelineno-0-255" name="__codelineno-0-255"></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-256" name="__codelineno-0-256"></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">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-257" name="__codelineno-0-257"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-258" name="__codelineno-0-258"></a> <span class="n">datetime</span><span class="p">,</span>
|
|
<a id="__codelineno-0-259" name="__codelineno-0-259"></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">"Start date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-260" name="__codelineno-0-260"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-261" name="__codelineno-0-261"></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">"Number of ticks."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-262" name="__codelineno-0-262"></a> <span class="n">flags</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-263" name="__codelineno-0-263"></a> <span class="nb">int</span><span class="p">,</span>
|
|
<a id="__codelineno-0-264" name="__codelineno-0-264"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
|
|
<a id="__codelineno-0-265" name="__codelineno-0-265"></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-266" name="__codelineno-0-266"></a> <span class="n">help</span><span class="o">=</span><span class="s2">"Tick flags (ALL, INFO, TRADE, or integer)."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-267" name="__codelineno-0-267"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-268" name="__codelineno-0-268"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-269" name="__codelineno-0-269"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-270" name="__codelineno-0-270"></a><span class="w"> </span><span class="sd">"""Export ticks from a start date."""</span>
|
|
<a id="__codelineno-0-271" name="__codelineno-0-271"></a> <span class="n">client</span> <span class="o">=</span> <span class="n">_sdk_client</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
|
|
<a id="__codelineno-0-272" name="__codelineno-0-272"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-273" name="__codelineno-0-273"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-274" name="__codelineno-0-274"></a> <span class="k">lambda</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-275" name="__codelineno-0-275"></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.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">¶</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">"Symbol name."</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
|
|
(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">"Start date."</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">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
|
|
(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">"End date."</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">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
|
|
(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">"Tick flags."</span>
|
|
<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">-></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>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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>
|
|
<span class="normal"><a href="#__codelineno-0-285">285</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-286">286</a></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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-278" name="__codelineno-0-278"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-279" name="__codelineno-0-279"></a><span class="k">def</span><span class="w"> </span><span class="nf">ticks_range</span><span class="p">(</span>
|
|
<a id="__codelineno-0-280" name="__codelineno-0-280"></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-281" name="__codelineno-0-281"></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">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-282" name="__codelineno-0-282"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-283" name="__codelineno-0-283"></a> <span class="n">datetime</span><span class="p">,</span>
|
|
<a id="__codelineno-0-284" name="__codelineno-0-284"></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">"Start date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-285" name="__codelineno-0-285"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-286" name="__codelineno-0-286"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-287" name="__codelineno-0-287"></a> <span class="n">datetime</span><span class="p">,</span>
|
|
<a id="__codelineno-0-288" name="__codelineno-0-288"></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">"End date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-289" name="__codelineno-0-289"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-290" name="__codelineno-0-290"></a> <span class="n">flags</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-291" name="__codelineno-0-291"></a> <span class="nb">int</span><span class="p">,</span>
|
|
<a id="__codelineno-0-292" name="__codelineno-0-292"></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">"Tick flags."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-293" name="__codelineno-0-293"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-294" name="__codelineno-0-294"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-295" name="__codelineno-0-295"></a><span class="w"> </span><span class="sd">"""Export ticks for a date range."""</span>
|
|
<a id="__codelineno-0-296" name="__codelineno-0-296"></a> <span class="n">client</span> <span class="o">=</span> <span class="n">_sdk_client</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
|
|
<a id="__codelineno-0-297" name="__codelineno-0-297"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-298" name="__codelineno-0-298"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-299" name="__codelineno-0-299"></a> <span class="k">lambda</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-300" name="__codelineno-0-300"></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.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">¶</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">-></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>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-430" name="__codelineno-0-430"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-431" name="__codelineno-0-431"></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">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-432" name="__codelineno-0-432"></a><span class="w"> </span><span class="sd">"""Export MetaTrader5 version information."""</span>
|
|
<a id="__codelineno-0-433" name="__codelineno-0-433"></a> <span class="n">_execute_export</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="n">_sdk_client</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span><span class="o">.</span><span class="n">version</span><span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div></div>
|
|
</div>
|
|
</div>
|
|
|
|
<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">
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</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>
|
|
</div>
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|