dceoy
3782 lines
321 KiB
HTML
3782 lines
321 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/sdk/">
|
|
<link rel="shortcut icon" href="../../img/favicon.ico">
|
|
<title>SDK - 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="../cli/" class="dropdown-item">CLI</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="./" class="dropdown-item active" aria-current="page">SDK</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../history/" class="dropdown-item">History Collection (SQLite)</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="../cli/" class="nav-link">
|
|
<i class="fa fa-arrow-left"></i> Previous
|
|
</a>
|
|
</li>
|
|
<li class="nav-item">
|
|
<a rel="next" href="../history/" 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/sdk.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="#sdk-module" class="nav-link">SDK Module</a>
|
|
<ul class="nav flex-column">
|
|
<li class="nav-item" data-bs-level="2"><a href="#mt5cli.sdk" class="nav-link">sdk</a>
|
|
<ul class="nav flex-column">
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div></div>
|
|
<div class="col-md-9" role="main">
|
|
|
|
<h1 id="sdk-module">SDK Module<a class="headerlink" href="#sdk-module" title="Permanent link">¶</a></h1>
|
|
|
|
|
|
<div class="doc doc-object doc-module">
|
|
|
|
|
|
|
|
<h2 id="mt5cli.sdk" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-module-name">mt5cli.sdk</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk" class="headerlink" title="Permanent link">¶</a></h2>
|
|
|
|
<div class="doc doc-contents first">
|
|
|
|
<p>Programmatic SDK for MetaTrader 5 data collection.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="mt5cli.sdk.T" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">T</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.sdk.T" 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">T</span> <span class="o">=</span> <span class="n"><span title="typing.TypeVar">TypeVar</span></span><span class="p">(</span><span class="s1">'T'</span><span class="p">)</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="mt5cli.sdk.__all__" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">__all__</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.sdk.__all__" 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">__all__</span> <span class="o">=</span> <span class="p">[</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="s2">"Mt5CliClient"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="s2">"account_info"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="s2">"build_config"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="s2">"collect_history"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="s2">"copy_rates_from"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="s2">"copy_rates_from_pos"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="s2">"copy_rates_range"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="s2">"copy_ticks_from"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="s2">"copy_ticks_range"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="s2">"history_deals"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="s2">"history_orders"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="s2">"last_error"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="s2">"market_book"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="s2">"minimum_margins"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="s2">"orders"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> <span class="s2">"positions"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> <span class="s2">"recent_ticks"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> <span class="s2">"symbol_info"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a> <span class="s2">"symbol_info_tick"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a> <span class="s2">"symbols"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a> <span class="s2">"terminal_info"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a> <span class="s2">"update_history"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-24" name="__codelineno-0-24" href="#__codelineno-0-24"></a> <span class="s2">"update_history_with_config"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-25" name="__codelineno-0-25" href="#__codelineno-0-25"></a> <span class="s2">"version"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-26" name="__codelineno-0-26" href="#__codelineno-0-26"></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.sdk.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.sdk.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-class">
|
|
|
|
|
|
|
|
<h3 id="mt5cli.sdk.Mt5CliClient" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-class-name">Mt5CliClient</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient" 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">Mt5CliClient</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">path</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">login</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</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">password</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</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">server</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</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="n">timeout</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</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="p">)</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
|
|
|
|
<p>Programmatic client for read-only MetaTrader 5 data access.</p>
|
|
|
|
<p>Initialize the SDK client.</p>
|
|
|
|
|
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>path</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="str">str</span> | None</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Path to MetaTrader5 terminal EXE file.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>login</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="int">int</span> | None</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Trading account login.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>password</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="str">str</span> | None</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Trading account password.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>server</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="str">str</span> | None</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Trading server name.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>timeout</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="int">int</span> | None</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Connection timeout in milliseconds.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>config</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="pdmt5.Mt5Config">Mt5Config</span> | None</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Optional pre-built <code>Mt5Config</code> (overrides other args).</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-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>
|
|
<span class="normal"><a href="#__codelineno-0-251">251</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-252">252</a></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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-236" name="__codelineno-0-236"></a><span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
|
|
<a id="__codelineno-0-237" name="__codelineno-0-237"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-238" name="__codelineno-0-238"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-239" name="__codelineno-0-239"></a> <span class="n">path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-240" name="__codelineno-0-240"></a> <span class="n">login</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-241" name="__codelineno-0-241"></a> <span class="n">password</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-242" name="__codelineno-0-242"></a> <span class="n">server</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-243" name="__codelineno-0-243"></a> <span class="n">timeout</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-244" name="__codelineno-0-244"></a> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</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="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-246" name="__codelineno-0-246"></a><span class="w"> </span><span class="sd">"""Initialize the SDK client.</span>
|
|
<a id="__codelineno-0-247" name="__codelineno-0-247"></a>
|
|
<a id="__codelineno-0-248" name="__codelineno-0-248"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-249" name="__codelineno-0-249"></a><span class="sd"> path: Path to MetaTrader5 terminal EXE file.</span>
|
|
<a id="__codelineno-0-250" name="__codelineno-0-250"></a><span class="sd"> login: Trading account login.</span>
|
|
<a id="__codelineno-0-251" name="__codelineno-0-251"></a><span class="sd"> password: Trading account password.</span>
|
|
<a id="__codelineno-0-252" name="__codelineno-0-252"></a><span class="sd"> server: Trading server name.</span>
|
|
<a id="__codelineno-0-253" name="__codelineno-0-253"></a><span class="sd"> timeout: Connection timeout in milliseconds.</span>
|
|
<a id="__codelineno-0-254" name="__codelineno-0-254"></a><span class="sd"> config: Optional pre-built ``Mt5Config`` (overrides other args).</span>
|
|
<a id="__codelineno-0-255" name="__codelineno-0-255"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-256" name="__codelineno-0-256"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_config</span> <span class="o">=</span> <span class="n">config</span> <span class="ow">or</span> <span class="n">build_config</span><span class="p">(</span>
|
|
<a id="__codelineno-0-257" name="__codelineno-0-257"></a> <span class="n">path</span><span class="o">=</span><span class="n">path</span><span class="p">,</span>
|
|
<a id="__codelineno-0-258" name="__codelineno-0-258"></a> <span class="n">login</span><span class="o">=</span><span class="n">login</span><span class="p">,</span>
|
|
<a id="__codelineno-0-259" name="__codelineno-0-259"></a> <span class="n">password</span><span class="o">=</span><span class="n">password</span><span class="p">,</span>
|
|
<a id="__codelineno-0-260" name="__codelineno-0-260"></a> <span class="n">server</span><span class="o">=</span><span class="n">server</span><span class="p">,</span>
|
|
<a id="__codelineno-0-261" name="__codelineno-0-261"></a> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span>
|
|
<a id="__codelineno-0-262" name="__codelineno-0-262"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-263" name="__codelineno-0-263"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">:</span> <span class="n">Mt5DataClient</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.config" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">config</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-property"><code>property</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.config" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return the underlying MT5 configuration.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.__enter__" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">__enter__</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.__enter__" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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">__enter__</span><span class="p">()</span> <span class="o">-></span> <span class="n"><span title="typing.Self">Self</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Open a persistent MT5 connection for multiple calls.</p>
|
|
|
|
|
|
<p><span class="doc-section-title">Returns:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code><span title="typing.Self">Self</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>This client instance.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-270">270</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-271">271</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-272">272</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-273">273</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-274">274</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-275">275</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-276">276</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-277">277</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-278">278</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-279">279</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-280">280</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-281">281</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-282">282</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-283">283</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-270" name="__codelineno-0-270"></a><span class="k">def</span><span class="w"> </span><span class="fm">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Self</span><span class="p">:</span>
|
|
<a id="__codelineno-0-271" name="__codelineno-0-271"></a><span class="w"> </span><span class="sd">"""Open a persistent MT5 connection for multiple calls.</span>
|
|
<a id="__codelineno-0-272" name="__codelineno-0-272"></a>
|
|
<a id="__codelineno-0-273" name="__codelineno-0-273"></a><span class="sd"> Returns:</span>
|
|
<a id="__codelineno-0-274" name="__codelineno-0-274"></a><span class="sd"> This client instance.</span>
|
|
<a id="__codelineno-0-275" name="__codelineno-0-275"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-276" name="__codelineno-0-276"></a> <span class="n">client</span> <span class="o">=</span> <span class="n">Mt5DataClient</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_config</span><span class="p">)</span>
|
|
<a id="__codelineno-0-277" name="__codelineno-0-277"></a> <span class="k">try</span><span class="p">:</span>
|
|
<a id="__codelineno-0-278" name="__codelineno-0-278"></a> <span class="n">client</span><span class="o">.</span><span class="n">initialize_and_login_mt5</span><span class="p">()</span>
|
|
<a id="__codelineno-0-279" name="__codelineno-0-279"></a> <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
|
|
<a id="__codelineno-0-280" name="__codelineno-0-280"></a> <span class="n">client</span><span class="o">.</span><span class="n">shutdown</span><span class="p">()</span>
|
|
<a id="__codelineno-0-281" name="__codelineno-0-281"></a> <span class="k">raise</span>
|
|
<a id="__codelineno-0-282" name="__codelineno-0-282"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
<a id="__codelineno-0-283" name="__codelineno-0-283"></a> <span class="k">return</span> <span class="bp">self</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.__exit__" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">__exit__</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.__exit__" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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">__exit__</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">exc_type</span><span class="p">:</span> <span class="n"><span title="type">type</span></span><span class="p">[</span><span class="n"><span title="BaseException">BaseException</span></span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">exc</span><span class="p">:</span> <span class="n"><span title="BaseException">BaseException</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">tb</span><span class="p">:</span> <span class="n"><span title="object">object</span></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>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Shut down the persistent MT5 connection.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-285" name="__codelineno-0-285"></a><span class="k">def</span><span class="w"> </span><span class="fm">__exit__</span><span class="p">(</span>
|
|
<a id="__codelineno-0-286" name="__codelineno-0-286"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-287" name="__codelineno-0-287"></a> <span class="n">exc_type</span><span class="p">:</span> <span class="nb">type</span><span class="p">[</span><span class="ne">BaseException</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-288" name="__codelineno-0-288"></a> <span class="n">exc</span><span class="p">:</span> <span class="ne">BaseException</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-289" name="__codelineno-0-289"></a> <span class="n">tb</span><span class="p">:</span> <span class="nb">object</span><span class="p">,</span>
|
|
<a id="__codelineno-0-290" name="__codelineno-0-290"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-291" name="__codelineno-0-291"></a><span class="w"> </span><span class="sd">"""Shut down the persistent MT5 connection."""</span>
|
|
<a id="__codelineno-0-292" name="__codelineno-0-292"></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-293" name="__codelineno-0-293"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">shutdown</span><span class="p">()</span>
|
|
<a id="__codelineno-0-294" name="__codelineno-0-294"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="kc">None</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.account_info" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">account_info</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.account_info" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return account information.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-397">397</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-398">398</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-399">399</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-397" name="__codelineno-0-397"></a><span class="k">def</span><span class="w"> </span><span class="nf">account_info</span><span class="p">(</span><span class="bp">self</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-398" name="__codelineno-0-398"></a><span class="w"> </span><span class="sd">"""Return account information."""</span>
|
|
<a id="__codelineno-0-399" name="__codelineno-0-399"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span><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">account_info_as_df</span><span class="p">())</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.copy_rates_from" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">copy_rates_from</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.copy_rates_from" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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">copy_rates_from</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></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="datetime.datetime">datetime</span></span> <span class="o">|</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">count</span><span class="p">:</span> <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="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return rates starting from a date.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-301">301</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-302">302</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-303">303</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-304">304</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-305">305</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-306">306</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-307">307</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-308">308</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-309">309</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-310">310</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-311">311</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-312">312</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-313">313</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-314">314</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-315">315</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-316">316</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-317">317</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-318">318</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-301" name="__codelineno-0-301"></a><span class="k">def</span><span class="w"> </span><span class="nf">copy_rates_from</span><span class="p">(</span>
|
|
<a id="__codelineno-0-302" name="__codelineno-0-302"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-303" name="__codelineno-0-303"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-304" name="__codelineno-0-304"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-305" name="__codelineno-0-305"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-306" name="__codelineno-0-306"></a> <span class="n">count</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
|
|
<a id="__codelineno-0-307" name="__codelineno-0-307"></a><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-308" name="__codelineno-0-308"></a><span class="w"> </span><span class="sd">"""Return rates starting from a date."""</span>
|
|
<a id="__codelineno-0-309" name="__codelineno-0-309"></a> <span class="n">tf</span> <span class="o">=</span> <span class="n">_coerce_timeframe</span><span class="p">(</span><span class="n">timeframe</span><span class="p">)</span>
|
|
<a id="__codelineno-0-310" name="__codelineno-0-310"></a> <span class="n">start</span> <span class="o">=</span> <span class="n">_require_datetime</span><span class="p">(</span><span class="n">date_from</span><span class="p">)</span>
|
|
<a id="__codelineno-0-311" name="__codelineno-0-311"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span>
|
|
<a id="__codelineno-0-312" name="__codelineno-0-312"></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">copy_rates_from_as_df</span><span class="p">(</span>
|
|
<a id="__codelineno-0-313" name="__codelineno-0-313"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-314" name="__codelineno-0-314"></a> <span class="n">timeframe</span><span class="o">=</span><span class="n">tf</span><span class="p">,</span>
|
|
<a id="__codelineno-0-315" name="__codelineno-0-315"></a> <span class="n">date_from</span><span class="o">=</span><span class="n">start</span><span class="p">,</span>
|
|
<a id="__codelineno-0-316" name="__codelineno-0-316"></a> <span class="n">count</span><span class="o">=</span><span class="n">count</span><span class="p">,</span>
|
|
<a id="__codelineno-0-317" name="__codelineno-0-317"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-318" name="__codelineno-0-318"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.copy_rates_from_pos" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">copy_rates_from_pos</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.copy_rates_from_pos" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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">copy_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">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">start_pos</span><span class="p">:</span> <span class="n"><span title="int">int</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">count</span><span class="p">:</span> <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="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return rates starting from a bar position.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-320">320</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-321">321</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-322">322</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-323">323</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-324">324</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-325">325</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-326">326</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-327">327</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-328">328</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-329">329</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-330">330</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-331">331</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-332">332</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-333">333</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-334">334</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-335">335</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-336">336</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-320" name="__codelineno-0-320"></a><span class="k">def</span><span class="w"> </span><span class="nf">copy_rates_from_pos</span><span class="p">(</span>
|
|
<a id="__codelineno-0-321" name="__codelineno-0-321"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-322" name="__codelineno-0-322"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-323" name="__codelineno-0-323"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-324" name="__codelineno-0-324"></a> <span class="n">start_pos</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
|
|
<a id="__codelineno-0-325" name="__codelineno-0-325"></a> <span class="n">count</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
|
|
<a id="__codelineno-0-326" name="__codelineno-0-326"></a><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-327" name="__codelineno-0-327"></a><span class="w"> </span><span class="sd">"""Return rates starting from a bar position."""</span>
|
|
<a id="__codelineno-0-328" name="__codelineno-0-328"></a> <span class="n">tf</span> <span class="o">=</span> <span class="n">_coerce_timeframe</span><span class="p">(</span><span class="n">timeframe</span><span class="p">)</span>
|
|
<a id="__codelineno-0-329" name="__codelineno-0-329"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span>
|
|
<a id="__codelineno-0-330" name="__codelineno-0-330"></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">copy_rates_from_pos_as_df</span><span class="p">(</span>
|
|
<a id="__codelineno-0-331" name="__codelineno-0-331"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-332" name="__codelineno-0-332"></a> <span class="n">timeframe</span><span class="o">=</span><span class="n">tf</span><span class="p">,</span>
|
|
<a id="__codelineno-0-333" name="__codelineno-0-333"></a> <span class="n">start_pos</span><span class="o">=</span><span class="n">start_pos</span><span class="p">,</span>
|
|
<a id="__codelineno-0-334" name="__codelineno-0-334"></a> <span class="n">count</span><span class="o">=</span><span class="n">count</span><span class="p">,</span>
|
|
<a id="__codelineno-0-335" name="__codelineno-0-335"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-336" name="__codelineno-0-336"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.copy_rates_range" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">copy_rates_range</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.copy_rates_range" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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">copy_rates_range</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></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="datetime.datetime">datetime</span></span> <span class="o">|</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">date_to</span><span class="p">:</span> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></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="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return rates for a date range.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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>
|
|
<span class="normal"><a href="#__codelineno-0-351">351</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-352">352</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-353">353</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-354">354</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-355">355</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-356">356</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-338" name="__codelineno-0-338"></a><span class="k">def</span><span class="w"> </span><span class="nf">copy_rates_range</span><span class="p">(</span>
|
|
<a id="__codelineno-0-339" name="__codelineno-0-339"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-340" name="__codelineno-0-340"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-341" name="__codelineno-0-341"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-342" name="__codelineno-0-342"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-343" name="__codelineno-0-343"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</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="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">:</span>
|
|
<a id="__codelineno-0-345" name="__codelineno-0-345"></a><span class="w"> </span><span class="sd">"""Return rates for a date range."""</span>
|
|
<a id="__codelineno-0-346" name="__codelineno-0-346"></a> <span class="n">tf</span> <span class="o">=</span> <span class="n">_coerce_timeframe</span><span class="p">(</span><span class="n">timeframe</span><span class="p">)</span>
|
|
<a id="__codelineno-0-347" name="__codelineno-0-347"></a> <span class="n">start</span> <span class="o">=</span> <span class="n">_require_datetime</span><span class="p">(</span><span class="n">date_from</span><span class="p">)</span>
|
|
<a id="__codelineno-0-348" name="__codelineno-0-348"></a> <span class="n">end</span> <span class="o">=</span> <span class="n">_require_datetime</span><span class="p">(</span><span class="n">date_to</span><span class="p">)</span>
|
|
<a id="__codelineno-0-349" name="__codelineno-0-349"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span>
|
|
<a id="__codelineno-0-350" name="__codelineno-0-350"></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">copy_rates_range_as_df</span><span class="p">(</span>
|
|
<a id="__codelineno-0-351" name="__codelineno-0-351"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-352" name="__codelineno-0-352"></a> <span class="n">timeframe</span><span class="o">=</span><span class="n">tf</span><span class="p">,</span>
|
|
<a id="__codelineno-0-353" name="__codelineno-0-353"></a> <span class="n">date_from</span><span class="o">=</span><span class="n">start</span><span class="p">,</span>
|
|
<a id="__codelineno-0-354" name="__codelineno-0-354"></a> <span class="n">date_to</span><span class="o">=</span><span class="n">end</span><span class="p">,</span>
|
|
<a id="__codelineno-0-355" name="__codelineno-0-355"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-356" name="__codelineno-0-356"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.copy_ticks_from" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">copy_ticks_from</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.copy_ticks_from" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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">copy_ticks_from</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</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="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">count</span><span class="p">:</span> <span class="n"><span title="int">int</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">flags</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></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="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return ticks starting from a date.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-358">358</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-359">359</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-360">360</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-361">361</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-362">362</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-363">363</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-364">364</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-365">365</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-366">366</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-367">367</a></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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-358" name="__codelineno-0-358"></a><span class="k">def</span><span class="w"> </span><span class="nf">copy_ticks_from</span><span class="p">(</span>
|
|
<a id="__codelineno-0-359" name="__codelineno-0-359"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-360" name="__codelineno-0-360"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-361" name="__codelineno-0-361"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-362" name="__codelineno-0-362"></a> <span class="n">count</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
|
|
<a id="__codelineno-0-363" name="__codelineno-0-363"></a> <span class="n">flags</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-364" name="__codelineno-0-364"></a><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-365" name="__codelineno-0-365"></a><span class="w"> </span><span class="sd">"""Return ticks starting from a date."""</span>
|
|
<a id="__codelineno-0-366" name="__codelineno-0-366"></a> <span class="n">start</span> <span class="o">=</span> <span class="n">_require_datetime</span><span class="p">(</span><span class="n">date_from</span><span class="p">)</span>
|
|
<a id="__codelineno-0-367" name="__codelineno-0-367"></a> <span class="n">tick_flags</span> <span class="o">=</span> <span class="n">_coerce_tick_flags</span><span class="p">(</span><span class="n">flags</span><span class="p">)</span>
|
|
<a id="__codelineno-0-368" name="__codelineno-0-368"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span>
|
|
<a id="__codelineno-0-369" name="__codelineno-0-369"></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">copy_ticks_from_as_df</span><span class="p">(</span>
|
|
<a id="__codelineno-0-370" name="__codelineno-0-370"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-371" name="__codelineno-0-371"></a> <span class="n">date_from</span><span class="o">=</span><span class="n">start</span><span class="p">,</span>
|
|
<a id="__codelineno-0-372" name="__codelineno-0-372"></a> <span class="n">count</span><span class="o">=</span><span class="n">count</span><span class="p">,</span>
|
|
<a id="__codelineno-0-373" name="__codelineno-0-373"></a> <span class="n">flags</span><span class="o">=</span><span class="n">tick_flags</span><span class="p">,</span>
|
|
<a id="__codelineno-0-374" name="__codelineno-0-374"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-375" name="__codelineno-0-375"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.copy_ticks_range" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">copy_ticks_range</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.copy_ticks_range" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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">copy_ticks_range</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</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="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</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">flags</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></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="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return ticks for a date range.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-377" name="__codelineno-0-377"></a><span class="k">def</span><span class="w"> </span><span class="nf">copy_ticks_range</span><span class="p">(</span>
|
|
<a id="__codelineno-0-378" name="__codelineno-0-378"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-379" name="__codelineno-0-379"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-380" name="__codelineno-0-380"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-381" name="__codelineno-0-381"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-382" name="__codelineno-0-382"></a> <span class="n">flags</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</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="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">:</span>
|
|
<a id="__codelineno-0-384" name="__codelineno-0-384"></a><span class="w"> </span><span class="sd">"""Return ticks for a date range."""</span>
|
|
<a id="__codelineno-0-385" name="__codelineno-0-385"></a> <span class="n">start</span> <span class="o">=</span> <span class="n">_require_datetime</span><span class="p">(</span><span class="n">date_from</span><span class="p">)</span>
|
|
<a id="__codelineno-0-386" name="__codelineno-0-386"></a> <span class="n">end</span> <span class="o">=</span> <span class="n">_require_datetime</span><span class="p">(</span><span class="n">date_to</span><span class="p">)</span>
|
|
<a id="__codelineno-0-387" name="__codelineno-0-387"></a> <span class="n">tick_flags</span> <span class="o">=</span> <span class="n">_coerce_tick_flags</span><span class="p">(</span><span class="n">flags</span><span class="p">)</span>
|
|
<a id="__codelineno-0-388" name="__codelineno-0-388"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span>
|
|
<a id="__codelineno-0-389" name="__codelineno-0-389"></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">copy_ticks_range_as_df</span><span class="p">(</span>
|
|
<a id="__codelineno-0-390" name="__codelineno-0-390"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-391" name="__codelineno-0-391"></a> <span class="n">date_from</span><span class="o">=</span><span class="n">start</span><span class="p">,</span>
|
|
<a id="__codelineno-0-392" name="__codelineno-0-392"></a> <span class="n">date_to</span><span class="o">=</span><span class="n">end</span><span class="p">,</span>
|
|
<a id="__codelineno-0-393" name="__codelineno-0-393"></a> <span class="n">flags</span><span class="o">=</span><span class="n">tick_flags</span><span class="p">,</span>
|
|
<a id="__codelineno-0-394" name="__codelineno-0-394"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-395" name="__codelineno-0-395"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.history_deals" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">history_deals</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.history_deals" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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">date_from</span><span class="p">:</span> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">group</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</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">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</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">ticket</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</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="n">position</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return historical deals.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-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>
|
|
<span class="normal"><a href="#__codelineno-0-480">480</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-481">481</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-482">482</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-483">483</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-484">484</a></span>
|
|
<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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-466" name="__codelineno-0-466"></a><span class="k">def</span><span class="w"> </span><span class="nf">history_deals</span><span class="p">(</span>
|
|
<a id="__codelineno-0-467" name="__codelineno-0-467"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-468" name="__codelineno-0-468"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-469" name="__codelineno-0-469"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</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="n">group</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-471" name="__codelineno-0-471"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-472" name="__codelineno-0-472"></a> <span class="n">ticket</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-473" name="__codelineno-0-473"></a> <span class="n">position</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-474" name="__codelineno-0-474"></a><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-475" name="__codelineno-0-475"></a><span class="w"> </span><span class="sd">"""Return historical deals."""</span>
|
|
<a id="__codelineno-0-476" name="__codelineno-0-476"></a> <span class="n">start</span> <span class="o">=</span> <span class="n">_coerce_datetime</span><span class="p">(</span><span class="n">date_from</span><span class="p">)</span>
|
|
<a id="__codelineno-0-477" name="__codelineno-0-477"></a> <span class="n">end</span> <span class="o">=</span> <span class="n">_coerce_datetime</span><span class="p">(</span><span class="n">date_to</span><span class="p">)</span>
|
|
<a id="__codelineno-0-478" name="__codelineno-0-478"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span>
|
|
<a id="__codelineno-0-479" name="__codelineno-0-479"></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">history_deals_get_as_df</span><span class="p">(</span>
|
|
<a id="__codelineno-0-480" name="__codelineno-0-480"></a> <span class="n">date_from</span><span class="o">=</span><span class="n">start</span><span class="p">,</span>
|
|
<a id="__codelineno-0-481" name="__codelineno-0-481"></a> <span class="n">date_to</span><span class="o">=</span><span class="n">end</span><span class="p">,</span>
|
|
<a id="__codelineno-0-482" name="__codelineno-0-482"></a> <span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span>
|
|
<a id="__codelineno-0-483" name="__codelineno-0-483"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-484" name="__codelineno-0-484"></a> <span class="n">ticket</span><span class="o">=</span><span class="n">ticket</span><span class="p">,</span>
|
|
<a id="__codelineno-0-485" name="__codelineno-0-485"></a> <span class="n">position</span><span class="o">=</span><span class="n">position</span><span class="p">,</span>
|
|
<a id="__codelineno-0-486" name="__codelineno-0-486"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-487" name="__codelineno-0-487"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.history_orders" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">history_orders</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.history_orders" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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">date_from</span><span class="p">:</span> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">group</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</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">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</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">ticket</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</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="n">position</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return historical orders.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-443">443</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-444">444</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-445">445</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-446">446</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-447">447</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-448">448</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-449">449</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-450">450</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-451">451</a></span>
|
|
<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>
|
|
<span class="normal"><a href="#__codelineno-0-460">460</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-461">461</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-462">462</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-463">463</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-464">464</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-443" name="__codelineno-0-443"></a><span class="k">def</span><span class="w"> </span><span class="nf">history_orders</span><span class="p">(</span>
|
|
<a id="__codelineno-0-444" name="__codelineno-0-444"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-445" name="__codelineno-0-445"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-446" name="__codelineno-0-446"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</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="n">group</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-448" name="__codelineno-0-448"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-449" name="__codelineno-0-449"></a> <span class="n">ticket</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-450" name="__codelineno-0-450"></a> <span class="n">position</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-451" name="__codelineno-0-451"></a><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-452" name="__codelineno-0-452"></a><span class="w"> </span><span class="sd">"""Return historical orders."""</span>
|
|
<a id="__codelineno-0-453" name="__codelineno-0-453"></a> <span class="n">start</span> <span class="o">=</span> <span class="n">_coerce_datetime</span><span class="p">(</span><span class="n">date_from</span><span class="p">)</span>
|
|
<a id="__codelineno-0-454" name="__codelineno-0-454"></a> <span class="n">end</span> <span class="o">=</span> <span class="n">_coerce_datetime</span><span class="p">(</span><span class="n">date_to</span><span class="p">)</span>
|
|
<a id="__codelineno-0-455" name="__codelineno-0-455"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span>
|
|
<a id="__codelineno-0-456" name="__codelineno-0-456"></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">history_orders_get_as_df</span><span class="p">(</span>
|
|
<a id="__codelineno-0-457" name="__codelineno-0-457"></a> <span class="n">date_from</span><span class="o">=</span><span class="n">start</span><span class="p">,</span>
|
|
<a id="__codelineno-0-458" name="__codelineno-0-458"></a> <span class="n">date_to</span><span class="o">=</span><span class="n">end</span><span class="p">,</span>
|
|
<a id="__codelineno-0-459" name="__codelineno-0-459"></a> <span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span>
|
|
<a id="__codelineno-0-460" name="__codelineno-0-460"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-461" name="__codelineno-0-461"></a> <span class="n">ticket</span><span class="o">=</span><span class="n">ticket</span><span class="p">,</span>
|
|
<a id="__codelineno-0-462" name="__codelineno-0-462"></a> <span class="n">position</span><span class="o">=</span><span class="n">position</span><span class="p">,</span>
|
|
<a id="__codelineno-0-463" name="__codelineno-0-463"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-464" name="__codelineno-0-464"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.last_error" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">last_error</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.last_error" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return the last error information.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-493" name="__codelineno-0-493"></a><span class="k">def</span><span class="w"> </span><span class="nf">last_error</span><span class="p">(</span><span class="bp">self</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-494" name="__codelineno-0-494"></a><span class="w"> </span><span class="sd">"""Return the last error information."""</span>
|
|
<a id="__codelineno-0-495" name="__codelineno-0-495"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span><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">last_error_as_df</span><span class="p">())</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.market_book" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">market_book</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.market_book" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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><span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return market depth for a symbol.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-501" name="__codelineno-0-501"></a><span class="k">def</span><span class="w"> </span><span class="nf">market_book</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</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-502" name="__codelineno-0-502"></a><span class="w"> </span><span class="sd">"""Return market depth for a symbol."""</span>
|
|
<a id="__codelineno-0-503" name="__codelineno-0-503"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span><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">market_book_get_as_df</span><span class="p">(</span><span class="n">symbol</span><span class="o">=</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">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.minimum_margins" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">minimum_margins</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.minimum_margins" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">minimum_margins</span><span class="p">(</span><span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return minimum-volume buy and sell margin requirements.</p>
|
|
|
|
|
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>symbol</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="str">str</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Symbol name.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<p><span class="doc-section-title">Returns:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code><span title="pandas.DataFrame">DataFrame</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>One-row DataFrame with columns <code>symbol</code>, <code>account_currency</code>,</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code><span title="pandas.DataFrame">DataFrame</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p><code>volume_min</code>, <code>buy_margin</code>, and <code>sell_margin</code>.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-544" name="__codelineno-0-544"></a><span class="k">def</span><span class="w"> </span><span class="nf">minimum_margins</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</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-545" name="__codelineno-0-545"></a><span class="w"> </span><span class="sd">"""Return minimum-volume buy and sell margin requirements.</span>
|
|
<a id="__codelineno-0-546" name="__codelineno-0-546"></a>
|
|
<a id="__codelineno-0-547" name="__codelineno-0-547"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-548" name="__codelineno-0-548"></a><span class="sd"> symbol: Symbol name.</span>
|
|
<a id="__codelineno-0-549" name="__codelineno-0-549"></a>
|
|
<a id="__codelineno-0-550" name="__codelineno-0-550"></a><span class="sd"> Returns:</span>
|
|
<a id="__codelineno-0-551" name="__codelineno-0-551"></a><span class="sd"> One-row DataFrame with columns ``symbol``, ``account_currency``,</span>
|
|
<a id="__codelineno-0-552" name="__codelineno-0-552"></a><span class="sd"> ``volume_min``, ``buy_margin``, and ``sell_margin``.</span>
|
|
<a id="__codelineno-0-553" name="__codelineno-0-553"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-554" name="__codelineno-0-554"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span><span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">_fetch_minimum_margins</span><span class="p">(</span><span class="n">c</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">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.orders" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">orders</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.orders" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</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="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</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="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return active orders.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-413" name="__codelineno-0-413"></a><span class="k">def</span><span class="w"> </span><span class="nf">orders</span><span class="p">(</span>
|
|
<a id="__codelineno-0-414" name="__codelineno-0-414"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-415" name="__codelineno-0-415"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-416" name="__codelineno-0-416"></a> <span class="n">group</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-417" name="__codelineno-0-417"></a> <span class="n">ticket</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-418" name="__codelineno-0-418"></a><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-419" name="__codelineno-0-419"></a><span class="w"> </span><span class="sd">"""Return active orders."""</span>
|
|
<a id="__codelineno-0-420" name="__codelineno-0-420"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span>
|
|
<a id="__codelineno-0-421" name="__codelineno-0-421"></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">orders_get_as_df</span><span class="p">(</span>
|
|
<a id="__codelineno-0-422" name="__codelineno-0-422"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-423" name="__codelineno-0-423"></a> <span class="n">group</span><span class="o">=</span><span class="n">group</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="p">),</span>
|
|
<a id="__codelineno-0-426" name="__codelineno-0-426"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.positions" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">positions</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.positions" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</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="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</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="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return open positions.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-428">428</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-429">429</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-430">430</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-431">431</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-432">432</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-433">433</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-434">434</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-435">435</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-436">436</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-437">437</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-438">438</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-439">439</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-440">440</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-441">441</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-428" name="__codelineno-0-428"></a><span class="k">def</span><span class="w"> </span><span class="nf">positions</span><span class="p">(</span>
|
|
<a id="__codelineno-0-429" name="__codelineno-0-429"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-430" name="__codelineno-0-430"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-431" name="__codelineno-0-431"></a> <span class="n">group</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</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="n">ticket</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-433" name="__codelineno-0-433"></a><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-434" name="__codelineno-0-434"></a><span class="w"> </span><span class="sd">"""Return open positions."""</span>
|
|
<a id="__codelineno-0-435" name="__codelineno-0-435"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span>
|
|
<a id="__codelineno-0-436" name="__codelineno-0-436"></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">positions_get_as_df</span><span class="p">(</span>
|
|
<a id="__codelineno-0-437" name="__codelineno-0-437"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-438" name="__codelineno-0-438"></a> <span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span>
|
|
<a id="__codelineno-0-439" name="__codelineno-0-439"></a> <span class="n">ticket</span><span class="o">=</span><span class="n">ticket</span><span class="p">,</span>
|
|
<a id="__codelineno-0-440" name="__codelineno-0-440"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-441" name="__codelineno-0-441"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.recent_ticks" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">recent_ticks</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.recent_ticks" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">recent_ticks</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">seconds</span><span class="p">:</span> <span class="n"><span title="float">float</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</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">count</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">=</span> <span class="mi">10000</span><span class="p">,</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">flags</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span> <span class="o">=</span> <span class="s2">"ALL"</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="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return ticks from a recent time window.</p>
|
|
|
|
|
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>symbol</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="str">str</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Symbol name.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>seconds</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="float">float</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Lookback window in seconds ending at <code>date_to</code>.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>date_to</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="datetime.datetime">datetime</span> | <span title="str">str</span> | None</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Window end time. When <code>None</code>, uses the latest
|
|
<code>symbol_info_tick().time</code> rather than wall-clock now.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>count</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="int">int</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Maximum ticks to return. Values <code><= 0</code> return the full
|
|
window without trimming. Positive values keep the most recent
|
|
ticks; when the window is sparse, <code>copy_ticks_from</code> avoids
|
|
fetching the entire range.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>10000</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>flags</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="int">int</span> | <span title="str">str</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Tick flags as <code>ALL</code>, <code>INFO</code>, <code>TRADE</code>, or an integer.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>'ALL'</code>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<p><span class="doc-section-title">Returns:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code><span title="pandas.DataFrame">DataFrame</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Tick DataFrame with MT5 tick columns such as <code>time</code>, <code>bid</code>,</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code><span title="pandas.DataFrame">DataFrame</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p><code>ask</code>, <code>last</code>, and <code>volume</code>.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-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>
|
|
<span class="normal"><a href="#__codelineno-0-511">511</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-512">512</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-513">513</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-514">514</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-515">515</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-516">516</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-517">517</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-518">518</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-519">519</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-520">520</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-521">521</a></span>
|
|
<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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-505" name="__codelineno-0-505"></a><span class="k">def</span><span class="w"> </span><span class="nf">recent_ticks</span><span class="p">(</span>
|
|
<a id="__codelineno-0-506" name="__codelineno-0-506"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-507" name="__codelineno-0-507"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-508" name="__codelineno-0-508"></a> <span class="n">seconds</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
|
|
<a id="__codelineno-0-509" name="__codelineno-0-509"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-510" name="__codelineno-0-510"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-511" name="__codelineno-0-511"></a> <span class="n">count</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">10000</span><span class="p">,</span>
|
|
<a id="__codelineno-0-512" name="__codelineno-0-512"></a> <span class="n">flags</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"ALL"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-513" name="__codelineno-0-513"></a><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-514" name="__codelineno-0-514"></a><span class="w"> </span><span class="sd">"""Return ticks from a recent time window.</span>
|
|
<a id="__codelineno-0-515" name="__codelineno-0-515"></a>
|
|
<a id="__codelineno-0-516" name="__codelineno-0-516"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-517" name="__codelineno-0-517"></a><span class="sd"> symbol: Symbol name.</span>
|
|
<a id="__codelineno-0-518" name="__codelineno-0-518"></a><span class="sd"> seconds: Lookback window in seconds ending at ``date_to``.</span>
|
|
<a id="__codelineno-0-519" name="__codelineno-0-519"></a><span class="sd"> date_to: Window end time. When ``None``, uses the latest</span>
|
|
<a id="__codelineno-0-520" name="__codelineno-0-520"></a><span class="sd"> ``symbol_info_tick().time`` rather than wall-clock now.</span>
|
|
<a id="__codelineno-0-521" name="__codelineno-0-521"></a><span class="sd"> count: Maximum ticks to return. Values ``<= 0`` return the full</span>
|
|
<a id="__codelineno-0-522" name="__codelineno-0-522"></a><span class="sd"> window without trimming. Positive values keep the most recent</span>
|
|
<a id="__codelineno-0-523" name="__codelineno-0-523"></a><span class="sd"> ticks; when the window is sparse, ``copy_ticks_from`` avoids</span>
|
|
<a id="__codelineno-0-524" name="__codelineno-0-524"></a><span class="sd"> fetching the entire range.</span>
|
|
<a id="__codelineno-0-525" name="__codelineno-0-525"></a><span class="sd"> flags: Tick flags as ``ALL``, ``INFO``, ``TRADE``, or an integer.</span>
|
|
<a id="__codelineno-0-526" name="__codelineno-0-526"></a>
|
|
<a id="__codelineno-0-527" name="__codelineno-0-527"></a><span class="sd"> Returns:</span>
|
|
<a id="__codelineno-0-528" name="__codelineno-0-528"></a><span class="sd"> Tick DataFrame with MT5 tick columns such as ``time``, ``bid``,</span>
|
|
<a id="__codelineno-0-529" name="__codelineno-0-529"></a><span class="sd"> ``ask``, ``last``, and ``volume``.</span>
|
|
<a id="__codelineno-0-530" name="__codelineno-0-530"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-531" name="__codelineno-0-531"></a> <span class="n">tick_flags</span> <span class="o">=</span> <span class="n">_coerce_tick_flags</span><span class="p">(</span><span class="n">flags</span><span class="p">)</span>
|
|
<a id="__codelineno-0-532" name="__codelineno-0-532"></a> <span class="n">end</span> <span class="o">=</span> <span class="n">_coerce_datetime</span><span class="p">(</span><span class="n">date_to</span><span class="p">)</span>
|
|
<a id="__codelineno-0-533" name="__codelineno-0-533"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span>
|
|
<a id="__codelineno-0-534" name="__codelineno-0-534"></a> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">_fetch_recent_ticks</span><span class="p">(</span>
|
|
<a id="__codelineno-0-535" name="__codelineno-0-535"></a> <span class="n">c</span><span class="p">,</span>
|
|
<a id="__codelineno-0-536" name="__codelineno-0-536"></a> <span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-537" name="__codelineno-0-537"></a> <span class="n">seconds</span><span class="p">,</span>
|
|
<a id="__codelineno-0-538" name="__codelineno-0-538"></a> <span class="n">end</span><span class="p">,</span>
|
|
<a id="__codelineno-0-539" name="__codelineno-0-539"></a> <span class="n">count</span><span class="p">,</span>
|
|
<a id="__codelineno-0-540" name="__codelineno-0-540"></a> <span class="n">tick_flags</span><span class="p">,</span>
|
|
<a id="__codelineno-0-541" name="__codelineno-0-541"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-542" name="__codelineno-0-542"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.symbol_info" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">symbol_info</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.symbol_info" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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><span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return details for one symbol.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-409" name="__codelineno-0-409"></a><span class="k">def</span><span class="w"> </span><span class="nf">symbol_info</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</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-410" name="__codelineno-0-410"></a><span class="w"> </span><span class="sd">"""Return details for one symbol."""</span>
|
|
<a id="__codelineno-0-411" name="__codelineno-0-411"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span><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">symbol_info_as_df</span><span class="p">(</span><span class="n">symbol</span><span class="o">=</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">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.symbol_info_tick" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">symbol_info_tick</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.symbol_info_tick" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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><span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return the last tick for a symbol.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-497" name="__codelineno-0-497"></a><span class="k">def</span><span class="w"> </span><span class="nf">symbol_info_tick</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</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-498" name="__codelineno-0-498"></a><span class="w"> </span><span class="sd">"""Return the last tick for a symbol."""</span>
|
|
<a id="__codelineno-0-499" name="__codelineno-0-499"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span><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">symbol_info_tick_as_df</span><span class="p">(</span><span class="n">symbol</span><span class="o">=</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">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.symbols" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">symbols</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.symbols" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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><span class="n">group</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return the symbol list.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-405" name="__codelineno-0-405"></a><span class="k">def</span><span class="w"> </span><span class="nf">symbols</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">group</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</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-406" name="__codelineno-0-406"></a><span class="w"> </span><span class="sd">"""Return the symbol list."""</span>
|
|
<a id="__codelineno-0-407" name="__codelineno-0-407"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span><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">symbols_get_as_df</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">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.terminal_info" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">terminal_info</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.terminal_info" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return terminal information.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-401" name="__codelineno-0-401"></a><span class="k">def</span><span class="w"> </span><span class="nf">terminal_info</span><span class="p">(</span><span class="bp">self</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-402" name="__codelineno-0-402"></a><span class="w"> </span><span class="sd">"""Return terminal information."""</span>
|
|
<a id="__codelineno-0-403" name="__codelineno-0-403"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span><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">terminal_info_as_df</span><span class="p">())</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="mt5cli.sdk.Mt5CliClient.version" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">version</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.Mt5CliClient.version" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return MetaTrader5 version information.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-489" name="__codelineno-0-489"></a><span class="k">def</span><span class="w"> </span><span class="nf">version</span><span class="p">(</span><span class="bp">self</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-490" name="__codelineno-0-490"></a><span class="w"> </span><span class="sd">"""Return MetaTrader5 version information."""</span>
|
|
<a id="__codelineno-0-491" name="__codelineno-0-491"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span><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">version_as_df</span><span class="p">())</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.sdk.account_info" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">account_info</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.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>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="o">*</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return account information.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-927">927</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-928">928</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-929">929</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-927" name="__codelineno-0-927"></a><span class="k">def</span><span class="w"> </span><span class="nf">account_info</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</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-928" name="__codelineno-0-928"></a><span class="w"> </span><span class="sd">"""Return account information."""</span>
|
|
<a id="__codelineno-0-929" name="__codelineno-0-929"></a> <span class="k">return</span> <span class="n">_make_client</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="n">config</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.sdk.build_config" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">build_config</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.build_config" 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">build_config</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">path</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">login</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</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">password</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</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">server</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</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="n">timeout</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Build an <code>Mt5Config</code> from optional connection parameters.</p>
|
|
|
|
|
|
<p><span class="doc-section-title">Returns:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code><span title="pdmt5.Mt5Config">Mt5Config</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Configured <code>Mt5Config</code> instance.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-176" name="__codelineno-0-176"></a><span class="k">def</span><span class="w"> </span><span class="nf">build_config</span><span class="p">(</span>
|
|
<a id="__codelineno-0-177" name="__codelineno-0-177"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-178" name="__codelineno-0-178"></a> <span class="n">path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-179" name="__codelineno-0-179"></a> <span class="n">login</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-180" name="__codelineno-0-180"></a> <span class="n">password</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-181" name="__codelineno-0-181"></a> <span class="n">server</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-182" name="__codelineno-0-182"></a> <span class="n">timeout</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-183" name="__codelineno-0-183"></a><span class="p">)</span> <span class="o">-></span> <span class="n">Mt5Config</span><span class="p">:</span>
|
|
<a id="__codelineno-0-184" name="__codelineno-0-184"></a><span class="w"> </span><span class="sd">"""Build an ``Mt5Config`` from optional connection parameters.</span>
|
|
<a id="__codelineno-0-185" name="__codelineno-0-185"></a>
|
|
<a id="__codelineno-0-186" name="__codelineno-0-186"></a><span class="sd"> Returns:</span>
|
|
<a id="__codelineno-0-187" name="__codelineno-0-187"></a><span class="sd"> Configured ``Mt5Config`` instance.</span>
|
|
<a id="__codelineno-0-188" name="__codelineno-0-188"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-189" name="__codelineno-0-189"></a> <span class="k">return</span> <span class="n">Mt5Config</span><span class="p">(</span>
|
|
<a id="__codelineno-0-190" name="__codelineno-0-190"></a> <span class="n">path</span><span class="o">=</span><span class="n">path</span><span class="p">,</span>
|
|
<a id="__codelineno-0-191" name="__codelineno-0-191"></a> <span class="n">login</span><span class="o">=</span><span class="n">login</span><span class="p">,</span>
|
|
<a id="__codelineno-0-192" name="__codelineno-0-192"></a> <span class="n">password</span><span class="o">=</span><span class="n">password</span><span class="p">,</span>
|
|
<a id="__codelineno-0-193" name="__codelineno-0-193"></a> <span class="n">server</span><span class="o">=</span><span class="n">server</span><span class="p">,</span>
|
|
<a id="__codelineno-0-194" name="__codelineno-0-194"></a> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span>
|
|
<a id="__codelineno-0-195" name="__codelineno-0-195"></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.sdk.collect_history" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">collect_history</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.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">output</span><span class="p">:</span> <span class="n"><span title="pathlib.Path">Path</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbols</span><span class="p">:</span> <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-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="datetime.datetime">datetime</span></span> <span class="o">|</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">date_to</span><span class="p">:</span> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">datasets</span><span class="p">:</span> <span class="n"><span title="set">set</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="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n">flags</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n">if_exists</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="IfExists (mt5cli.utils.IfExists)" href="../utils/#mt5cli.utils.IfExists">IfExists</a></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-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n">with_views</span><span class="p">:</span> <span class="n"><span title="bool">bool</span></span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</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="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><span class="doc-section-title">Parameters:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>output</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="pathlib.Path">Path</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>SQLite database path.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>symbols</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="list">list</span>[<span title="str">str</span>]</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Symbols to collect.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>date_from</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="datetime.datetime">datetime</span> | <span title="str">str</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Start date.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>date_to</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="datetime.datetime">datetime</span> | <span title="str">str</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>End date.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>datasets</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="set">set</span>[<a class="autorefs autorefs-internal" title="Dataset (mt5cli.utils.Dataset)" href="../utils/#mt5cli.utils.Dataset">Dataset</a>] | None</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Datasets to include (defaults to all).</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>timeframe</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="int">int</span> | <span title="str">str</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Rates timeframe as integer or name (e.g. <code>M1</code>).</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>1</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>flags</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="int">int</span> | <span title="str">str</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Tick copy flags as integer or name (e.g. <code>ALL</code>).</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>1</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>if_exists</code>
|
|
</td>
|
|
<td>
|
|
<code><a class="autorefs autorefs-internal" title="IfExists (mt5cli.utils.IfExists)" href="../utils/#mt5cli.utils.IfExists">IfExists</a></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Behavior when a target table already exists.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code><a class="autorefs autorefs-internal" title="FAIL
|
|
|
|
|
|
|
|
class-attribute
|
|
instance-attribute
|
|
(mt5cli.utils.IfExists.FAIL)" href="../utils/#mt5cli.utils.IfExists.FAIL">FAIL</a></code>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>with_views</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="bool">bool</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Create <code>cash_events</code> and <code>positions_reconstructed</code> views.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>False</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>config</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="pdmt5.Mt5Config">Mt5Config</span> | None</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>MT5 connection configuration.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-772">772</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-773">773</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-774">774</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-775">775</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-776">776</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-777">777</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-778">778</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-779">779</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-780">780</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-781">781</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-782">782</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-783">783</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-784">784</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-785">785</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-786">786</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-787">787</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-788">788</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-789">789</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-790">790</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-791">791</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-792">792</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-793">793</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-794">794</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-795">795</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-796">796</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-797">797</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-798">798</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-799">799</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-800">800</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-801">801</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-802">802</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-803">803</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-804">804</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-805">805</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-806">806</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-807">807</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-808">808</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-809">809</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-810">810</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-811">811</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-812">812</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-813">813</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-814">814</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-815">815</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-816">816</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-817">817</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-818">818</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-819">819</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-820">820</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-821">821</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-822">822</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-823">823</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-824">824</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-825">825</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-826">826</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-827">827</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-828">828</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-829">829</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-830">830</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-831">831</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-832">832</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-833">833</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-834">834</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-835">835</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-772" name="__codelineno-0-772"></a><span class="k">def</span><span class="w"> </span><span class="nf">collect_history</span><span class="p">(</span>
|
|
<a id="__codelineno-0-773" name="__codelineno-0-773"></a> <span class="n">output</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
|
|
<a id="__codelineno-0-774" name="__codelineno-0-774"></a> <span class="n">symbols</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span>
|
|
<a id="__codelineno-0-775" name="__codelineno-0-775"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-776" name="__codelineno-0-776"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-777" name="__codelineno-0-777"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-778" name="__codelineno-0-778"></a> <span class="n">datasets</span><span class="p">:</span> <span class="nb">set</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="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-779" name="__codelineno-0-779"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
|
|
<a id="__codelineno-0-780" name="__codelineno-0-780"></a> <span class="n">flags</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
|
|
<a id="__codelineno-0-781" name="__codelineno-0-781"></a> <span class="n">if_exists</span><span class="p">:</span> <span class="n">IfExists</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-782" name="__codelineno-0-782"></a> <span class="n">with_views</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<a id="__codelineno-0-783" name="__codelineno-0-783"></a> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-784" name="__codelineno-0-784"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-785" name="__codelineno-0-785"></a><span class="w"> </span><span class="sd">"""Collect historical datasets into a single SQLite database.</span>
|
|
<a id="__codelineno-0-786" name="__codelineno-0-786"></a>
|
|
<a id="__codelineno-0-787" name="__codelineno-0-787"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-788" name="__codelineno-0-788"></a><span class="sd"> output: SQLite database path.</span>
|
|
<a id="__codelineno-0-789" name="__codelineno-0-789"></a><span class="sd"> symbols: Symbols to collect.</span>
|
|
<a id="__codelineno-0-790" name="__codelineno-0-790"></a><span class="sd"> date_from: Start date.</span>
|
|
<a id="__codelineno-0-791" name="__codelineno-0-791"></a><span class="sd"> date_to: End date.</span>
|
|
<a id="__codelineno-0-792" name="__codelineno-0-792"></a><span class="sd"> datasets: Datasets to include (defaults to all).</span>
|
|
<a id="__codelineno-0-793" name="__codelineno-0-793"></a><span class="sd"> timeframe: Rates timeframe as integer or name (e.g. ``M1``).</span>
|
|
<a id="__codelineno-0-794" name="__codelineno-0-794"></a><span class="sd"> flags: Tick copy flags as integer or name (e.g. ``ALL``).</span>
|
|
<a id="__codelineno-0-795" name="__codelineno-0-795"></a><span class="sd"> if_exists: Behavior when a target table already exists.</span>
|
|
<a id="__codelineno-0-796" name="__codelineno-0-796"></a><span class="sd"> with_views: Create ``cash_events`` and ``positions_reconstructed`` views.</span>
|
|
<a id="__codelineno-0-797" name="__codelineno-0-797"></a><span class="sd"> config: MT5 connection configuration.</span>
|
|
<a id="__codelineno-0-798" name="__codelineno-0-798"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-799" name="__codelineno-0-799"></a> <span class="n">start</span> <span class="o">=</span> <span class="n">_require_datetime</span><span class="p">(</span><span class="n">date_from</span><span class="p">)</span>
|
|
<a id="__codelineno-0-800" name="__codelineno-0-800"></a> <span class="n">end</span> <span class="o">=</span> <span class="n">_require_datetime</span><span class="p">(</span><span class="n">date_to</span><span class="p">)</span>
|
|
<a id="__codelineno-0-801" name="__codelineno-0-801"></a> <span class="n">selected</span> <span class="o">=</span> <span class="n">datasets</span> <span class="k">if</span> <span class="n">datasets</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</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-802" name="__codelineno-0-802"></a> <span class="n">tf</span> <span class="o">=</span> <span class="n">_coerce_timeframe</span><span class="p">(</span><span class="n">timeframe</span><span class="p">)</span>
|
|
<a id="__codelineno-0-803" name="__codelineno-0-803"></a> <span class="n">tick_flags</span> <span class="o">=</span> <span class="n">_coerce_tick_flags</span><span class="p">(</span><span class="n">flags</span><span class="p">)</span>
|
|
<a id="__codelineno-0-804" name="__codelineno-0-804"></a> <span class="n">mt5_config</span> <span class="o">=</span> <span class="n">config</span> <span class="ow">or</span> <span class="n">build_config</span><span class="p">()</span>
|
|
<a id="__codelineno-0-805" name="__codelineno-0-805"></a> <span class="k">with</span> <span class="n">_connected_client</span><span class="p">(</span><span class="n">mt5_config</span><span class="p">)</span> <span class="k">as</span> <span class="n">client</span><span class="p">,</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">output</span><span class="p">)</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
|
|
<a id="__codelineno-0-806" name="__codelineno-0-806"></a> <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"PRAGMA journal_mode=WAL"</span><span class="p">)</span>
|
|
<a id="__codelineno-0-807" name="__codelineno-0-807"></a> <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"PRAGMA synchronous=NORMAL"</span><span class="p">)</span>
|
|
<a id="__codelineno-0-808" name="__codelineno-0-808"></a> <span class="n">written_tables</span><span class="p">,</span> <span class="n">written_columns</span> <span class="o">=</span> <span class="n">write_collected_datasets</span><span class="p">(</span>
|
|
<a id="__codelineno-0-809" name="__codelineno-0-809"></a> <span class="n">conn</span><span class="p">,</span>
|
|
<a id="__codelineno-0-810" name="__codelineno-0-810"></a> <span class="n">client</span><span class="p">,</span>
|
|
<a id="__codelineno-0-811" name="__codelineno-0-811"></a> <span class="n">symbols</span><span class="p">,</span>
|
|
<a id="__codelineno-0-812" name="__codelineno-0-812"></a> <span class="n">selected</span><span class="p">,</span>
|
|
<a id="__codelineno-0-813" name="__codelineno-0-813"></a> <span class="n">tf</span><span class="p">,</span>
|
|
<a id="__codelineno-0-814" name="__codelineno-0-814"></a> <span class="n">tick_flags</span><span class="p">,</span>
|
|
<a id="__codelineno-0-815" name="__codelineno-0-815"></a> <span class="n">start</span><span class="p">,</span>
|
|
<a id="__codelineno-0-816" name="__codelineno-0-816"></a> <span class="n">end</span><span class="p">,</span>
|
|
<a id="__codelineno-0-817" name="__codelineno-0-817"></a> <span class="n">if_exists</span><span class="p">,</span>
|
|
<a id="__codelineno-0-818" name="__codelineno-0-818"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-819" name="__codelineno-0-819"></a> <span class="n">create_history_indexes</span><span class="p">(</span><span class="n">conn</span><span class="p">,</span> <span class="n">written_columns</span><span class="p">)</span>
|
|
<a id="__codelineno-0-820" name="__codelineno-0-820"></a> <span class="k">if</span> <span class="n">with_views</span> <span class="ow">and</span> <span class="n">Dataset</span><span class="o">.</span><span class="n">history_deals</span> <span class="ow">in</span> <span class="n">written_tables</span><span class="p">:</span>
|
|
<a id="__codelineno-0-821" name="__codelineno-0-821"></a> <span class="n">create_cash_events_view</span><span class="p">(</span><span class="n">conn</span><span class="p">,</span> <span class="n">written_columns</span><span class="p">[</span><span class="n">Dataset</span><span class="o">.</span><span class="n">history_deals</span><span class="p">])</span>
|
|
<a id="__codelineno-0-822" name="__codelineno-0-822"></a> <span class="n">create_positions_reconstructed_view</span><span class="p">(</span>
|
|
<a id="__codelineno-0-823" name="__codelineno-0-823"></a> <span class="n">conn</span><span class="p">,</span>
|
|
<a id="__codelineno-0-824" name="__codelineno-0-824"></a> <span class="n">written_columns</span><span class="p">[</span><span class="n">Dataset</span><span class="o">.</span><span class="n">history_deals</span><span class="p">],</span>
|
|
<a id="__codelineno-0-825" name="__codelineno-0-825"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-826" name="__codelineno-0-826"></a> <span class="k">elif</span> <span class="n">with_views</span><span class="p">:</span>
|
|
<a id="__codelineno-0-827" name="__codelineno-0-827"></a> <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span>
|
|
<a id="__codelineno-0-828" name="__codelineno-0-828"></a> <span class="s2">"--with-views ignored: history_deals table was not written"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-829" name="__codelineno-0-829"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-830" name="__codelineno-0-830"></a> <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span>
|
|
<a id="__codelineno-0-831" name="__codelineno-0-831"></a> <span class="s2">"Collected </span><span class="si">%s</span><span class="s2"> for </span><span class="si">%d</span><span class="s2"> symbol(s) into </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-832" name="__codelineno-0-832"></a> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">sorted</span><span class="p">(</span><span class="n">ds</span><span class="o">.</span><span class="n">value</span> <span class="k">for</span> <span class="n">ds</span> <span class="ow">in</span> <span class="n">selected</span><span class="p">)),</span>
|
|
<a id="__codelineno-0-833" name="__codelineno-0-833"></a> <span class="nb">len</span><span class="p">(</span><span class="n">symbols</span><span class="p">),</span>
|
|
<a id="__codelineno-0-834" name="__codelineno-0-834"></a> <span class="n">output</span><span class="p">,</span>
|
|
<a id="__codelineno-0-835" name="__codelineno-0-835"></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.sdk.copy_rates_from" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">copy_rates_from</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.copy_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">copy_rates_from</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></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="datetime.datetime">datetime</span></span> <span class="o">|</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">count</span><span class="p">:</span> <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="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return rates starting from a date.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-842">842</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-843">843</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-844">844</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-845">845</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-846">846</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-847">847</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-848">848</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-849">849</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-850">850</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-851">851</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-852">852</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-853">853</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-854">854</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-855">855</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-856">856</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-842" name="__codelineno-0-842"></a><span class="k">def</span><span class="w"> </span><span class="nf">copy_rates_from</span><span class="p">(</span>
|
|
<a id="__codelineno-0-843" name="__codelineno-0-843"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-844" name="__codelineno-0-844"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-845" name="__codelineno-0-845"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-846" name="__codelineno-0-846"></a> <span class="n">count</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
|
|
<a id="__codelineno-0-847" name="__codelineno-0-847"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-848" name="__codelineno-0-848"></a> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-849" name="__codelineno-0-849"></a><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-850" name="__codelineno-0-850"></a><span class="w"> </span><span class="sd">"""Return rates starting from a date."""</span>
|
|
<a id="__codelineno-0-851" name="__codelineno-0-851"></a> <span class="k">return</span> <span class="n">_make_client</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">)</span><span class="o">.</span><span class="n">copy_rates_from</span><span class="p">(</span>
|
|
<a id="__codelineno-0-852" name="__codelineno-0-852"></a> <span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-853" name="__codelineno-0-853"></a> <span class="n">timeframe</span><span class="p">,</span>
|
|
<a id="__codelineno-0-854" name="__codelineno-0-854"></a> <span class="n">date_from</span><span class="p">,</span>
|
|
<a id="__codelineno-0-855" name="__codelineno-0-855"></a> <span class="n">count</span><span class="p">,</span>
|
|
<a id="__codelineno-0-856" name="__codelineno-0-856"></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.sdk.copy_rates_from_pos" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">copy_rates_from_pos</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.copy_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">copy_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">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">start_pos</span><span class="p">:</span> <span class="n"><span title="int">int</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">count</span><span class="p">:</span> <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="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return rates starting from a bar position.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-859">859</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-860">860</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-861">861</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-862">862</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-863">863</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-864">864</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-865">865</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-866">866</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-867">867</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-868">868</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-869">869</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-870">870</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-871">871</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-872">872</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-873">873</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-859" name="__codelineno-0-859"></a><span class="k">def</span><span class="w"> </span><span class="nf">copy_rates_from_pos</span><span class="p">(</span>
|
|
<a id="__codelineno-0-860" name="__codelineno-0-860"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-861" name="__codelineno-0-861"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-862" name="__codelineno-0-862"></a> <span class="n">start_pos</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
|
|
<a id="__codelineno-0-863" name="__codelineno-0-863"></a> <span class="n">count</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
|
|
<a id="__codelineno-0-864" name="__codelineno-0-864"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-865" name="__codelineno-0-865"></a> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-866" name="__codelineno-0-866"></a><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-867" name="__codelineno-0-867"></a><span class="w"> </span><span class="sd">"""Return rates starting from a bar position."""</span>
|
|
<a id="__codelineno-0-868" name="__codelineno-0-868"></a> <span class="k">return</span> <span class="n">_make_client</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">)</span><span class="o">.</span><span class="n">copy_rates_from_pos</span><span class="p">(</span>
|
|
<a id="__codelineno-0-869" name="__codelineno-0-869"></a> <span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-870" name="__codelineno-0-870"></a> <span class="n">timeframe</span><span class="p">,</span>
|
|
<a id="__codelineno-0-871" name="__codelineno-0-871"></a> <span class="n">start_pos</span><span class="p">,</span>
|
|
<a id="__codelineno-0-872" name="__codelineno-0-872"></a> <span class="n">count</span><span class="p">,</span>
|
|
<a id="__codelineno-0-873" name="__codelineno-0-873"></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.sdk.copy_rates_range" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">copy_rates_range</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.copy_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">copy_rates_range</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></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="datetime.datetime">datetime</span></span> <span class="o">|</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">date_to</span><span class="p">:</span> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return rates for a date range.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-876">876</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-877">877</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-878">878</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-879">879</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-880">880</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-881">881</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-882">882</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-883">883</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-884">884</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-885">885</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-886">886</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-887">887</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-888">888</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-889">889</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-890">890</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-876" name="__codelineno-0-876"></a><span class="k">def</span><span class="w"> </span><span class="nf">copy_rates_range</span><span class="p">(</span>
|
|
<a id="__codelineno-0-877" name="__codelineno-0-877"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-878" name="__codelineno-0-878"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-879" name="__codelineno-0-879"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-880" name="__codelineno-0-880"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-881" name="__codelineno-0-881"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-882" name="__codelineno-0-882"></a> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-883" name="__codelineno-0-883"></a><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-884" name="__codelineno-0-884"></a><span class="w"> </span><span class="sd">"""Return rates for a date range."""</span>
|
|
<a id="__codelineno-0-885" name="__codelineno-0-885"></a> <span class="k">return</span> <span class="n">_make_client</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">)</span><span class="o">.</span><span class="n">copy_rates_range</span><span class="p">(</span>
|
|
<a id="__codelineno-0-886" name="__codelineno-0-886"></a> <span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-887" name="__codelineno-0-887"></a> <span class="n">timeframe</span><span class="p">,</span>
|
|
<a id="__codelineno-0-888" name="__codelineno-0-888"></a> <span class="n">date_from</span><span class="p">,</span>
|
|
<a id="__codelineno-0-889" name="__codelineno-0-889"></a> <span class="n">date_to</span><span class="p">,</span>
|
|
<a id="__codelineno-0-890" name="__codelineno-0-890"></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.sdk.copy_ticks_from" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">copy_ticks_from</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.copy_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">copy_ticks_from</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</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="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">count</span><span class="p">:</span> <span class="n"><span title="int">int</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">flags</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return ticks starting from a date.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-893">893</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-894">894</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-895">895</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-896">896</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-897">897</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-898">898</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-899">899</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-900">900</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-901">901</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-902">902</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-903">903</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-904">904</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-905">905</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-906">906</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-907">907</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-893" name="__codelineno-0-893"></a><span class="k">def</span><span class="w"> </span><span class="nf">copy_ticks_from</span><span class="p">(</span>
|
|
<a id="__codelineno-0-894" name="__codelineno-0-894"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-895" name="__codelineno-0-895"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-896" name="__codelineno-0-896"></a> <span class="n">count</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
|
|
<a id="__codelineno-0-897" name="__codelineno-0-897"></a> <span class="n">flags</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-898" name="__codelineno-0-898"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-899" name="__codelineno-0-899"></a> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-900" name="__codelineno-0-900"></a><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-901" name="__codelineno-0-901"></a><span class="w"> </span><span class="sd">"""Return ticks starting from a date."""</span>
|
|
<a id="__codelineno-0-902" name="__codelineno-0-902"></a> <span class="k">return</span> <span class="n">_make_client</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">)</span><span class="o">.</span><span class="n">copy_ticks_from</span><span class="p">(</span>
|
|
<a id="__codelineno-0-903" name="__codelineno-0-903"></a> <span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-904" name="__codelineno-0-904"></a> <span class="n">date_from</span><span class="p">,</span>
|
|
<a id="__codelineno-0-905" name="__codelineno-0-905"></a> <span class="n">count</span><span class="p">,</span>
|
|
<a id="__codelineno-0-906" name="__codelineno-0-906"></a> <span class="n">flags</span><span class="p">,</span>
|
|
<a id="__codelineno-0-907" name="__codelineno-0-907"></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.sdk.copy_ticks_range" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">copy_ticks_range</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.copy_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">copy_ticks_range</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</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="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</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">flags</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return ticks for a date range.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-910">910</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-911">911</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-912">912</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-913">913</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-914">914</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-915">915</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-916">916</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-917">917</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-918">918</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-919">919</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-920">920</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-921">921</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-922">922</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-923">923</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-924">924</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-910" name="__codelineno-0-910"></a><span class="k">def</span><span class="w"> </span><span class="nf">copy_ticks_range</span><span class="p">(</span>
|
|
<a id="__codelineno-0-911" name="__codelineno-0-911"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-912" name="__codelineno-0-912"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-913" name="__codelineno-0-913"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-914" name="__codelineno-0-914"></a> <span class="n">flags</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-915" name="__codelineno-0-915"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-916" name="__codelineno-0-916"></a> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-917" name="__codelineno-0-917"></a><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-918" name="__codelineno-0-918"></a><span class="w"> </span><span class="sd">"""Return ticks for a date range."""</span>
|
|
<a id="__codelineno-0-919" name="__codelineno-0-919"></a> <span class="k">return</span> <span class="n">_make_client</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">)</span><span class="o">.</span><span class="n">copy_ticks_range</span><span class="p">(</span>
|
|
<a id="__codelineno-0-920" name="__codelineno-0-920"></a> <span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-921" name="__codelineno-0-921"></a> <span class="n">date_from</span><span class="p">,</span>
|
|
<a id="__codelineno-0-922" name="__codelineno-0-922"></a> <span class="n">date_to</span><span class="p">,</span>
|
|
<a id="__codelineno-0-923" name="__codelineno-0-923"></a> <span class="n">flags</span><span class="p">,</span>
|
|
<a id="__codelineno-0-924" name="__codelineno-0-924"></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.sdk.history_deals" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">history_deals</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.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">date_from</span><span class="p">:</span> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">group</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</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">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</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">ticket</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</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="n">position</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return historical deals.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-1006">1006</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1007">1007</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1008">1008</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1009">1009</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1010">1010</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1011">1011</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1012">1012</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1013">1013</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1014">1014</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1015">1015</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1016">1016</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1017">1017</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1018">1018</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1019">1019</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1020">1020</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1021">1021</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1022">1022</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1023">1023</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1024">1024</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-1006" name="__codelineno-0-1006"></a><span class="k">def</span><span class="w"> </span><span class="nf">history_deals</span><span class="p">(</span>
|
|
<a id="__codelineno-0-1007" name="__codelineno-0-1007"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1008" name="__codelineno-0-1008"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1009" name="__codelineno-0-1009"></a> <span class="n">group</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1010" name="__codelineno-0-1010"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1011" name="__codelineno-0-1011"></a> <span class="n">ticket</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1012" name="__codelineno-0-1012"></a> <span class="n">position</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1013" name="__codelineno-0-1013"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1014" name="__codelineno-0-1014"></a> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1015" name="__codelineno-0-1015"></a><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-1016" name="__codelineno-0-1016"></a><span class="w"> </span><span class="sd">"""Return historical deals."""</span>
|
|
<a id="__codelineno-0-1017" name="__codelineno-0-1017"></a> <span class="k">return</span> <span class="n">_make_client</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">)</span><span class="o">.</span><span class="n">history_deals</span><span class="p">(</span>
|
|
<a id="__codelineno-0-1018" name="__codelineno-0-1018"></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-1019" name="__codelineno-0-1019"></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-1020" name="__codelineno-0-1020"></a> <span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1021" name="__codelineno-0-1021"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1022" name="__codelineno-0-1022"></a> <span class="n">ticket</span><span class="o">=</span><span class="n">ticket</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1023" name="__codelineno-0-1023"></a> <span class="n">position</span><span class="o">=</span><span class="n">position</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1024" name="__codelineno-0-1024"></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.sdk.history_orders" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">history_orders</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.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">date_from</span><span class="p">:</span> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">group</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</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">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</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">ticket</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</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="n">position</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return historical orders.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-985"> 985</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-986"> 986</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-987"> 987</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-988"> 988</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-989"> 989</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-990"> 990</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-991"> 991</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-992"> 992</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-993"> 993</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-994"> 994</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-995"> 995</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-996"> 996</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-997"> 997</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-998"> 998</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-999"> 999</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1000">1000</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1001">1001</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1002">1002</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1003">1003</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-985" name="__codelineno-0-985"></a><span class="k">def</span><span class="w"> </span><span class="nf">history_orders</span><span class="p">(</span>
|
|
<a id="__codelineno-0-986" name="__codelineno-0-986"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-987" name="__codelineno-0-987"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-988" name="__codelineno-0-988"></a> <span class="n">group</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-989" name="__codelineno-0-989"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-990" name="__codelineno-0-990"></a> <span class="n">ticket</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-991" name="__codelineno-0-991"></a> <span class="n">position</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-992" name="__codelineno-0-992"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-993" name="__codelineno-0-993"></a> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-994" name="__codelineno-0-994"></a><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-995" name="__codelineno-0-995"></a><span class="w"> </span><span class="sd">"""Return historical orders."""</span>
|
|
<a id="__codelineno-0-996" name="__codelineno-0-996"></a> <span class="k">return</span> <span class="n">_make_client</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">)</span><span class="o">.</span><span class="n">history_orders</span><span class="p">(</span>
|
|
<a id="__codelineno-0-997" name="__codelineno-0-997"></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-998" name="__codelineno-0-998"></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-999" name="__codelineno-0-999"></a> <span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1000" name="__codelineno-0-1000"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1001" name="__codelineno-0-1001"></a> <span class="n">ticket</span><span class="o">=</span><span class="n">ticket</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1002" name="__codelineno-0-1002"></a> <span class="n">position</span><span class="o">=</span><span class="n">position</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1003" name="__codelineno-0-1003"></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.sdk.last_error" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">last_error</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.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="o">*</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return the last error information.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-1032">1032</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1033">1033</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1034">1034</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-1032" name="__codelineno-0-1032"></a><span class="k">def</span><span class="w"> </span><span class="nf">last_error</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</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-1033" name="__codelineno-0-1033"></a><span class="w"> </span><span class="sd">"""Return the last error information."""</span>
|
|
<a id="__codelineno-0-1034" name="__codelineno-0-1034"></a> <span class="k">return</span> <span class="n">_make_client</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="n">config</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.sdk.market_book" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">market_book</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.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">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return market depth for a symbol.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-1046">1046</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1047">1047</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1048">1048</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1049">1049</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1050">1050</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1051">1051</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1052">1052</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-1046" name="__codelineno-0-1046"></a><span class="k">def</span><span class="w"> </span><span class="nf">market_book</span><span class="p">(</span>
|
|
<a id="__codelineno-0-1047" name="__codelineno-0-1047"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1048" name="__codelineno-0-1048"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1049" name="__codelineno-0-1049"></a> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1050" name="__codelineno-0-1050"></a><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-1051" name="__codelineno-0-1051"></a><span class="w"> </span><span class="sd">"""Return market depth for a symbol."""</span>
|
|
<a id="__codelineno-0-1052" name="__codelineno-0-1052"></a> <span class="k">return</span> <span class="n">_make_client</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">)</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.sdk.minimum_margins" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">minimum_margins</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.minimum_margins" 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">minimum_margins</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return minimum-volume buy and sell margin requirements.</p>
|
|
<p>See <code>Mt5CliClient.minimum_margins</code> for return details.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-1077">1077</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1078">1078</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1079">1079</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1080">1080</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1081">1081</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1082">1082</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1083">1083</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1084">1084</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1085">1085</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1086">1086</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-1077" name="__codelineno-0-1077"></a><span class="k">def</span><span class="w"> </span><span class="nf">minimum_margins</span><span class="p">(</span>
|
|
<a id="__codelineno-0-1078" name="__codelineno-0-1078"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1079" name="__codelineno-0-1079"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1080" name="__codelineno-0-1080"></a> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1081" name="__codelineno-0-1081"></a><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-1082" name="__codelineno-0-1082"></a><span class="w"> </span><span class="sd">"""Return minimum-volume buy and sell margin requirements.</span>
|
|
<a id="__codelineno-0-1083" name="__codelineno-0-1083"></a>
|
|
<a id="__codelineno-0-1084" name="__codelineno-0-1084"></a><span class="sd"> See ``Mt5CliClient.minimum_margins`` for return details.</span>
|
|
<a id="__codelineno-0-1085" name="__codelineno-0-1085"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-1086" name="__codelineno-0-1086"></a> <span class="k">return</span> <span class="n">_make_client</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">)</span><span class="o">.</span><span class="n">minimum_margins</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.sdk.orders" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">orders</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.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">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</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="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</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="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</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="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return active orders.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-955">955</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-956">956</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-957">957</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-958">958</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-959">959</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-960">960</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-961">961</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-962">962</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-963">963</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-964">964</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-965">965</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-966">966</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-967">967</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-955" name="__codelineno-0-955"></a><span class="k">def</span><span class="w"> </span><span class="nf">orders</span><span class="p">(</span>
|
|
<a id="__codelineno-0-956" name="__codelineno-0-956"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-957" name="__codelineno-0-957"></a> <span class="n">group</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-958" name="__codelineno-0-958"></a> <span class="n">ticket</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-959" name="__codelineno-0-959"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-960" name="__codelineno-0-960"></a> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-961" name="__codelineno-0-961"></a><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-962" name="__codelineno-0-962"></a><span class="w"> </span><span class="sd">"""Return active orders."""</span>
|
|
<a id="__codelineno-0-963" name="__codelineno-0-963"></a> <span class="k">return</span> <span class="n">_make_client</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">)</span><span class="o">.</span><span class="n">orders</span><span class="p">(</span>
|
|
<a id="__codelineno-0-964" name="__codelineno-0-964"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-965" name="__codelineno-0-965"></a> <span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span>
|
|
<a id="__codelineno-0-966" name="__codelineno-0-966"></a> <span class="n">ticket</span><span class="o">=</span><span class="n">ticket</span><span class="p">,</span>
|
|
<a id="__codelineno-0-967" name="__codelineno-0-967"></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.sdk.positions" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">positions</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.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">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</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="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</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="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</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="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return open positions.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-970">970</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-971">971</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-972">972</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-973">973</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-974">974</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-975">975</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-976">976</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-977">977</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-978">978</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-979">979</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-980">980</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-981">981</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-982">982</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-970" name="__codelineno-0-970"></a><span class="k">def</span><span class="w"> </span><span class="nf">positions</span><span class="p">(</span>
|
|
<a id="__codelineno-0-971" name="__codelineno-0-971"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-972" name="__codelineno-0-972"></a> <span class="n">group</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-973" name="__codelineno-0-973"></a> <span class="n">ticket</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-974" name="__codelineno-0-974"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-975" name="__codelineno-0-975"></a> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-976" name="__codelineno-0-976"></a><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-977" name="__codelineno-0-977"></a><span class="w"> </span><span class="sd">"""Return open positions."""</span>
|
|
<a id="__codelineno-0-978" name="__codelineno-0-978"></a> <span class="k">return</span> <span class="n">_make_client</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">)</span><span class="o">.</span><span class="n">positions</span><span class="p">(</span>
|
|
<a id="__codelineno-0-979" name="__codelineno-0-979"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-980" name="__codelineno-0-980"></a> <span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span>
|
|
<a id="__codelineno-0-981" name="__codelineno-0-981"></a> <span class="n">ticket</span><span class="o">=</span><span class="n">ticket</span><span class="p">,</span>
|
|
<a id="__codelineno-0-982" name="__codelineno-0-982"></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.sdk.recent_ticks" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">recent_ticks</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.recent_ticks" 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">recent_ticks</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">seconds</span><span class="p">:</span> <span class="n"><span title="float">float</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</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">count</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">=</span> <span class="mi">10000</span><span class="p">,</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">flags</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span> <span class="o">=</span> <span class="s2">"ALL"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</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="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return ticks from a recent time window ending at <code>date_to</code> or now.</p>
|
|
<p>See <code>Mt5CliClient.recent_ticks</code> for parameter and return details.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-1055">1055</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1056">1056</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1057">1057</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1058">1058</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1059">1059</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1060">1060</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1061">1061</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1062">1062</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1063">1063</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1064">1064</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1065">1065</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1066">1066</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1067">1067</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1068">1068</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1069">1069</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1070">1070</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1071">1071</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1072">1072</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1073">1073</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1074">1074</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-1055" name="__codelineno-0-1055"></a><span class="k">def</span><span class="w"> </span><span class="nf">recent_ticks</span><span class="p">(</span>
|
|
<a id="__codelineno-0-1056" name="__codelineno-0-1056"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1057" name="__codelineno-0-1057"></a> <span class="n">seconds</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1058" name="__codelineno-0-1058"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1059" name="__codelineno-0-1059"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1060" name="__codelineno-0-1060"></a> <span class="n">count</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">10000</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1061" name="__codelineno-0-1061"></a> <span class="n">flags</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"ALL"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1062" name="__codelineno-0-1062"></a> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1063" name="__codelineno-0-1063"></a><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-1064" name="__codelineno-0-1064"></a><span class="w"> </span><span class="sd">"""Return ticks from a recent time window ending at ``date_to`` or now.</span>
|
|
<a id="__codelineno-0-1065" name="__codelineno-0-1065"></a>
|
|
<a id="__codelineno-0-1066" name="__codelineno-0-1066"></a><span class="sd"> See ``Mt5CliClient.recent_ticks`` for parameter and return details.</span>
|
|
<a id="__codelineno-0-1067" name="__codelineno-0-1067"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-1068" name="__codelineno-0-1068"></a> <span class="k">return</span> <span class="n">_make_client</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">)</span><span class="o">.</span><span class="n">recent_ticks</span><span class="p">(</span>
|
|
<a id="__codelineno-0-1069" name="__codelineno-0-1069"></a> <span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1070" name="__codelineno-0-1070"></a> <span class="n">seconds</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1071" name="__codelineno-0-1071"></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-1072" name="__codelineno-0-1072"></a> <span class="n">count</span><span class="o">=</span><span class="n">count</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1073" name="__codelineno-0-1073"></a> <span class="n">flags</span><span class="o">=</span><span class="n">flags</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1074" name="__codelineno-0-1074"></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.sdk.symbol_info" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">symbol_info</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.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">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return details for one symbol.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-946">946</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-947">947</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-948">948</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-949">949</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-950">950</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-951">951</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-952">952</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-946" name="__codelineno-0-946"></a><span class="k">def</span><span class="w"> </span><span class="nf">symbol_info</span><span class="p">(</span>
|
|
<a id="__codelineno-0-947" name="__codelineno-0-947"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-948" name="__codelineno-0-948"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-949" name="__codelineno-0-949"></a> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-950" name="__codelineno-0-950"></a><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-951" name="__codelineno-0-951"></a><span class="w"> </span><span class="sd">"""Return details for one symbol."""</span>
|
|
<a id="__codelineno-0-952" name="__codelineno-0-952"></a> <span class="k">return</span> <span class="n">_make_client</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">)</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.sdk.symbol_info_tick" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">symbol_info_tick</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.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">symbol</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return the last tick for a symbol.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-1037">1037</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1038">1038</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1039">1039</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1040">1040</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1041">1041</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1042">1042</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1043">1043</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-1037" name="__codelineno-0-1037"></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-1038" name="__codelineno-0-1038"></a> <span class="n">symbol</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1039" name="__codelineno-0-1039"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1040" name="__codelineno-0-1040"></a> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-1041" name="__codelineno-0-1041"></a><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-1042" name="__codelineno-0-1042"></a><span class="w"> </span><span class="sd">"""Return the last tick for a symbol."""</span>
|
|
<a id="__codelineno-0-1043" name="__codelineno-0-1043"></a> <span class="k">return</span> <span class="n">_make_client</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">)</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.sdk.symbols" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">symbols</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.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">group</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</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="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return the symbol list.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-937">937</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-938">938</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-939">939</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-940">940</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-941">941</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-942">942</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-943">943</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-937" name="__codelineno-0-937"></a><span class="k">def</span><span class="w"> </span><span class="nf">symbols</span><span class="p">(</span>
|
|
<a id="__codelineno-0-938" name="__codelineno-0-938"></a> <span class="n">group</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-939" name="__codelineno-0-939"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-940" name="__codelineno-0-940"></a> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-941" name="__codelineno-0-941"></a><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-942" name="__codelineno-0-942"></a><span class="w"> </span><span class="sd">"""Return the symbol list."""</span>
|
|
<a id="__codelineno-0-943" name="__codelineno-0-943"></a> <span class="k">return</span> <span class="n">_make_client</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">)</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.sdk.terminal_info" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">terminal_info</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.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>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="o">*</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return terminal information.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-932">932</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-933">933</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-934">934</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-932" name="__codelineno-0-932"></a><span class="k">def</span><span class="w"> </span><span class="nf">terminal_info</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</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-933" name="__codelineno-0-933"></a><span class="w"> </span><span class="sd">"""Return terminal information."""</span>
|
|
<a id="__codelineno-0-934" name="__codelineno-0-934"></a> <span class="k">return</span> <span class="n">_make_client</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="n">config</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.sdk.update_history" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">update_history</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.update_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">update_history</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">client</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5DataClient">Mt5DataClient</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">output</span><span class="p">:</span> <span class="n"><span title="pathlib.Path">Path</span></span> <span class="o">|</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">symbols</span><span class="p">:</span> <span class="n"><span title="collections.abc.Sequence">Sequence</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">],</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">datasets</span><span class="p">:</span> <span class="n"><span title="set">set</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="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="n">timeframes</span><span class="p">:</span> <span class="n"><span title="collections.abc.Sequence">Sequence</span></span><span class="p">[</span><span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="n">flags</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span> <span class="o">=</span> <span class="s2">"ALL"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n">lookback_hours</span><span class="p">:</span> <span class="n"><span title="float">float</span></span> <span class="o">=</span> <span class="mf">24.0</span><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="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</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">deduplicate</span><span class="p">:</span> <span class="n"><span title="bool">bool</span></span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
|
|
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n">create_rate_views</span><span class="p">:</span> <span class="n"><span title="bool">bool</span></span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
|
|
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="n">with_views</span><span class="p">:</span> <span class="n"><span title="bool">bool</span></span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n">include_account_events</span><span class="p">:</span> <span class="n"><span title="bool">bool</span></span> <span class="o">=</span> <span class="kc">True</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>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Incrementally append MT5 history into a SQLite database.</p>
|
|
<p>Uses an already-connected <code>Mt5DataClient</code> and does not create or close
|
|
the MT5 connection. For first-time tables, data is fetched from
|
|
<code>date_to - lookback_hours</code>. Subsequent runs resume from existing
|
|
<code>MAX(time)</code> per symbol (and timeframe for rates); when
|
|
<code>include_account_events=True</code>, account-level deals use a separate cursor
|
|
over <code>type NOT IN (0, 1)</code> / empty-symbol rows.</p>
|
|
|
|
|
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>client</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="pdmt5.Mt5DataClient">Mt5DataClient</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Connected MT5 data client.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>output</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="pathlib.Path">Path</span> | <span title="str">str</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>SQLite database path.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>symbols</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="collections.abc.Sequence">Sequence</span>[<span title="str">str</span>]</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Symbols to update.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>datasets</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="set">set</span>[<a class="autorefs autorefs-internal" title="Dataset (mt5cli.utils.Dataset)" href="../utils/#mt5cli.utils.Dataset">Dataset</a>] | None</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Datasets to include (defaults to all).</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>timeframes</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="collections.abc.Sequence">Sequence</span>[<span title="int">int</span> | <span title="str">str</span>] | None</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Rate timeframes to update (defaults to all fixed MT5
|
|
timeframes when None).</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>flags</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="int">int</span> | <span title="str">str</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Tick copy flags as integer or name (e.g. <code>ALL</code>).</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>'ALL'</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>lookback_hours</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="float">float</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>First-run lookback when a table has no prior rows.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>24.0</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>date_to</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="datetime.datetime">datetime</span> | <span title="str">str</span> | None</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Optional update end datetime. Defaults to now (UTC).</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>deduplicate</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="bool">bool</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Remove duplicate rows after append, keeping latest ROWID.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>True</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>create_rate_views</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="bool">bool</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Create <code>rate_<symbol>__<timeframe></code> views.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>True</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>with_views</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="bool">bool</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Create <code>cash_events</code> and <code>positions_reconstructed</code> views.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>False</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>include_account_events</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="bool">bool</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Include account-level cash events in
|
|
<code>history_deals</code> when True.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>True</code>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-648">648</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-649">649</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-650">650</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-651">651</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-652">652</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-653">653</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-654">654</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-655">655</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-656">656</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-657">657</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-658">658</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-659">659</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-660">660</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-661">661</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-662">662</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-663">663</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-664">664</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-665">665</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-666">666</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-667">667</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-668">668</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-669">669</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-670">670</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-671">671</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-672">672</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-673">673</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-674">674</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-675">675</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-676">676</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-677">677</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-678">678</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-679">679</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-680">680</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-681">681</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-682">682</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-683">683</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-684">684</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-685">685</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-686">686</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-687">687</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-688">688</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-689">689</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-690">690</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-691">691</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-692">692</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-693">693</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-694">694</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-695">695</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-696">696</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-697">697</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-698">698</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-699">699</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-700">700</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-701">701</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-702">702</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-703">703</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-704">704</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-705">705</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-706">706</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-707">707</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-708">708</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-709">709</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-710">710</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-711">711</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-712">712</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-713">713</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-714">714</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-715">715</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-716">716</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-717">717</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-718">718</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-719">719</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-720">720</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-721">721</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-648" name="__codelineno-0-648"></a><span class="k">def</span><span class="w"> </span><span class="nf">update_history</span><span class="p">(</span> <span class="c1"># noqa: PLR0913</span>
|
|
<a id="__codelineno-0-649" name="__codelineno-0-649"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-650" name="__codelineno-0-650"></a> <span class="n">client</span><span class="p">:</span> <span class="n">Mt5DataClient</span><span class="p">,</span>
|
|
<a id="__codelineno-0-651" name="__codelineno-0-651"></a> <span class="n">output</span><span class="p">:</span> <span class="n">Path</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-652" name="__codelineno-0-652"></a> <span class="n">symbols</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span>
|
|
<a id="__codelineno-0-653" name="__codelineno-0-653"></a> <span class="n">datasets</span><span class="p">:</span> <span class="nb">set</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="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-654" name="__codelineno-0-654"></a> <span class="n">timeframes</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-655" name="__codelineno-0-655"></a> <span class="n">flags</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"ALL"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-656" name="__codelineno-0-656"></a> <span class="n">lookback_hours</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">24.0</span><span class="p">,</span>
|
|
<a id="__codelineno-0-657" name="__codelineno-0-657"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-658" name="__codelineno-0-658"></a> <span class="n">deduplicate</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
|
|
<a id="__codelineno-0-659" name="__codelineno-0-659"></a> <span class="n">create_rate_views</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
|
|
<a id="__codelineno-0-660" name="__codelineno-0-660"></a> <span class="n">with_views</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<a id="__codelineno-0-661" name="__codelineno-0-661"></a> <span class="n">include_account_events</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
|
|
<a id="__codelineno-0-662" name="__codelineno-0-662"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-663" name="__codelineno-0-663"></a><span class="w"> </span><span class="sd">"""Incrementally append MT5 history into a SQLite database.</span>
|
|
<a id="__codelineno-0-664" name="__codelineno-0-664"></a>
|
|
<a id="__codelineno-0-665" name="__codelineno-0-665"></a><span class="sd"> Uses an already-connected ``Mt5DataClient`` and does not create or close</span>
|
|
<a id="__codelineno-0-666" name="__codelineno-0-666"></a><span class="sd"> the MT5 connection. For first-time tables, data is fetched from</span>
|
|
<a id="__codelineno-0-667" name="__codelineno-0-667"></a><span class="sd"> ``date_to - lookback_hours``. Subsequent runs resume from existing</span>
|
|
<a id="__codelineno-0-668" name="__codelineno-0-668"></a><span class="sd"> ``MAX(time)`` per symbol (and timeframe for rates); when</span>
|
|
<a id="__codelineno-0-669" name="__codelineno-0-669"></a><span class="sd"> ``include_account_events=True``, account-level deals use a separate cursor</span>
|
|
<a id="__codelineno-0-670" name="__codelineno-0-670"></a><span class="sd"> over ``type NOT IN (0, 1)`` / empty-symbol rows.</span>
|
|
<a id="__codelineno-0-671" name="__codelineno-0-671"></a>
|
|
<a id="__codelineno-0-672" name="__codelineno-0-672"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-673" name="__codelineno-0-673"></a><span class="sd"> client: Connected MT5 data client.</span>
|
|
<a id="__codelineno-0-674" name="__codelineno-0-674"></a><span class="sd"> output: SQLite database path.</span>
|
|
<a id="__codelineno-0-675" name="__codelineno-0-675"></a><span class="sd"> symbols: Symbols to update.</span>
|
|
<a id="__codelineno-0-676" name="__codelineno-0-676"></a><span class="sd"> datasets: Datasets to include (defaults to all).</span>
|
|
<a id="__codelineno-0-677" name="__codelineno-0-677"></a><span class="sd"> timeframes: Rate timeframes to update (defaults to all fixed MT5</span>
|
|
<a id="__codelineno-0-678" name="__codelineno-0-678"></a><span class="sd"> timeframes when None).</span>
|
|
<a id="__codelineno-0-679" name="__codelineno-0-679"></a><span class="sd"> flags: Tick copy flags as integer or name (e.g. ``ALL``).</span>
|
|
<a id="__codelineno-0-680" name="__codelineno-0-680"></a><span class="sd"> lookback_hours: First-run lookback when a table has no prior rows.</span>
|
|
<a id="__codelineno-0-681" name="__codelineno-0-681"></a><span class="sd"> date_to: Optional update end datetime. Defaults to now (UTC).</span>
|
|
<a id="__codelineno-0-682" name="__codelineno-0-682"></a><span class="sd"> deduplicate: Remove duplicate rows after append, keeping latest ROWID.</span>
|
|
<a id="__codelineno-0-683" name="__codelineno-0-683"></a><span class="sd"> create_rate_views: Create ``rate_<symbol>__<timeframe>`` views.</span>
|
|
<a id="__codelineno-0-684" name="__codelineno-0-684"></a><span class="sd"> with_views: Create ``cash_events`` and ``positions_reconstructed`` views.</span>
|
|
<a id="__codelineno-0-685" name="__codelineno-0-685"></a><span class="sd"> include_account_events: Include account-level cash events in</span>
|
|
<a id="__codelineno-0-686" name="__codelineno-0-686"></a><span class="sd"> ``history_deals`` when True.</span>
|
|
<a id="__codelineno-0-687" name="__codelineno-0-687"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-688" name="__codelineno-0-688"></a> <span class="n">request</span> <span class="o">=</span> <span class="n">_resolve_update_history_request</span><span class="p">(</span>
|
|
<a id="__codelineno-0-689" name="__codelineno-0-689"></a> <span class="n">output</span><span class="o">=</span><span class="n">output</span><span class="p">,</span>
|
|
<a id="__codelineno-0-690" name="__codelineno-0-690"></a> <span class="n">symbols</span><span class="o">=</span><span class="n">symbols</span><span class="p">,</span>
|
|
<a id="__codelineno-0-691" name="__codelineno-0-691"></a> <span class="n">datasets</span><span class="o">=</span><span class="n">datasets</span><span class="p">,</span>
|
|
<a id="__codelineno-0-692" name="__codelineno-0-692"></a> <span class="n">timeframes</span><span class="o">=</span><span class="n">timeframes</span><span class="p">,</span>
|
|
<a id="__codelineno-0-693" name="__codelineno-0-693"></a> <span class="n">flags</span><span class="o">=</span><span class="n">flags</span><span class="p">,</span>
|
|
<a id="__codelineno-0-694" name="__codelineno-0-694"></a> <span class="n">lookback_hours</span><span class="o">=</span><span class="n">lookback_hours</span><span class="p">,</span>
|
|
<a id="__codelineno-0-695" name="__codelineno-0-695"></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-696" name="__codelineno-0-696"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-697" name="__codelineno-0-697"></a> <span class="k">if</span> <span class="n">request</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-698" name="__codelineno-0-698"></a> <span class="k">return</span>
|
|
<a id="__codelineno-0-699" name="__codelineno-0-699"></a> <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span>
|
|
<a id="__codelineno-0-700" name="__codelineno-0-700"></a> <span class="s2">"Updating history in SQLite: symbols=</span><span class="si">%s</span><span class="s2">, datasets=</span><span class="si">%s</span><span class="s2">, path=</span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-701" name="__codelineno-0-701"></a> <span class="nb">list</span><span class="p">(</span><span class="n">symbols</span><span class="p">),</span>
|
|
<a id="__codelineno-0-702" name="__codelineno-0-702"></a> <span class="nb">sorted</span><span class="p">(</span><span class="n">dataset</span><span class="o">.</span><span class="n">value</span> <span class="k">for</span> <span class="n">dataset</span> <span class="ow">in</span> <span class="n">request</span><span class="o">.</span><span class="n">selected</span><span class="p">),</span>
|
|
<a id="__codelineno-0-703" name="__codelineno-0-703"></a> <span class="n">request</span><span class="o">.</span><span class="n">output_path</span><span class="p">,</span>
|
|
<a id="__codelineno-0-704" name="__codelineno-0-704"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-705" name="__codelineno-0-705"></a> <span class="k">with</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">output_path</span><span class="p">)</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
|
|
<a id="__codelineno-0-706" name="__codelineno-0-706"></a> <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"PRAGMA journal_mode=WAL"</span><span class="p">)</span>
|
|
<a id="__codelineno-0-707" name="__codelineno-0-707"></a> <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"PRAGMA synchronous=NORMAL"</span><span class="p">)</span>
|
|
<a id="__codelineno-0-708" name="__codelineno-0-708"></a> <span class="n">write_incremental_datasets</span><span class="p">(</span>
|
|
<a id="__codelineno-0-709" name="__codelineno-0-709"></a> <span class="n">conn</span><span class="p">,</span>
|
|
<a id="__codelineno-0-710" name="__codelineno-0-710"></a> <span class="n">client</span><span class="p">,</span>
|
|
<a id="__codelineno-0-711" name="__codelineno-0-711"></a> <span class="n">symbols</span><span class="p">,</span>
|
|
<a id="__codelineno-0-712" name="__codelineno-0-712"></a> <span class="n">request</span><span class="o">.</span><span class="n">selected</span><span class="p">,</span>
|
|
<a id="__codelineno-0-713" name="__codelineno-0-713"></a> <span class="n">request</span><span class="o">.</span><span class="n">resolved_timeframes</span><span class="p">,</span>
|
|
<a id="__codelineno-0-714" name="__codelineno-0-714"></a> <span class="n">request</span><span class="o">.</span><span class="n">resolved_tick_flags</span><span class="p">,</span>
|
|
<a id="__codelineno-0-715" name="__codelineno-0-715"></a> <span class="n">request</span><span class="o">.</span><span class="n">fallback_start</span><span class="p">,</span>
|
|
<a id="__codelineno-0-716" name="__codelineno-0-716"></a> <span class="n">request</span><span class="o">.</span><span class="n">end</span><span class="p">,</span>
|
|
<a id="__codelineno-0-717" name="__codelineno-0-717"></a> <span class="n">deduplicate</span><span class="o">=</span><span class="n">deduplicate</span><span class="p">,</span>
|
|
<a id="__codelineno-0-718" name="__codelineno-0-718"></a> <span class="n">create_rate_views</span><span class="o">=</span><span class="n">create_rate_views</span><span class="p">,</span>
|
|
<a id="__codelineno-0-719" name="__codelineno-0-719"></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-720" name="__codelineno-0-720"></a> <span class="n">include_account_events</span><span class="o">=</span><span class="n">include_account_events</span><span class="p">,</span>
|
|
<a id="__codelineno-0-721" name="__codelineno-0-721"></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.sdk.update_history_with_config" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">update_history_with_config</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.update_history_with_config" 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">update_history_with_config</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">output</span><span class="p">:</span> <span class="n"><span title="pathlib.Path">Path</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">symbols</span><span class="p">:</span> <span class="n"><span title="collections.abc.Sequence">Sequence</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">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</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">datasets</span><span class="p">:</span> <span class="n"><span title="set">set</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="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="n">timeframes</span><span class="p">:</span> <span class="n"><span title="collections.abc.Sequence">Sequence</span></span><span class="p">[</span><span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="n">flags</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span> <span class="o">=</span> <span class="s2">"ALL"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n">lookback_hours</span><span class="p">:</span> <span class="n"><span title="float">float</span></span> <span class="o">=</span> <span class="mf">24.0</span><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="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</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">deduplicate</span><span class="p">:</span> <span class="n"><span title="bool">bool</span></span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
|
|
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n">create_rate_views</span><span class="p">:</span> <span class="n"><span title="bool">bool</span></span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
|
|
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="n">with_views</span><span class="p">:</span> <span class="n"><span title="bool">bool</span></span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n">include_account_events</span><span class="p">:</span> <span class="n"><span title="bool">bool</span></span> <span class="o">=</span> <span class="kc">True</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>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Incrementally append MT5 history, opening and closing the MT5 connection.</p>
|
|
<p>Convenience wrapper around :func:<code>update_history</code> for standalone use.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-724">724</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-725">725</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-726">726</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-727">727</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-728">728</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-729">729</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-730">730</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-731">731</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-732">732</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-733">733</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-734">734</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-735">735</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-736">736</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-737">737</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-738">738</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-739">739</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-740">740</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-741">741</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-742">742</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-743">743</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-744">744</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-745">745</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-746">746</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-747">747</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-748">748</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-749">749</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-750">750</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-751">751</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-752">752</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-753">753</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-754">754</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-755">755</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-756">756</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-757">757</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-758">758</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-759">759</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-760">760</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-761">761</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-762">762</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-763">763</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-764">764</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-765">765</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-766">766</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-767">767</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-768">768</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-769">769</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-724" name="__codelineno-0-724"></a><span class="k">def</span><span class="w"> </span><span class="nf">update_history_with_config</span><span class="p">(</span> <span class="c1"># noqa: PLR0913</span>
|
|
<a id="__codelineno-0-725" name="__codelineno-0-725"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-726" name="__codelineno-0-726"></a> <span class="n">output</span><span class="p">:</span> <span class="n">Path</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-727" name="__codelineno-0-727"></a> <span class="n">symbols</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span>
|
|
<a id="__codelineno-0-728" name="__codelineno-0-728"></a> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-729" name="__codelineno-0-729"></a> <span class="n">datasets</span><span class="p">:</span> <span class="nb">set</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="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-730" name="__codelineno-0-730"></a> <span class="n">timeframes</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-731" name="__codelineno-0-731"></a> <span class="n">flags</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"ALL"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-732" name="__codelineno-0-732"></a> <span class="n">lookback_hours</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">24.0</span><span class="p">,</span>
|
|
<a id="__codelineno-0-733" name="__codelineno-0-733"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-734" name="__codelineno-0-734"></a> <span class="n">deduplicate</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
|
|
<a id="__codelineno-0-735" name="__codelineno-0-735"></a> <span class="n">create_rate_views</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
|
|
<a id="__codelineno-0-736" name="__codelineno-0-736"></a> <span class="n">with_views</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<a id="__codelineno-0-737" name="__codelineno-0-737"></a> <span class="n">include_account_events</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
|
|
<a id="__codelineno-0-738" name="__codelineno-0-738"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-739" name="__codelineno-0-739"></a><span class="w"> </span><span class="sd">"""Incrementally append MT5 history, opening and closing the MT5 connection.</span>
|
|
<a id="__codelineno-0-740" name="__codelineno-0-740"></a>
|
|
<a id="__codelineno-0-741" name="__codelineno-0-741"></a><span class="sd"> Convenience wrapper around :func:`update_history` for standalone use.</span>
|
|
<a id="__codelineno-0-742" name="__codelineno-0-742"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-743" name="__codelineno-0-743"></a> <span class="n">request</span> <span class="o">=</span> <span class="n">_resolve_update_history_request</span><span class="p">(</span>
|
|
<a id="__codelineno-0-744" name="__codelineno-0-744"></a> <span class="n">output</span><span class="o">=</span><span class="n">output</span><span class="p">,</span>
|
|
<a id="__codelineno-0-745" name="__codelineno-0-745"></a> <span class="n">symbols</span><span class="o">=</span><span class="n">symbols</span><span class="p">,</span>
|
|
<a id="__codelineno-0-746" name="__codelineno-0-746"></a> <span class="n">datasets</span><span class="o">=</span><span class="n">datasets</span><span class="p">,</span>
|
|
<a id="__codelineno-0-747" name="__codelineno-0-747"></a> <span class="n">timeframes</span><span class="o">=</span><span class="n">timeframes</span><span class="p">,</span>
|
|
<a id="__codelineno-0-748" name="__codelineno-0-748"></a> <span class="n">flags</span><span class="o">=</span><span class="n">flags</span><span class="p">,</span>
|
|
<a id="__codelineno-0-749" name="__codelineno-0-749"></a> <span class="n">lookback_hours</span><span class="o">=</span><span class="n">lookback_hours</span><span class="p">,</span>
|
|
<a id="__codelineno-0-750" name="__codelineno-0-750"></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-751" name="__codelineno-0-751"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-752" name="__codelineno-0-752"></a> <span class="k">if</span> <span class="n">request</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-753" name="__codelineno-0-753"></a> <span class="k">return</span>
|
|
<a id="__codelineno-0-754" name="__codelineno-0-754"></a> <span class="n">mt5_config</span> <span class="o">=</span> <span class="n">config</span> <span class="ow">or</span> <span class="n">build_config</span><span class="p">()</span>
|
|
<a id="__codelineno-0-755" name="__codelineno-0-755"></a> <span class="k">with</span> <span class="n">_connected_client</span><span class="p">(</span><span class="n">mt5_config</span><span class="p">)</span> <span class="k">as</span> <span class="n">client</span><span class="p">:</span>
|
|
<a id="__codelineno-0-756" name="__codelineno-0-756"></a> <span class="n">update_history</span><span class="p">(</span>
|
|
<a id="__codelineno-0-757" name="__codelineno-0-757"></a> <span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
|
<a id="__codelineno-0-758" name="__codelineno-0-758"></a> <span class="n">output</span><span class="o">=</span><span class="n">output</span><span class="p">,</span>
|
|
<a id="__codelineno-0-759" name="__codelineno-0-759"></a> <span class="n">symbols</span><span class="o">=</span><span class="n">symbols</span><span class="p">,</span>
|
|
<a id="__codelineno-0-760" name="__codelineno-0-760"></a> <span class="n">datasets</span><span class="o">=</span><span class="n">datasets</span><span class="p">,</span>
|
|
<a id="__codelineno-0-761" name="__codelineno-0-761"></a> <span class="n">timeframes</span><span class="o">=</span><span class="n">timeframes</span><span class="p">,</span>
|
|
<a id="__codelineno-0-762" name="__codelineno-0-762"></a> <span class="n">flags</span><span class="o">=</span><span class="n">flags</span><span class="p">,</span>
|
|
<a id="__codelineno-0-763" name="__codelineno-0-763"></a> <span class="n">lookback_hours</span><span class="o">=</span><span class="n">lookback_hours</span><span class="p">,</span>
|
|
<a id="__codelineno-0-764" name="__codelineno-0-764"></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-765" name="__codelineno-0-765"></a> <span class="n">deduplicate</span><span class="o">=</span><span class="n">deduplicate</span><span class="p">,</span>
|
|
<a id="__codelineno-0-766" name="__codelineno-0-766"></a> <span class="n">create_rate_views</span><span class="o">=</span><span class="n">create_rate_views</span><span class="p">,</span>
|
|
<a id="__codelineno-0-767" name="__codelineno-0-767"></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-768" name="__codelineno-0-768"></a> <span class="n">include_account_events</span><span class="o">=</span><span class="n">include_account_events</span><span class="p">,</span>
|
|
<a id="__codelineno-0-769" name="__codelineno-0-769"></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.sdk.version" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">version</span>
|
|
|
|
|
|
<a href="#mt5cli.sdk.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="o">*</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="n"><span title="pdmt5.Mt5Config">Mt5Config</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return MetaTrader5 version information.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/sdk.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-1027">1027</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1028">1028</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-1029">1029</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-1027" name="__codelineno-0-1027"></a><span class="k">def</span><span class="w"> </span><span class="nf">version</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</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-1028" name="__codelineno-0-1028"></a><span class="w"> </span><span class="sd">"""Return MetaTrader5 version information."""</span>
|
|
<a id="__codelineno-0-1029" name="__codelineno-0-1029"></a> <span class="k">return</span> <span class="n">_make_client</span><span class="p">(</span><span class="n">config</span><span class="o">=</span><span class="n">config</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>
|