2026-05-24 16:49:15 +00:00
<!DOCTYPE html>
< html lang = "en" data-bs-theme = "light" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2026-04-22 17:11:38 +00:00
2026-05-24 16:49:15 +00:00
< meta name = "author" content = "dceoy" >
< link rel = "canonical" href = "https://github.com/dceoy/mt5cli/api/cli/" >
< link rel = "shortcut icon" href = "../../img/favicon.ico" >
< title > CLI - mt5cli API Documentation</ title >
< link href = "../../css/bootstrap.min.css" rel = "stylesheet" >
< link href = "../../css/fontawesome.min.css" rel = "stylesheet" >
< link href = "../../css/brands.min.css" rel = "stylesheet" >
< link href = "../../css/solid.min.css" rel = "stylesheet" >
< link href = "../../css/v4-font-face.min.css" rel = "stylesheet" >
< link href = "../../css/base.css" rel = "stylesheet" >
< link id = "hljs-light" rel = "stylesheet" href = "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" >
< link id = "hljs-dark" rel = "stylesheet" href = "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github-dark.min.css" disabled >
< link href = "../../assets/_mkdocstrings.css" rel = "stylesheet" >
< script src = "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js" ></ script >
< script > hljs . highlightAll ();</ script >
</ head >
< body >
< div class = "navbar fixed-top navbar-expand-lg navbar-dark bg-primary" >
< div class = "container" >
< a class = "navbar-brand" href = "../.." > mt5cli API Documentation</ a >
<!-- Expander button -->
< button type = "button" class = "navbar-toggler" data-bs-toggle = "collapse" data-bs-target = "#navbar-collapse" aria-controls = "navbar-collapse" aria-expanded = "false" aria-label = "Toggle navigation" >
< span class = "navbar-toggler-icon" ></ span >
</ button >
<!-- Expanded navigation -->
< div id = "navbar-collapse" class = "navbar-collapse collapse" >
<!-- Main navigation -->
< ul class = "nav navbar-nav" >
< li class = "nav-item" >
< a href = "../.." class = "nav-link" > Home</ a >
</ li >
< li class = "nav-item dropdown" >
< a href = "#" class = "nav-link dropdown-toggle active" aria-current = "page" role = "button" data-bs-toggle = "dropdown" aria-expanded = "false" > API Reference</ a >
< ul class = "dropdown-menu" >
< li >
< a href = "../" class = "dropdown-item" > Overview</ a >
</ li >
< li >
< a href = "./" class = "dropdown-item active" aria-current = "page" > CLI</ a >
</ li >
</ ul >
</ li >
</ ul >
< ul class = "nav navbar-nav ms-md-auto" >
< li class = "nav-item" >
< a href = "#" class = "nav-link" data-bs-toggle = "modal" data-bs-target = "#mkdocs_search_modal" >
< i class = "fa fa-search" ></ i > Search
</ a >
</ li >
< li class = "nav-item" >
< a rel = "prev" href = "../" class = "nav-link" >
< i class = "fa fa-arrow-left" ></ i > Previous
</ a >
</ li >
< li class = "nav-item" >
< a rel = "next" class = "nav-link disabled" >
Next < i class = "fa fa-arrow-right" ></ i >
</ a >
</ li >
< li class = "nav-item" >
< a href = "https://github.com/dceoy/mt5cli/edit/master/docs/api/cli.md" class = "nav-link" > Edit on dceoy/mt5cli
</ a >
</ li >
</ ul >
2026-04-22 17:11:38 +00:00
</ div >
2026-05-24 16:49:15 +00:00
</ div >
</ div >
< div class = "container" >
< div class = "row" >
< div class = "col-md-3" >< div class = "navbar-expand-md bs-sidebar hidden-print affix" role = "complementary" >
< div class = "navbar-header" >
< button type = "button" class = "navbar-toggler collapsed" data-bs-toggle = "collapse" data-bs-target = "#toc-collapse" title = "Table of Contents" >
< span class = "fa fa-angle-down" ></ span >
</ button >
</ div >
2026-04-22 17:11:38 +00:00
2026-05-24 16:49:15 +00:00
< div id = "toc-collapse" class = "navbar-collapse collapse card bg-body-tertiary" >
< ul class = "nav flex-column" >
2026-04-22 17:11:38 +00:00
2026-05-24 16:49:15 +00:00
< li class = "nav-item" data-bs-level = "1" >< a href = "#cli-module" class = "nav-link" > CLI Module</ a >
< ul class = "nav flex-column" >
< li class = "nav-item" data-bs-level = "2" >< a href = "#mt5cli.cli" class = "nav-link" > cli</ a >
< ul class = "nav flex-column" >
</ ul >
</ li >
</ ul >
</ li >
</ ul >
</ div >
</ div ></ div >
< div class = "col-md-9" role = "main" >
2026-04-22 17:11:38 +00:00
< h1 id = "cli-module" > CLI Module< a class = "headerlink" href = "#cli-module" title = "Permanent link" > ¶ </ a ></ h1 >
< div class = "doc doc-object doc-module" >
< h2 id = "mt5cli.cli" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-module-name" > mt5cli.cli</ span >
< a href = "#mt5cli.cli" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h2 >
< div class = "doc doc-contents first" >
< p > Command-line interface for MetaTrader 5 data export.</ p >
< div class = "doc doc-children" >
< div class = "doc doc-object doc-attribute" >
< h3 id = "mt5cli.cli.DATETIME_TYPE" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > DATETIME_TYPE</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-module-attribute" >< code > module-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.DATETIME_TYPE" 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" > DATETIME_TYPE</ span > < span class = "o" > =</ span > < span class = "n" >< span title = "mt5cli.cli._DateTimeType" > _DateTimeType</ span ></ span >< span class = "p" > ()</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
< div class = "doc doc-object doc-attribute" >
2026-04-26 12:50:38 +00:00
< h3 id = "mt5cli.cli.REQUEST_TYPE" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > REQUEST_TYPE</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-module-attribute" >< code > module-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.REQUEST_TYPE" 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" > REQUEST_TYPE</ span > < span class = "o" > =</ span > < span class = "n" >< span title = "mt5cli.cli._RequestType" > _RequestType</ span ></ span >< span class = "p" > ()</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
< div class = "doc doc-object doc-attribute" >
2026-04-22 17:11:38 +00:00
< h3 id = "mt5cli.cli.TICK_FLAGS_TYPE" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > TICK_FLAGS_TYPE</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-module-attribute" >< code > module-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.TICK_FLAGS_TYPE" 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" > TICK_FLAGS_TYPE</ span > < span class = "o" > =</ span > < span class = "n" >< span title = "mt5cli.cli._TickFlagsType" > _TickFlagsType</ span ></ 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.cli.TICK_FLAG_MAP" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > TICK_FLAG_MAP</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-module-attribute" >< code > module-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.TICK_FLAG_MAP" 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" > TICK_FLAG_MAP</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "dict" > dict</ span ></ span >< span class = "p" > [</ span >< span class = "n" >< span title = "str" > str</ span ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "int" > int</ span ></ span >< span class = "p" > ]</ 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" > " ALL" </ span >< span class = "p" > :</ span > < span class = "mi" > 1</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" ></ a > < span class = "s2" > " INFO" </ span >< span class = "p" > :</ span > < span class = "mi" > 2</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" ></ a > < span class = "s2" > " TRADE" </ span >< span class = "p" > :</ span > < span class = "mi" > 4</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-5" name = "__codelineno-0-5" href = "#__codelineno-0-5" ></ a >< span class = "p" > }</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
< div class = "doc doc-object doc-attribute" >
< h3 id = "mt5cli.cli.TIMEFRAME_MAP" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > TIMEFRAME_MAP</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-module-attribute" >< code > module-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.TIMEFRAME_MAP" 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" > TIMEFRAME_MAP</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "dict" > dict</ span ></ span >< span class = "p" > [</ span >< span class = "n" >< span title = "str" > str</ span ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "int" > int</ span ></ span >< span class = "p" > ]</ 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" > " M1" </ span >< span class = "p" > :</ span > < span class = "mi" > 1</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" ></ a > < span class = "s2" > " M2" </ span >< span class = "p" > :</ span > < span class = "mi" > 2</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" ></ a > < span class = "s2" > " M3" </ span >< span class = "p" > :</ span > < span class = "mi" > 3</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-5" name = "__codelineno-0-5" href = "#__codelineno-0-5" ></ a > < span class = "s2" > " M4" </ span >< span class = "p" > :</ span > < span class = "mi" > 4</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-6" name = "__codelineno-0-6" href = "#__codelineno-0-6" ></ a > < span class = "s2" > " M5" </ span >< span class = "p" > :</ span > < span class = "mi" > 5</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-7" name = "__codelineno-0-7" href = "#__codelineno-0-7" ></ a > < span class = "s2" > " M6" </ span >< span class = "p" > :</ span > < span class = "mi" > 6</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-8" name = "__codelineno-0-8" href = "#__codelineno-0-8" ></ a > < span class = "s2" > " M10" </ span >< span class = "p" > :</ span > < span class = "mi" > 10</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-9" name = "__codelineno-0-9" href = "#__codelineno-0-9" ></ a > < span class = "s2" > " M12" </ span >< span class = "p" > :</ span > < span class = "mi" > 12</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-10" name = "__codelineno-0-10" href = "#__codelineno-0-10" ></ a > < span class = "s2" > " M15" </ span >< span class = "p" > :</ span > < span class = "mi" > 15</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-11" name = "__codelineno-0-11" href = "#__codelineno-0-11" ></ a > < span class = "s2" > " M20" </ span >< span class = "p" > :</ span > < span class = "mi" > 20</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-12" name = "__codelineno-0-12" href = "#__codelineno-0-12" ></ a > < span class = "s2" > " M30" </ span >< span class = "p" > :</ span > < span class = "mi" > 30</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-13" name = "__codelineno-0-13" href = "#__codelineno-0-13" ></ a > < span class = "s2" > " H1" </ span >< span class = "p" > :</ span > < span class = "mi" > 16385</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-14" name = "__codelineno-0-14" href = "#__codelineno-0-14" ></ a > < span class = "s2" > " H2" </ span >< span class = "p" > :</ span > < span class = "mi" > 16386</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-15" name = "__codelineno-0-15" href = "#__codelineno-0-15" ></ a > < span class = "s2" > " H3" </ span >< span class = "p" > :</ span > < span class = "mi" > 16387</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-16" name = "__codelineno-0-16" href = "#__codelineno-0-16" ></ a > < span class = "s2" > " H4" </ span >< span class = "p" > :</ span > < span class = "mi" > 16388</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-17" name = "__codelineno-0-17" href = "#__codelineno-0-17" ></ a > < span class = "s2" > " H6" </ span >< span class = "p" > :</ span > < span class = "mi" > 16390</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-18" name = "__codelineno-0-18" href = "#__codelineno-0-18" ></ a > < span class = "s2" > " H8" </ span >< span class = "p" > :</ span > < span class = "mi" > 16392</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-19" name = "__codelineno-0-19" href = "#__codelineno-0-19" ></ a > < span class = "s2" > " H12" </ span >< span class = "p" > :</ span > < span class = "mi" > 16396</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-20" name = "__codelineno-0-20" href = "#__codelineno-0-20" ></ a > < span class = "s2" > " D1" </ span >< span class = "p" > :</ span > < span class = "mi" > 16408</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-21" name = "__codelineno-0-21" href = "#__codelineno-0-21" ></ a > < span class = "s2" > " W1" </ span >< span class = "p" > :</ span > < span class = "mi" > 32769</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-22" name = "__codelineno-0-22" href = "#__codelineno-0-22" ></ a > < span class = "s2" > " MN1" </ span >< span class = "p" > :</ span > < span class = "mi" > 49153</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-23" name = "__codelineno-0-23" href = "#__codelineno-0-23" ></ a >< span class = "p" > }</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
< div class = "doc doc-object doc-attribute" >
< h3 id = "mt5cli.cli.TIMEFRAME_TYPE" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > TIMEFRAME_TYPE</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-module-attribute" >< code > module-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.TIMEFRAME_TYPE" 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" > TIMEFRAME_TYPE</ span > < span class = "o" > =</ span > < span class = "n" >< span title = "mt5cli.cli._TimeframeType" > _TimeframeType</ span ></ 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.cli.app" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > app</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-module-attribute" >< code > module-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.app" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "n" > app</ span > < span class = "o" > =</ span > < span class = "n" >< span title = "typer.Typer" > Typer</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-2" name = "__codelineno-0-2" href = "#__codelineno-0-2" ></ a > < span class = "n" >< span title = "typer.Typer(name)" > name</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " mt5cli" </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" ></ a > < span class = "n" >< span title = "typer.Typer(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Export MetaTrader5 data to CSV, JSON, Parquet, or SQLite3." </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" ></ a >< span class = "p" > )</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
< div class = "doc doc-object doc-attribute" >
< h3 id = "mt5cli.cli.logger" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > logger</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-module-attribute" >< code > module-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.logger" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "n" > logger</ span > < span class = "o" > =</ span > < span class = "n" >< span title = "logging.getLogger" > getLogger</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "__name__" > __name__</ span ></ span >< span class = "p" > )</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
< div class = "doc doc-object doc-class" >
2026-05-28 16:23:36 +00:00
< h3 id = "mt5cli.cli.Dataset" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-class-name" > Dataset</ span >
< a href = "#mt5cli.cli.Dataset" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc doc-contents " >
< p class = "doc doc-class-bases" >
Bases: < code >< span title = "enum.StrEnum" > StrEnum</ span ></ code ></ p >
< p > Datasets supported by the < code > collect-history</ code > command.</ p >
< div class = "doc doc-children" >
< div class = "doc doc-object doc-attribute" >
< h4 id = "mt5cli.cli.Dataset.history_deals" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > history_deals</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-class-attribute" >< code > class-attribute</ code ></ small >
< small class = "doc doc-label doc-label-instance-attribute" >< code > instance-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.Dataset.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 = "n" > history_deals</ span > < span class = "o" > =</ span > < span class = "s1" > ' history-deals' </ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
< div class = "doc doc-object doc-attribute" >
< h4 id = "mt5cli.cli.Dataset.history_orders" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > history_orders</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-class-attribute" >< code > class-attribute</ code ></ small >
< small class = "doc doc-label doc-label-instance-attribute" >< code > instance-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.Dataset.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 = "n" > history_orders</ span > < span class = "o" > =</ span > < span class = "s1" > ' history-orders' </ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
< div class = "doc doc-object doc-attribute" >
< h4 id = "mt5cli.cli.Dataset.rates" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > rates</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-class-attribute" >< code > class-attribute</ code ></ small >
< small class = "doc doc-label doc-label-instance-attribute" >< code > instance-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.Dataset.rates" 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" > rates</ span > < span class = "o" > =</ span > < span class = "s1" > ' rates' </ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
< div class = "doc doc-object doc-attribute" >
< h4 id = "mt5cli.cli.Dataset.ticks" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > ticks</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-class-attribute" >< code > class-attribute</ code ></ small >
< small class = "doc doc-label doc-label-instance-attribute" >< code > instance-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.Dataset.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 = "n" > ticks</ span > < span class = "o" > =</ span > < span class = "s1" > ' ticks' </ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
</ div >
</ div >
</ div >
< div class = "doc doc-object doc-class" >
< h3 id = "mt5cli.cli.IfExists" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-class-name" > IfExists</ span >
< a href = "#mt5cli.cli.IfExists" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc doc-contents " >
< p class = "doc doc-class-bases" >
Bases: < code >< span title = "enum.StrEnum" > StrEnum</ span ></ code ></ p >
< p > SQLite table conflict behavior for the < code > collect-history</ code > command.</ p >
< div class = "doc doc-children" >
< div class = "doc doc-object doc-attribute" >
< h4 id = "mt5cli.cli.IfExists.APPEND" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > APPEND</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-class-attribute" >< code > class-attribute</ code ></ small >
< small class = "doc doc-label doc-label-instance-attribute" >< code > instance-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.IfExists.APPEND" 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" > APPEND</ span > < span class = "o" > =</ span > < span class = "s1" > ' append' </ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
< div class = "doc doc-object doc-attribute" >
< h4 id = "mt5cli.cli.IfExists.FAIL" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > FAIL</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-class-attribute" >< code > class-attribute</ code ></ small >
< small class = "doc doc-label doc-label-instance-attribute" >< code > instance-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.IfExists.FAIL" 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" > FAIL</ span > < span class = "o" > =</ span > < span class = "s1" > ' fail' </ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
< div class = "doc doc-object doc-attribute" >
< h4 id = "mt5cli.cli.IfExists.REPLACE" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > REPLACE</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-class-attribute" >< code > class-attribute</ code ></ small >
< small class = "doc doc-label doc-label-instance-attribute" >< code > instance-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.IfExists.REPLACE" 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" > REPLACE</ span > < span class = "o" > =</ span > < span class = "s1" > ' replace' </ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
</ div >
</ div >
</ div >
< div class = "doc doc-object doc-class" >
2026-04-22 17:11:38 +00:00
< h3 id = "mt5cli.cli.LogLevel" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-class-name" > LogLevel</ span >
< a href = "#mt5cli.cli.LogLevel" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc doc-contents " >
< p class = "doc doc-class-bases" >
Bases: < code >< span title = "enum.StrEnum" > StrEnum</ span ></ code ></ p >
< p > Logging verbosity levels.</ p >
< div class = "doc doc-children" >
< div class = "doc doc-object doc-attribute" >
< h4 id = "mt5cli.cli.LogLevel.DEBUG" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > DEBUG</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-class-attribute" >< code > class-attribute</ code ></ small >
< small class = "doc doc-label doc-label-instance-attribute" >< code > instance-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.LogLevel.DEBUG" 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" > DEBUG</ span > < span class = "o" > =</ span > < span class = "s1" > ' DEBUG' </ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
< div class = "doc doc-object doc-attribute" >
< h4 id = "mt5cli.cli.LogLevel.ERROR" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > ERROR</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-class-attribute" >< code > class-attribute</ code ></ small >
< small class = "doc doc-label doc-label-instance-attribute" >< code > instance-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.LogLevel.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 = "n" > ERROR</ span > < span class = "o" > =</ span > < span class = "s1" > ' ERROR' </ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
< div class = "doc doc-object doc-attribute" >
< h4 id = "mt5cli.cli.LogLevel.INFO" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > INFO</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-class-attribute" >< code > class-attribute</ code ></ small >
< small class = "doc doc-label doc-label-instance-attribute" >< code > instance-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.LogLevel.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 = "n" > INFO</ span > < span class = "o" > =</ span > < span class = "s1" > ' INFO' </ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
< div class = "doc doc-object doc-attribute" >
< h4 id = "mt5cli.cli.LogLevel.WARNING" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > WARNING</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-class-attribute" >< code > class-attribute</ code ></ small >
< small class = "doc doc-label doc-label-instance-attribute" >< code > instance-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.LogLevel.WARNING" 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" > WARNING</ span > < span class = "o" > =</ span > < span class = "s1" > ' WARNING' </ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
</ div >
</ div >
</ div >
< div class = "doc doc-object doc-class" >
< h3 id = "mt5cli.cli.OutputFormat" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-class-name" > OutputFormat</ span >
< a href = "#mt5cli.cli.OutputFormat" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc doc-contents " >
< p class = "doc doc-class-bases" >
Bases: < code >< span title = "enum.StrEnum" > StrEnum</ span ></ code ></ p >
< p > Supported output file formats.</ p >
< div class = "doc doc-children" >
< div class = "doc doc-object doc-attribute" >
< h4 id = "mt5cli.cli.OutputFormat.csv" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > csv</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-class-attribute" >< code > class-attribute</ code ></ small >
< small class = "doc doc-label doc-label-instance-attribute" >< code > instance-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.OutputFormat.csv" 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" > csv</ span > < span class = "o" > =</ span > < span class = "s1" > ' csv' </ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
< div class = "doc doc-object doc-attribute" >
< h4 id = "mt5cli.cli.OutputFormat.json" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > json</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-class-attribute" >< code > class-attribute</ code ></ small >
< small class = "doc doc-label doc-label-instance-attribute" >< code > instance-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.OutputFormat.json" 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" > json</ span > < span class = "o" > =</ span > < span class = "s1" > ' json' </ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
< div class = "doc doc-object doc-attribute" >
< h4 id = "mt5cli.cli.OutputFormat.parquet" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > parquet</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-class-attribute" >< code > class-attribute</ code ></ small >
< small class = "doc doc-label doc-label-instance-attribute" >< code > instance-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.OutputFormat.parquet" 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" > parquet</ span > < span class = "o" > =</ span > < span class = "s1" > ' parquet' </ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
< div class = "doc doc-object doc-attribute" >
< h4 id = "mt5cli.cli.OutputFormat.sqlite3" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-attribute-name" > sqlite3</ span >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-class-attribute" >< code > class-attribute</ code ></ small >
< small class = "doc doc-label doc-label-instance-attribute" >< code > instance-attribute</ code ></ small >
</ span >
< a href = "#mt5cli.cli.OutputFormat.sqlite3" 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" > sqlite3</ span > < span class = "o" > =</ span > < span class = "s1" > ' sqlite3' </ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
</ div >
</ div >
</ div >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.account_info" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > account_info</ span >
< a href = "#mt5cli.cli.account_info" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > account_info</ span >< span class = "p" > (</ span >< span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typer.Context" > Context</ span ></ span >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Export account information.</ p >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-723" > 723</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-724" > 724</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-725" > 725</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-726" > 726</ a ></ span ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-723" name = "__codelineno-0-723" ></ a >< span class = "nd" > @app</ span >< span class = "o" > .</ span >< span class = "n" > command</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-724" name = "__codelineno-0-724" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > account_info</ span >< span class = "p" > (</ span >< span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Context</ span >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-725" name = "__codelineno-0-725" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Export account information.""" </ span >
< a id = "__codelineno-0-726" name = "__codelineno-0-726" ></ a > < span class = "n" > _execute_export</ span >< span class = "p" > (</ span >< span class = "n" > ctx</ span >< span class = "p" > ,</ span > < span class = "k" > lambda</ span > < span class = "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" >
< h3 id = "mt5cli.cli.collect_history" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > collect_history</ span >
< a href = "#mt5cli.cli.collect_history" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > collect_history</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-2" name = "__codelineno-0-2" href = "#__codelineno-0-2" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typer.Context" > Context</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" ></ a > < span class = "n" >< span title = "list" > list</ span ></ span >< span class = "p" > [</ span >< span class = "n" >< span title = "str" > str</ span ></ span >< span class = "p" > ],</ span >
< a id = "__codelineno-0-5" name = "__codelineno-0-5" href = "#__codelineno-0-5" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-6" name = "__codelineno-0-6" href = "#__codelineno-0-6" ></ a > < span class = "s2" > " --symbol" </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-7" name = "__codelineno-0-7" href = "#__codelineno-0-7" ></ a > < span class = "s2" > " -s" </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-8" name = "__codelineno-0-8" href = "#__codelineno-0-8" ></ a > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol to collect (repeat for multiple symbols)." </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-9" name = "__codelineno-0-9" href = "#__codelineno-0-9" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-10" name = "__codelineno-0-10" href = "#__codelineno-0-10" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-11" name = "__codelineno-0-11" href = "#__codelineno-0-11" ></ a > < span class = "n" > date_from</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-12" name = "__codelineno-0-12" href = "#__codelineno-0-12" ></ a > < span class = "n" >< span title = "datetime.datetime" > datetime</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-13" name = "__codelineno-0-13" href = "#__codelineno-0-13" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-14" name = "__codelineno-0-14" href = "#__codelineno-0-14" ></ a > < span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "DATETIME_TYPE
module-attribute
(mt5cli.cli.DATETIME_TYPE)" href = "#mt5cli.cli.DATETIME_TYPE" > DATETIME_TYPE</ a ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Start date." </ span >
< a id = "__codelineno-0-15" name = "__codelineno-0-15" href = "#__codelineno-0-15" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-16" name = "__codelineno-0-16" href = "#__codelineno-0-16" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-17" name = "__codelineno-0-17" href = "#__codelineno-0-17" ></ a > < span class = "n" > date_to</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-18" name = "__codelineno-0-18" href = "#__codelineno-0-18" ></ a > < span class = "n" >< span title = "datetime.datetime" > datetime</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-19" name = "__codelineno-0-19" href = "#__codelineno-0-19" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "DATETIME_TYPE
module-attribute
(mt5cli.cli.DATETIME_TYPE)" href = "#mt5cli.cli.DATETIME_TYPE" > DATETIME_TYPE</ a ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " End date." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-20" name = "__codelineno-0-20" href = "#__codelineno-0-20" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-21" name = "__codelineno-0-21" href = "#__codelineno-0-21" ></ a > < span class = "n" > dataset</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-22" name = "__codelineno-0-22" href = "#__codelineno-0-22" ></ a > < span class = "n" >< span title = "list" > list</ span ></ span >< span class = "p" > [</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "Dataset (mt5cli.cli.Dataset)" href = "#mt5cli.cli.Dataset" > Dataset</ a ></ span >< span class = "p" > ]</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-23" name = "__codelineno-0-23" href = "#__codelineno-0-23" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-24" name = "__codelineno-0-24" href = "#__codelineno-0-24" ></ a > < span class = "s2" > " --dataset" </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-25" name = "__codelineno-0-25" href = "#__codelineno-0-25" ></ a > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Dataset to include (repeat for multiple). Defaults to all: rates, ticks, history-orders, history-deals." </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-26" name = "__codelineno-0-26" href = "#__codelineno-0-26" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-27" name = "__codelineno-0-27" href = "#__codelineno-0-27" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-28" name = "__codelineno-0-28" href = "#__codelineno-0-28" ></ a > < span class = "n" > timeframe</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-29" name = "__codelineno-0-29" href = "#__codelineno-0-29" ></ a > < span class = "n" >< span title = "int" > int</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-30" name = "__codelineno-0-30" href = "#__codelineno-0-30" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-31" name = "__codelineno-0-31" href = "#__codelineno-0-31" ></ a > < span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "TIMEFRAME_TYPE
module-attribute
(mt5cli.cli.TIMEFRAME_TYPE)" href = "#mt5cli.cli.TIMEFRAME_TYPE" > TIMEFRAME_TYPE</ a ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-32" name = "__codelineno-0-32" href = "#__codelineno-0-32" ></ a > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Rates timeframe (e.g., M1, H1, D1)." </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-33" name = "__codelineno-0-33" href = "#__codelineno-0-33" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-34" name = "__codelineno-0-34" href = "#__codelineno-0-34" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "mi" > 1</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-35" name = "__codelineno-0-35" href = "#__codelineno-0-35" ></ a > < span class = "n" > flags</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-36" name = "__codelineno-0-36" href = "#__codelineno-0-36" ></ a > < span class = "n" >< span title = "int" > int</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-37" name = "__codelineno-0-37" href = "#__codelineno-0-37" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-38" name = "__codelineno-0-38" href = "#__codelineno-0-38" ></ a > < span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "TICK_FLAGS_TYPE
module-attribute
(mt5cli.cli.TICK_FLAGS_TYPE)" href = "#mt5cli.cli.TICK_FLAGS_TYPE" > TICK_FLAGS_TYPE</ a ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-39" name = "__codelineno-0-39" href = "#__codelineno-0-39" ></ a > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Tick copy flags (ALL, INFO, TRADE, or integer)." </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-40" name = "__codelineno-0-40" href = "#__codelineno-0-40" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-41" name = "__codelineno-0-41" href = "#__codelineno-0-41" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "mi" > 1</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-42" name = "__codelineno-0-42" href = "#__codelineno-0-42" ></ a > < span class = "n" > if_exists</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-43" name = "__codelineno-0-43" href = "#__codelineno-0-43" ></ a > < span class = "n" >< a class = "autorefs autorefs-internal" title = "IfExists (mt5cli.cli.IfExists)" href = "#mt5cli.cli.IfExists" > IfExists</ a ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-44" name = "__codelineno-0-44" href = "#__codelineno-0-44" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-45" name = "__codelineno-0-45" href = "#__codelineno-0-45" ></ a > < span class = "s2" > " --if-exists" </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-46" name = "__codelineno-0-46" href = "#__codelineno-0-46" ></ a > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Behavior when a target table already exists." </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-47" name = "__codelineno-0-47" href = "#__codelineno-0-47" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-48" name = "__codelineno-0-48" href = "#__codelineno-0-48" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "n" >< a class = "autorefs autorefs-internal" title = "FAIL
class-attribute
instance-attribute
(mt5cli.cli.IfExists.FAIL)" href = "#mt5cli.cli.IfExists.FAIL" > FAIL</ a ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-49" name = "__codelineno-0-49" href = "#__codelineno-0-49" ></ a > < span class = "n" > with_views</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-50" name = "__codelineno-0-50" href = "#__codelineno-0-50" ></ a > < span class = "n" >< span title = "bool" > bool</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-51" name = "__codelineno-0-51" href = "#__codelineno-0-51" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-52" name = "__codelineno-0-52" href = "#__codelineno-0-52" ></ a > < span class = "s2" > " --with-views" </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-53" name = "__codelineno-0-53" href = "#__codelineno-0-53" ></ a > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Add cash_events and positions_reconstructed SQLite views derived from history_deals." </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-54" name = "__codelineno-0-54" href = "#__codelineno-0-54" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-55" name = "__codelineno-0-55" href = "#__codelineno-0-55" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > False</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-56" name = "__codelineno-0-56" href = "#__codelineno-0-56" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Collect historical datasets into a single SQLite database.</ p >
< p > Tables written depend on < code > --dataset</ code > : < code > rates</ code > , < code > ticks</ code > ,
< code > history_orders</ code > , < code > history_deals</ code > . History datasets are fetched per
symbol and concatenated. Rates rows carry the requested < code > timeframe</ code > so
appended runs at different timeframes remain distinguishable.</ p >
< p > With < code > --with-views</ code > (requires the < code > history-deals</ code > dataset), optional
views < code > cash_events</ code > and < code > positions_reconstructed</ code > are derived from
< code > history_deals</ code > when the required columns are present.</ p >
< p >< span class = "doc-section-title" > Raises:</ span ></ p >
< table >
< thead >
< tr >
< th > Type</ th >
< th > Description</ th >
</ tr >
</ thead >
< tbody >
< tr class = "doc-section-item" >
< td >
< code >< span title = "typer.BadParameter" > BadParameter</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
< p > If the output format is not SQLite3.</ p >
</ div >
</ td >
</ tr >
</ tbody >
</ table >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-1329" > 1329</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1330" > 1330</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1331" > 1331</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1332" > 1332</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1333" > 1333</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1334" > 1334</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1335" > 1335</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1336" > 1336</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1337" > 1337</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1338" > 1338</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1339" > 1339</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1340" > 1340</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1341" > 1341</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1342" > 1342</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1343" > 1343</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1344" > 1344</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1345" > 1345</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1346" > 1346</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1347" > 1347</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1348" > 1348</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1349" > 1349</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1350" > 1350</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1351" > 1351</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1352" > 1352</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1353" > 1353</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1354" > 1354</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1355" > 1355</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1356" > 1356</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1357" > 1357</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1358" > 1358</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1359" > 1359</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1360" > 1360</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1361" > 1361</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1362" > 1362</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1363" > 1363</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1364" > 1364</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1365" > 1365</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1366" > 1366</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1367" > 1367</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1368" > 1368</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1369" > 1369</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1370" > 1370</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1371" > 1371</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1372" > 1372</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1373" > 1373</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1374" > 1374</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1375" > 1375</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1376" > 1376</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1377" > 1377</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1378" > 1378</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1379" > 1379</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1380" > 1380</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1381" > 1381</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1382" > 1382</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1383" > 1383</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1384" > 1384</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1385" > 1385</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1386" > 1386</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1387" > 1387</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1388" > 1388</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1389" > 1389</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1390" > 1390</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1391" > 1391</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1392" > 1392</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1393" > 1393</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1394" > 1394</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1395" > 1395</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1396" > 1396</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1397" > 1397</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1398" > 1398</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1399" > 1399</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1400" > 1400</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1401" > 1401</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1402" > 1402</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1403" > 1403</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1404" > 1404</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1405" > 1405</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1406" > 1406</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1407" > 1407</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1408" > 1408</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1409" > 1409</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1410" > 1410</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1411" > 1411</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1412" > 1412</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1413" > 1413</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1414" > 1414</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1415" > 1415</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1416" > 1416</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1417" > 1417</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1418" > 1418</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1419" > 1419</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1420" > 1420</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1421" > 1421</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1422" > 1422</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1423" > 1423</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1424" > 1424</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1425" > 1425</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1426" > 1426</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1427" > 1427</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1428" > 1428</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1429" > 1429</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1430" > 1430</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1431" > 1431</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1432" > 1432</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1433" > 1433</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1434" > 1434</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1435" > 1435</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1436" > 1436</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1437" > 1437</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1438" > 1438</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1439" > 1439</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1440" > 1440</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1441" > 1441</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1442" > 1442</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1443" > 1443</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1444" > 1444</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1445" > 1445</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1446" > 1446</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1447" > 1447</ a ></ span ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-1329" name = "__codelineno-0-1329" ></ a >< span class = "nd" > @app</ span >< span class = "o" > .</ span >< span class = "n" > command</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-1330" name = "__codelineno-0-1330" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > collect_history</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-1331" name = "__codelineno-0-1331" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Context</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1332" name = "__codelineno-0-1332" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-1333" name = "__codelineno-0-1333" ></ a > < span class = "nb" > list</ span >< span class = "p" > [</ span >< span class = "nb" > str</ span >< span class = "p" > ],</ span >
< a id = "__codelineno-0-1334" name = "__codelineno-0-1334" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-1335" name = "__codelineno-0-1335" ></ a > < span class = "s2" > " --symbol" </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1336" name = "__codelineno-0-1336" ></ a > < span class = "s2" > " -s" </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1337" name = "__codelineno-0-1337" ></ a > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol to collect (repeat for multiple symbols)." </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1338" name = "__codelineno-0-1338" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-1339" name = "__codelineno-0-1339" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-1340" name = "__codelineno-0-1340" ></ a > < span class = "n" > date_from</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-1341" name = "__codelineno-0-1341" ></ a > < span class = "n" > datetime</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1342" name = "__codelineno-0-1342" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > DATETIME_TYPE</ span >< span class = "p" > ,</ span > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Start date." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-1343" name = "__codelineno-0-1343" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-1344" name = "__codelineno-0-1344" ></ a > < span class = "n" > date_to</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-1345" name = "__codelineno-0-1345" ></ a > < span class = "n" > datetime</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1346" name = "__codelineno-0-1346" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > DATETIME_TYPE</ span >< span class = "p" > ,</ span > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " End date." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-1347" name = "__codelineno-0-1347" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-1348" name = "__codelineno-0-1348" ></ a > < span class = "n" > dataset</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-1349" name = "__codelineno-0-1349" ></ a > < span class = "nb" > list</ span >< span class = "p" > [</ span >< span class = "n" > Dataset</ span >< span class = "p" > ]</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1350" name = "__codelineno-0-1350" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-1351" name = "__codelineno-0-1351" ></ a > < span class = "s2" > " --dataset" </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1352" name = "__codelineno-0-1352" ></ a > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-1353" name = "__codelineno-0-1353" ></ a > < span class = "s2" > " Dataset to include (repeat for multiple)." </ span >
< a id = "__codelineno-0-1354" name = "__codelineno-0-1354" ></ a > < span class = "s2" > " Defaults to all: rates, ticks, history-orders, history-deals." </ span >
< a id = "__codelineno-0-1355" name = "__codelineno-0-1355" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-1356" name = "__codelineno-0-1356" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-1357" name = "__codelineno-0-1357" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1358" name = "__codelineno-0-1358" ></ a > < span class = "n" > timeframe</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-1359" name = "__codelineno-0-1359" ></ a > < span class = "nb" > int</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1360" name = "__codelineno-0-1360" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-1361" name = "__codelineno-0-1361" ></ a > < span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > TIMEFRAME_TYPE</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1362" name = "__codelineno-0-1362" ></ a > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Rates timeframe (e.g., M1, H1, D1)." </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1363" name = "__codelineno-0-1363" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-1364" name = "__codelineno-0-1364" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "mi" > 1</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1365" name = "__codelineno-0-1365" ></ a > < span class = "n" > flags</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-1366" name = "__codelineno-0-1366" ></ a > < span class = "nb" > int</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1367" name = "__codelineno-0-1367" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-1368" name = "__codelineno-0-1368" ></ a > < span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > TICK_FLAGS_TYPE</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1369" name = "__codelineno-0-1369" ></ a > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Tick copy flags (ALL, INFO, TRADE, or integer)." </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1370" name = "__codelineno-0-1370" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-1371" name = "__codelineno-0-1371" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "mi" > 1</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1372" name = "__codelineno-0-1372" ></ a > < span class = "n" > if_exists</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-1373" name = "__codelineno-0-1373" ></ a > < span class = "n" > IfExists</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1374" name = "__codelineno-0-1374" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-1375" name = "__codelineno-0-1375" ></ a > < span class = "s2" > " --if-exists" </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1376" name = "__codelineno-0-1376" ></ a > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Behavior when a target table already exists." </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1377" name = "__codelineno-0-1377" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-1378" name = "__codelineno-0-1378" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "n" > IfExists</ span >< span class = "o" > .</ span >< span class = "n" > FAIL</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1379" name = "__codelineno-0-1379" ></ a > < span class = "n" > with_views</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-1380" name = "__codelineno-0-1380" ></ a > < span class = "nb" > bool</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1381" name = "__codelineno-0-1381" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-1382" name = "__codelineno-0-1382" ></ a > < span class = "s2" > " --with-views" </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1383" name = "__codelineno-0-1383" ></ a > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-1384" name = "__codelineno-0-1384" ></ a > < span class = "s2" > " Add cash_events and positions_reconstructed SQLite views" </ span >
< a id = "__codelineno-0-1385" name = "__codelineno-0-1385" ></ a > < span class = "s2" > " derived from history_deals." </ span >
< a id = "__codelineno-0-1386" name = "__codelineno-0-1386" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-1387" name = "__codelineno-0-1387" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-1388" name = "__codelineno-0-1388" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > False</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1389" name = "__codelineno-0-1389" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-1390" name = "__codelineno-0-1390" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Collect historical datasets into a single SQLite database.</ span >
< a id = "__codelineno-0-1391" name = "__codelineno-0-1391" ></ a >
< a id = "__codelineno-0-1392" name = "__codelineno-0-1392" ></ a >< span class = "sd" > Tables written depend on ``--dataset``: ``rates``, ``ticks``,</ span >
< a id = "__codelineno-0-1393" name = "__codelineno-0-1393" ></ a >< span class = "sd" > ``history_orders``, ``history_deals``. History datasets are fetched per</ span >
< a id = "__codelineno-0-1394" name = "__codelineno-0-1394" ></ a >< span class = "sd" > symbol and concatenated. Rates rows carry the requested ``timeframe`` so</ span >
< a id = "__codelineno-0-1395" name = "__codelineno-0-1395" ></ a >< span class = "sd" > appended runs at different timeframes remain distinguishable.</ span >
< a id = "__codelineno-0-1396" name = "__codelineno-0-1396" ></ a >
< a id = "__codelineno-0-1397" name = "__codelineno-0-1397" ></ a >< span class = "sd" > With ``--with-views`` (requires the ``history-deals`` dataset), optional</ span >
< a id = "__codelineno-0-1398" name = "__codelineno-0-1398" ></ a >< span class = "sd" > views ``cash_events`` and ``positions_reconstructed`` are derived from</ span >
< a id = "__codelineno-0-1399" name = "__codelineno-0-1399" ></ a >< span class = "sd" > ``history_deals`` when the required columns are present.</ span >
< a id = "__codelineno-0-1400" name = "__codelineno-0-1400" ></ a >
< a id = "__codelineno-0-1401" name = "__codelineno-0-1401" ></ a >< span class = "sd" > Raises:</ span >
< a id = "__codelineno-0-1402" name = "__codelineno-0-1402" ></ a >< span class = "sd" > typer.BadParameter: If the output format is not SQLite3.</ span >
< a id = "__codelineno-0-1403" name = "__codelineno-0-1403" ></ a >< span class = "sd" > """ </ span >
< a id = "__codelineno-0-1404" name = "__codelineno-0-1404" ></ a > < span class = "n" > export_ctx</ span > < span class = "o" > =</ span > < span class = "n" > _get_export_context</ span >< span class = "p" > (</ span >< span class = "n" > ctx</ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-1405" name = "__codelineno-0-1405" ></ a > < span class = "k" > if</ span > < span class = "n" > export_ctx</ span >< span class = "o" > .</ span >< span class = "n" > output_format</ span > < span class = "o" > !=</ span > < span class = "s2" > " sqlite3" </ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-1406" name = "__codelineno-0-1406" ></ a > < span class = "n" > msg</ span > < span class = "o" > =</ span > < span class = "p" > (</ span >
< a id = "__codelineno-0-1407" name = "__codelineno-0-1407" ></ a > < span class = "s2" > " collect-history requires SQLite3 output." </ span >
< a id = "__codelineno-0-1408" name = "__codelineno-0-1408" ></ a > < span class = "s2" > " Use a .db/.sqlite/.sqlite3 extension or --format sqlite3." </ span >
< a id = "__codelineno-0-1409" name = "__codelineno-0-1409" ></ a > < span class = "p" > )</ span >
< a id = "__codelineno-0-1410" name = "__codelineno-0-1410" ></ a > < span class = "k" > raise</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > BadParameter</ span >< span class = "p" > (</ span >< span class = "n" > msg</ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-1411" name = "__codelineno-0-1411" ></ a > < span class = "n" > datasets</ span > < span class = "o" > =</ span > < span class = "nb" > set</ span >< span class = "p" > (</ span >< span class = "n" > dataset</ span >< span class = "p" > )</ span > < span class = "k" > if</ span > < span class = "n" > dataset</ span > < span class = "k" > else</ span > < span class = "nb" > set</ span >< span class = "p" > (</ span >< span class = "n" > Dataset</ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-1412" name = "__codelineno-0-1412" ></ 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 = "n" > export_ctx</ span >< span class = "o" > .</ span >< span class = "n" > config</ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-1413" name = "__codelineno-0-1413" ></ 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-1414" name = "__codelineno-0-1414" ></ a > < span class = "k" > try</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-1415" name = "__codelineno-0-1415" ></ a > < span class = "k" > with</ span > < span class = "n" > sqlite3</ span >< span class = "o" > .</ span >< span class = "n" > connect</ span >< span class = "p" > (</ span >< span class = "n" > export_ctx</ span >< span class = "o" > .</ span >< span class = "n" > output</ span >< span class = "p" > )</ span > < span class = "k" > as</ span > < span class = "n" > conn</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-1416" name = "__codelineno-0-1416" ></ 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-1417" name = "__codelineno-0-1417" ></ 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-1418" name = "__codelineno-0-1418" ></ 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-1419" name = "__codelineno-0-1419" ></ a > < span class = "n" > conn</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1420" name = "__codelineno-0-1420" ></ a > < span class = "n" > client</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1421" name = "__codelineno-0-1421" ></ a > < span class = "n" > symbol</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1422" name = "__codelineno-0-1422" ></ a > < span class = "n" > datasets</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1423" name = "__codelineno-0-1423" ></ a > < span class = "n" > timeframe</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1424" name = "__codelineno-0-1424" ></ a > < span class = "n" > flags</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1425" name = "__codelineno-0-1425" ></ a > < span class = "n" > date_from</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1426" name = "__codelineno-0-1426" ></ a > < span class = "n" > date_to</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1427" name = "__codelineno-0-1427" ></ a > < span class = "n" > if_exists</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1428" name = "__codelineno-0-1428" ></ a > < span class = "p" > )</ span >
< a id = "__codelineno-0-1429" name = "__codelineno-0-1429" ></ a > < span class = "n" > _create_collect_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-1430" name = "__codelineno-0-1430" ></ 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-1431" name = "__codelineno-0-1431" ></ 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-1432" name = "__codelineno-0-1432" ></ a > < span class = "n" > _create_positions_reconstructed_view</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-1433" name = "__codelineno-0-1433" ></ a > < span class = "n" > conn</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1434" name = "__codelineno-0-1434" ></ 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-1435" name = "__codelineno-0-1435" ></ a > < span class = "p" > )</ span >
< a id = "__codelineno-0-1436" name = "__codelineno-0-1436" ></ a > < span class = "k" > elif</ span > < span class = "n" > with_views</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-1437" name = "__codelineno-0-1437" ></ a > < span class = "n" > logger</ span >< span class = "o" > .</ span >< span class = "n" > warning</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-1438" name = "__codelineno-0-1438" ></ a > < span class = "s2" > " --with-views ignored: history_deals table was not written" </ span >
< a id = "__codelineno-0-1439" name = "__codelineno-0-1439" ></ a > < span class = "p" > )</ span >
< a id = "__codelineno-0-1440" name = "__codelineno-0-1440" ></ a > < span class = "n" > logger</ span >< span class = "o" > .</ span >< span class = "n" > info</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-1441" name = "__codelineno-0-1441" ></ 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-1442" name = "__codelineno-0-1442" ></ 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" > datasets</ span >< span class = "p" > )),</ span >
< a id = "__codelineno-0-1443" name = "__codelineno-0-1443" ></ a > < span class = "nb" > len</ span >< span class = "p" > (</ span >< span class = "n" > symbol</ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-1444" name = "__codelineno-0-1444" ></ a > < span class = "n" > export_ctx</ span >< span class = "o" > .</ span >< span class = "n" > output</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-1445" name = "__codelineno-0-1445" ></ a > < span class = "p" > )</ span >
< a id = "__codelineno-0-1446" name = "__codelineno-0-1446" ></ a > < span class = "k" > finally</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-1447" name = "__codelineno-0-1447" ></ a > < span class = "n" > client</ span >< span class = "o" > .</ span >< span class = "n" > shutdown</ span >< span class = "p" > ()</ span >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.detect_format" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > detect_format</ span >
< a href = "#mt5cli.cli.detect_format" 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" > detect_format</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-2" name = "__codelineno-0-2" href = "#__codelineno-0-2" ></ a > < span class = "n" > output_path</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "pathlib.Path" > Path</ span ></ span >< span class = "p" > ,</ span > < span class = "n" > explicit_format</ 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 >
< 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 = "str" > str</ span ></ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Detect the output format from a file extension or explicit format string.</ 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_path</ code >
</ td >
< td >
< code >< span title = "pathlib.Path" > Path</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
< p > Path to the output file.</ p >
</ div >
</ td >
< td >
< em > required</ em >
</ td >
</ tr >
< tr class = "doc-section-item" >
< td >
< code > explicit_format</ code >
</ td >
< td >
< code >< span title = "str" > str</ span > | None</ code >
</ td >
< td >
< div class = "doc-md-description" >
< p > Explicitly specified format, if any.</ p >
</ div >
</ td >
< td >
< code > None</ 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 = "str" > str</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
< p > The detected format string.</ p >
</ div >
</ td >
</ tr >
</ tbody >
</ table >
< p >< span class = "doc-section-title" > Raises:</ span ></ p >
< table >
< thead >
< tr >
< th > Type</ th >
< th > Description</ th >
</ tr >
</ thead >
< tbody >
< tr class = "doc-section-item" >
< td >
< code >< span title = "ValueError" > ValueError</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
< p > If the format cannot be determined.</ p >
</ div >
</ td >
</ tr >
</ tbody >
</ table >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-274" > 274</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-275" > 275</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-276" > 276</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-277" > 277</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-278" > 278</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-279" > 279</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-280" > 280</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-281" > 281</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-282" > 282</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-283" > 283</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-284" > 284</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-285" > 285</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-286" > 286</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-287" > 287</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-288" > 288</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-289" > 289</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-290" > 290</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-291" > 291</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-292" > 292</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-293" > 293</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-294" > 294</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-295" > 295</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-296" > 296</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-297" > 297</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-298" > 298</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-299" > 299</ a ></ span ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-274" name = "__codelineno-0-274" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > detect_format</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-275" name = "__codelineno-0-275" ></ a > < span class = "n" > output_path</ span >< span class = "p" > :</ span > < span class = "n" > Path</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-276" name = "__codelineno-0-276" ></ a > < span class = "n" > explicit_format</ 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-277" name = "__codelineno-0-277" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "nb" > str</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-278" name = "__codelineno-0-278" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Detect the output format from a file extension or explicit format string.</ span >
< a id = "__codelineno-0-279" name = "__codelineno-0-279" ></ a >
< a id = "__codelineno-0-280" name = "__codelineno-0-280" ></ a >< span class = "sd" > Args:</ span >
< a id = "__codelineno-0-281" name = "__codelineno-0-281" ></ a >< span class = "sd" > output_path: Path to the output file.</ span >
< a id = "__codelineno-0-282" name = "__codelineno-0-282" ></ a >< span class = "sd" > explicit_format: Explicitly specified format, if any.</ span >
< a id = "__codelineno-0-283" name = "__codelineno-0-283" ></ a >
< a id = "__codelineno-0-284" name = "__codelineno-0-284" ></ a >< span class = "sd" > Returns:</ span >
< a id = "__codelineno-0-285" name = "__codelineno-0-285" ></ a >< span class = "sd" > The detected format string.</ span >
< a id = "__codelineno-0-286" name = "__codelineno-0-286" ></ a >
< a id = "__codelineno-0-287" name = "__codelineno-0-287" ></ a >< span class = "sd" > Raises:</ span >
< a id = "__codelineno-0-288" name = "__codelineno-0-288" ></ a >< span class = "sd" > ValueError: If the format cannot be determined.</ span >
< a id = "__codelineno-0-289" name = "__codelineno-0-289" ></ a >< span class = "sd" > """ </ span >
< a id = "__codelineno-0-290" name = "__codelineno-0-290" ></ a > < span class = "k" > if</ span > < span class = "n" > explicit_format</ span > < span class = "ow" > is</ span > < span class = "ow" > not</ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-291" name = "__codelineno-0-291" ></ a > < span class = "k" > return</ span > < span class = "n" > explicit_format</ span >
< a id = "__codelineno-0-292" name = "__codelineno-0-292" ></ a > < span class = "n" > suffix</ span > < span class = "o" > =</ span > < span class = "n" > output_path</ span >< span class = "o" > .</ span >< span class = "n" > suffix</ span >< span class = "o" > .</ span >< span class = "n" > lower</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-293" name = "__codelineno-0-293" ></ a > < span class = "k" > if</ span > < span class = "n" > suffix</ span > < span class = "ow" > in</ span > < span class = "n" > _FORMAT_EXTENSIONS</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-294" name = "__codelineno-0-294" ></ a > < span class = "k" > return</ span > < span class = "n" > _FORMAT_EXTENSIONS</ span >< span class = "p" > [</ span >< span class = "n" > suffix</ span >< span class = "p" > ]</ span >
< a id = "__codelineno-0-295" name = "__codelineno-0-295" ></ a > < span class = "n" > msg</ span > < span class = "o" > =</ span > < span class = "p" > (</ span >
< a id = "__codelineno-0-296" name = "__codelineno-0-296" ></ a > < span class = "sa" > f</ span >< span class = "s2" > " Cannot detect format from extension ' </ span >< span class = "si" > {</ span >< span class = "n" > suffix</ span >< span class = "si" > }</ span >< span class = "s2" > ' ." </ span >
< a id = "__codelineno-0-297" name = "__codelineno-0-297" ></ a > < span class = "s2" > " Use --format to specify the output format." </ span >
< a id = "__codelineno-0-298" name = "__codelineno-0-298" ></ a > < span class = "p" > )</ span >
< a id = "__codelineno-0-299" name = "__codelineno-0-299" ></ a > < span class = "k" > raise</ span > < span class = "ne" > ValueError</ span >< span class = "p" > (</ span >< span class = "n" > msg</ span >< span class = "p" > )</ span >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.export_dataframe" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > export_dataframe</ span >
< a href = "#mt5cli.cli.export_dataframe" 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" > export_dataframe</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-2" name = "__codelineno-0-2" href = "#__codelineno-0-2" ></ a > < span class = "n" > df</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "pandas.DataFrame" > DataFrame</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" ></ a > < span class = "n" > output_path</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "pathlib.Path" > Path</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" ></ a > < span class = "n" > output_format</ 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" > table_name</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "str" > str</ span ></ span > < span class = "o" > =</ span > < span class = "s2" > " data" </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-6" name = "__codelineno-0-6" href = "#__codelineno-0-6" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Export a pandas DataFrame to the specified file format.</ 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 > df</ code >
</ td >
< td >
< code >< span title = "pandas.DataFrame" > DataFrame</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
< p > DataFrame to export.</ p >
</ div >
</ td >
< td >
< em > required</ em >
</ td >
</ tr >
< tr class = "doc-section-item" >
< td >
< code > output_path</ code >
</ td >
< td >
< code >< span title = "pathlib.Path" > Path</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
< p > Path to the output file.</ p >
</ div >
</ td >
< td >
< em > required</ em >
</ td >
</ tr >
< tr class = "doc-section-item" >
< td >
< code > output_format</ code >
</ td >
< td >
< code >< span title = "str" > str</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
< p > Output format (csv, json, parquet, or sqlite3).</ p >
</ div >
</ td >
< td >
< em > required</ em >
</ td >
</ tr >
< tr class = "doc-section-item" >
< td >
< code > table_name</ code >
</ td >
< td >
< code >< span title = "str" > str</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
< p > Table name for SQLite3 output.</ p >
</ div >
</ td >
< td >
< code > ' data' </ code >
</ td >
</ tr >
</ tbody >
</ table >
< p >< span class = "doc-section-title" > Raises:</ span ></ p >
< table >
< thead >
< tr >
< th > Type</ th >
< th > Description</ th >
</ tr >
</ thead >
< tbody >
< tr class = "doc-section-item" >
< td >
< code >< span title = "ValueError" > ValueError</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
< p > If the output format is not supported.</ p >
</ div >
</ td >
</ tr >
</ tbody >
</ table >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-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 >
< span class = "normal" >< a href = "#__codelineno-0-319" > 319</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-320" > 320</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-321" > 321</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-322" > 322</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-323" > 323</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-324" > 324</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-325" > 325</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-326" > 326</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-327" > 327</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-328" > 328</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-329" > 329</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-330" > 330</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-331" > 331</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-332" > 332</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-333" > 333</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-334" > 334</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-335" > 335</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-336" > 336</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-337" > 337</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-338" > 338</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-339" > 339</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-340" > 340</ a ></ span ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-302" name = "__codelineno-0-302" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > export_dataframe</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-303" name = "__codelineno-0-303" ></ a > < span class = "n" > df</ span >< span class = "p" > :</ span > < span class = "n" > pd</ span >< span class = "o" > .</ span >< span class = "n" > DataFrame</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-304" name = "__codelineno-0-304" ></ a > < span class = "n" > output_path</ span >< span class = "p" > :</ span > < span class = "n" > Path</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-305" name = "__codelineno-0-305" ></ a > < span class = "n" > output_format</ span >< span class = "p" > :</ span > < span class = "nb" > str</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-306" name = "__codelineno-0-306" ></ a > < span class = "n" > table_name</ span >< span class = "p" > :</ span > < span class = "nb" > str</ span > < span class = "o" > =</ span > < span class = "s2" > " data" </ 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 = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-308" name = "__codelineno-0-308" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Export a pandas DataFrame to the specified file format.</ span >
< a id = "__codelineno-0-309" name = "__codelineno-0-309" ></ a >
< a id = "__codelineno-0-310" name = "__codelineno-0-310" ></ a >< span class = "sd" > Args:</ span >
< a id = "__codelineno-0-311" name = "__codelineno-0-311" ></ a >< span class = "sd" > df: DataFrame to export.</ span >
< a id = "__codelineno-0-312" name = "__codelineno-0-312" ></ a >< span class = "sd" > output_path: Path to the output file.</ span >
< a id = "__codelineno-0-313" name = "__codelineno-0-313" ></ a >< span class = "sd" > output_format: Output format (csv, json, parquet, or sqlite3).</ span >
< a id = "__codelineno-0-314" name = "__codelineno-0-314" ></ a >< span class = "sd" > table_name: Table name for SQLite3 output.</ span >
< a id = "__codelineno-0-315" name = "__codelineno-0-315" ></ a >
< a id = "__codelineno-0-316" name = "__codelineno-0-316" ></ a >< span class = "sd" > Raises:</ span >
< a id = "__codelineno-0-317" name = "__codelineno-0-317" ></ a >< span class = "sd" > ValueError: If the output format is not supported.</ span >
< a id = "__codelineno-0-318" name = "__codelineno-0-318" ></ a >< span class = "sd" > """ </ span >
< a id = "__codelineno-0-319" name = "__codelineno-0-319" ></ a > < span class = "k" > if</ span > < span class = "n" > output_format</ span > < span class = "o" > ==</ span > < span class = "s2" > " csv" </ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-320" name = "__codelineno-0-320" ></ a > < span class = "n" > df</ span >< span class = "o" > .</ span >< span class = "n" > to_csv</ span >< span class = "p" > (</ span >< span class = "n" > output_path</ span >< span class = "p" > ,</ span > < span class = "n" > index</ span >< span class = "o" > =</ span >< span class = "kc" > False</ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-321" name = "__codelineno-0-321" ></ a > < span class = "k" > elif</ span > < span class = "n" > output_format</ span > < span class = "o" > ==</ span > < span class = "s2" > " json" </ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-322" name = "__codelineno-0-322" ></ a > < span class = "n" > df</ span >< span class = "o" > .</ span >< span class = "n" > to_json</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-323" name = "__codelineno-0-323" ></ a > < span class = "n" > output_path</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-324" name = "__codelineno-0-324" ></ a > < span class = "n" > orient</ span >< span class = "o" > =</ span >< span class = "s2" > " records" </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-325" name = "__codelineno-0-325" ></ a > < span class = "n" > date_format</ span >< span class = "o" > =</ span >< span class = "s2" > " iso" </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-326" name = "__codelineno-0-326" ></ a > < span class = "n" > indent</ span >< span class = "o" > =</ span >< span class = "mi" > 2</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-327" name = "__codelineno-0-327" ></ a > < span class = "p" > )</ span >
< a id = "__codelineno-0-328" name = "__codelineno-0-328" ></ a > < span class = "k" > elif</ span > < span class = "n" > output_format</ span > < span class = "o" > ==</ span > < span class = "s2" > " parquet" </ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-329" name = "__codelineno-0-329" ></ a > < span class = "n" > df</ span >< span class = "o" > .</ span >< span class = "n" > to_parquet</ span >< span class = "p" > (</ span >< span class = "n" > output_path</ span >< span class = "p" > ,</ span > < span class = "n" > index</ span >< span class = "o" > =</ span >< span class = "kc" > False</ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-330" name = "__codelineno-0-330" ></ a > < span class = "k" > elif</ span > < span class = "n" > output_format</ span > < span class = "o" > ==</ span > < span class = "s2" > " sqlite3" </ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-331" name = "__codelineno-0-331" ></ 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" > 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-332" name = "__codelineno-0-332" ></ a > < span class = "n" > df</ span >< span class = "o" > .</ span >< span class = "n" > to_sql</ span >< span class = "p" > (</ span > < span class = "c1" > # type: ignore[reportUnknownMemberType]</ span >
< a id = "__codelineno-0-333" name = "__codelineno-0-333" ></ a > < span class = "n" > table_name</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-334" name = "__codelineno-0-334" ></ a > < span class = "n" > conn</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-335" name = "__codelineno-0-335" ></ a > < span class = "n" > if_exists</ span >< span class = "o" > =</ span >< span class = "s2" > " replace" </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-336" name = "__codelineno-0-336" ></ a > < span class = "n" > index</ span >< span class = "o" > =</ span >< span class = "kc" > False</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-337" name = "__codelineno-0-337" ></ a > < span class = "p" > )</ span >
< a id = "__codelineno-0-338" name = "__codelineno-0-338" ></ a > < span class = "k" > else</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-339" name = "__codelineno-0-339" ></ a > < span class = "n" > msg</ span > < span class = "o" > =</ span > < span class = "sa" > f</ span >< span class = "s2" > " Unsupported output format: </ span >< span class = "si" > {</ span >< span class = "n" > output_format</ span >< span class = "si" > }</ span >< span class = "s2" > " </ span >
< a id = "__codelineno-0-340" name = "__codelineno-0-340" ></ a > < span class = "k" > raise</ span > < span class = "ne" > ValueError</ span >< span class = "p" > (</ span >< span class = "n" > msg</ span >< span class = "p" > )</ span >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.history_deals" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > history_deals</ span >
< a href = "#mt5cli.cli.history_deals" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > history_deals</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-2" name = "__codelineno-0-2" href = "#__codelineno-0-2" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typer.Context" > Context</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" ></ a > < span class = "n" > date_from</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" ></ a > < span class = "n" >< span title = "datetime.datetime" > datetime</ span ></ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-5" name = "__codelineno-0-5" href = "#__codelineno-0-5" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-6" name = "__codelineno-0-6" href = "#__codelineno-0-6" ></ a > < span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "DATETIME_TYPE
module-attribute
(mt5cli.cli.DATETIME_TYPE)" href = "#mt5cli.cli.DATETIME_TYPE" > DATETIME_TYPE</ a ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Start date." </ span >
< a id = "__codelineno-0-7" name = "__codelineno-0-7" href = "#__codelineno-0-7" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-8" name = "__codelineno-0-8" href = "#__codelineno-0-8" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-9" name = "__codelineno-0-9" href = "#__codelineno-0-9" ></ a > < span class = "n" > date_to</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-10" name = "__codelineno-0-10" href = "#__codelineno-0-10" ></ a > < span class = "n" >< span title = "datetime.datetime" > datetime</ span ></ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-11" name = "__codelineno-0-11" href = "#__codelineno-0-11" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "DATETIME_TYPE
module-attribute
(mt5cli.cli.DATETIME_TYPE)" href = "#mt5cli.cli.DATETIME_TYPE" > DATETIME_TYPE</ a ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " End date." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-12" name = "__codelineno-0-12" href = "#__codelineno-0-12" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-13" name = "__codelineno-0-13" href = "#__codelineno-0-13" ></ a > < span class = "n" > group</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-14" name = "__codelineno-0-14" href = "#__codelineno-0-14" ></ a > < span class = "n" >< span title = "str" > str</ span ></ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Group filter." </ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-15" name = "__codelineno-0-15" href = "#__codelineno-0-15" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-16" name = "__codelineno-0-16" href = "#__codelineno-0-16" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-17" name = "__codelineno-0-17" href = "#__codelineno-0-17" ></ a > < span class = "n" >< span title = "str" > str</ span ></ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol filter." </ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-18" name = "__codelineno-0-18" href = "#__codelineno-0-18" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-19" name = "__codelineno-0-19" href = "#__codelineno-0-19" ></ a > < span class = "n" > ticket</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-20" name = "__codelineno-0-20" href = "#__codelineno-0-20" ></ a > < span class = "n" >< span title = "int" > int</ span ></ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Order ticket." </ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-21" name = "__codelineno-0-21" href = "#__codelineno-0-21" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-22" name = "__codelineno-0-22" href = "#__codelineno-0-22" ></ a > < span class = "n" > position</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-23" name = "__codelineno-0-23" href = "#__codelineno-0-23" ></ a > < span class = "n" >< span title = "int" > int</ span ></ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Position ticket." </ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-24" name = "__codelineno-0-24" href = "#__codelineno-0-24" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-25" name = "__codelineno-0-25" href = "#__codelineno-0-25" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
2026-05-28 16:23:36 +00:00
< p > Export historical deals.</ p >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-828" > 828</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-829" > 829</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-830" > 830</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-831" > 831</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-832" > 832</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-833" > 833</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-834" > 834</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-835" > 835</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-836" > 836</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-837" > 837</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-838" > 838</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-839" > 839</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-840" > 840</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-841" > 841</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-842" > 842</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-843" > 843</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-844" > 844</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-845" > 845</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-846" > 846</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-847" > 847</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-848" > 848</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-849" > 849</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-850" > 850</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-851" > 851</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-852" > 852</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-853" > 853</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-854" > 854</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-855" > 855</ a ></ span ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-828" name = "__codelineno-0-828" ></ a >< span class = "nd" > @app</ span >< span class = "o" > .</ span >< span class = "n" > command</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-829" name = "__codelineno-0-829" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > history_deals</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-830" name = "__codelineno-0-830" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Context</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-831" name = "__codelineno-0-831" ></ a > < span class = "n" > date_from</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-832" name = "__codelineno-0-832" ></ a > < span class = "n" > datetime</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-833" name = "__codelineno-0-833" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > DATETIME_TYPE</ span >< span class = "p" > ,</ span > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Start date." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-834" name = "__codelineno-0-834" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-835" name = "__codelineno-0-835" ></ a > < span class = "n" > date_to</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-836" name = "__codelineno-0-836" ></ a > < span class = "n" > datetime</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-837" name = "__codelineno-0-837" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > DATETIME_TYPE</ span >< span class = "p" > ,</ span > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " End date." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-838" name = "__codelineno-0-838" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-839" name = "__codelineno-0-839" ></ a > < span class = "n" > group</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > str</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Group filter." </ span >< span class = "p" > )]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-840" name = "__codelineno-0-840" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > str</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol filter." </ span >< span class = "p" > )]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-841" name = "__codelineno-0-841" ></ a > < span class = "n" > ticket</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > int</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Order ticket." </ span >< span class = "p" > )]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-842" name = "__codelineno-0-842" ></ a > < span class = "n" > position</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > int</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Position ticket." </ span >< span class = "p" > )]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-843" name = "__codelineno-0-843" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-844" name = "__codelineno-0-844" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Export historical deals.""" </ span >
< a id = "__codelineno-0-845" name = "__codelineno-0-845" ></ a > < span class = "n" > _execute_export</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-846" name = "__codelineno-0-846" ></ a > < span class = "n" > ctx</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-847" name = "__codelineno-0-847" ></ 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-848" name = "__codelineno-0-848" ></ 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-849" name = "__codelineno-0-849" ></ 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-850" name = "__codelineno-0-850" ></ a > < span class = "n" > group</ span >< span class = "o" > =</ span >< span class = "n" > group</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-851" name = "__codelineno-0-851" ></ a > < span class = "n" > symbol</ span >< span class = "o" > =</ span >< span class = "n" > symbol</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-852" name = "__codelineno-0-852" ></ a > < span class = "n" > ticket</ span >< span class = "o" > =</ span >< span class = "n" > ticket</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-853" name = "__codelineno-0-853" ></ a > < span class = "n" > position</ span >< span class = "o" > =</ span >< span class = "n" > position</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-854" name = "__codelineno-0-854" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-855" name = "__codelineno-0-855" ></ a > < span class = "p" > )</ span >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.history_orders" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > history_orders</ span >
< a href = "#mt5cli.cli.history_orders" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > history_orders</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-2" name = "__codelineno-0-2" href = "#__codelineno-0-2" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typer.Context" > Context</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" ></ a > < span class = "n" > date_from</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" ></ a > < span class = "n" >< span title = "datetime.datetime" > datetime</ span ></ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-5" name = "__codelineno-0-5" href = "#__codelineno-0-5" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-6" name = "__codelineno-0-6" href = "#__codelineno-0-6" ></ a > < span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "DATETIME_TYPE
module-attribute
(mt5cli.cli.DATETIME_TYPE)" href = "#mt5cli.cli.DATETIME_TYPE" > DATETIME_TYPE</ a ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Start date." </ span >
< a id = "__codelineno-0-7" name = "__codelineno-0-7" href = "#__codelineno-0-7" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-8" name = "__codelineno-0-8" href = "#__codelineno-0-8" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-9" name = "__codelineno-0-9" href = "#__codelineno-0-9" ></ a > < span class = "n" > date_to</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-10" name = "__codelineno-0-10" href = "#__codelineno-0-10" ></ a > < span class = "n" >< span title = "datetime.datetime" > datetime</ span ></ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-11" name = "__codelineno-0-11" href = "#__codelineno-0-11" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "DATETIME_TYPE
module-attribute
(mt5cli.cli.DATETIME_TYPE)" href = "#mt5cli.cli.DATETIME_TYPE" > DATETIME_TYPE</ a ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " End date." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-12" name = "__codelineno-0-12" href = "#__codelineno-0-12" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-13" name = "__codelineno-0-13" href = "#__codelineno-0-13" ></ a > < span class = "n" > group</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-14" name = "__codelineno-0-14" href = "#__codelineno-0-14" ></ a > < span class = "n" >< span title = "str" > str</ span ></ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Group filter." </ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-15" name = "__codelineno-0-15" href = "#__codelineno-0-15" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-16" name = "__codelineno-0-16" href = "#__codelineno-0-16" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-17" name = "__codelineno-0-17" href = "#__codelineno-0-17" ></ a > < span class = "n" >< span title = "str" > str</ span ></ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol filter." </ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-18" name = "__codelineno-0-18" href = "#__codelineno-0-18" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-19" name = "__codelineno-0-19" href = "#__codelineno-0-19" ></ a > < span class = "n" > ticket</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-20" name = "__codelineno-0-20" href = "#__codelineno-0-20" ></ a > < span class = "n" >< span title = "int" > int</ span ></ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Order ticket." </ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-21" name = "__codelineno-0-21" href = "#__codelineno-0-21" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-22" name = "__codelineno-0-22" href = "#__codelineno-0-22" ></ a > < span class = "n" > position</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-23" name = "__codelineno-0-23" href = "#__codelineno-0-23" ></ a > < span class = "n" >< span title = "int" > int</ span ></ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Position ticket." </ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-24" name = "__codelineno-0-24" href = "#__codelineno-0-24" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-25" name = "__codelineno-0-25" href = "#__codelineno-0-25" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Export historical orders.</ p >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-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 ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-798" name = "__codelineno-0-798" ></ a >< span class = "nd" > @app</ span >< span class = "o" > .</ span >< span class = "n" > command</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-799" name = "__codelineno-0-799" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > history_orders</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-800" name = "__codelineno-0-800" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Context</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-801" name = "__codelineno-0-801" ></ a > < span class = "n" > date_from</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-802" name = "__codelineno-0-802" ></ a > < span class = "n" > datetime</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-803" name = "__codelineno-0-803" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > DATETIME_TYPE</ span >< span class = "p" > ,</ span > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Start date." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-804" name = "__codelineno-0-804" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-805" name = "__codelineno-0-805" ></ a > < span class = "n" > date_to</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-806" name = "__codelineno-0-806" ></ a > < span class = "n" > datetime</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-807" name = "__codelineno-0-807" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > DATETIME_TYPE</ span >< span class = "p" > ,</ span > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " End date." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-808" name = "__codelineno-0-808" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-809" name = "__codelineno-0-809" ></ a > < span class = "n" > group</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > str</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Group filter." </ span >< span class = "p" > )]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-810" name = "__codelineno-0-810" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > str</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol filter." </ span >< span class = "p" > )]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-811" name = "__codelineno-0-811" ></ a > < span class = "n" > ticket</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > int</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Order ticket." </ span >< span class = "p" > )]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-812" name = "__codelineno-0-812" ></ a > < span class = "n" > position</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > int</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Position ticket." </ span >< span class = "p" > )]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-813" name = "__codelineno-0-813" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-814" name = "__codelineno-0-814" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Export historical orders.""" </ span >
< a id = "__codelineno-0-815" name = "__codelineno-0-815" ></ a > < span class = "n" > _execute_export</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-816" name = "__codelineno-0-816" ></ a > < span class = "n" > ctx</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-817" name = "__codelineno-0-817" ></ 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-818" name = "__codelineno-0-818" ></ 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-819" name = "__codelineno-0-819" ></ 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-820" name = "__codelineno-0-820" ></ a > < span class = "n" > group</ span >< span class = "o" > =</ span >< span class = "n" > group</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-821" name = "__codelineno-0-821" ></ a > < span class = "n" > symbol</ span >< span class = "o" > =</ span >< span class = "n" > symbol</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-822" name = "__codelineno-0-822" ></ a > < span class = "n" > ticket</ span >< span class = "o" > =</ span >< span class = "n" > ticket</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-823" name = "__codelineno-0-823" ></ a > < span class = "n" > position</ span >< span class = "o" > =</ span >< span class = "n" > position</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-824" name = "__codelineno-0-824" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-825" name = "__codelineno-0-825" ></ a > < span class = "p" > )</ span >
2026-04-26 12:50:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.last_error" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > last_error</ span >
< a href = "#mt5cli.cli.last_error" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > last_error</ span >< span class = "p" > (</ span >< span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typer.Context" > Context</ span ></ span >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Export the last error information.</ p >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-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 ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-864" name = "__codelineno-0-864" ></ a >< span class = "nd" > @app</ span >< span class = "o" > .</ span >< span class = "n" > command</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-865" name = "__codelineno-0-865" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > last_error</ span >< span class = "p" > (</ span >< span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Context</ span >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-866" name = "__codelineno-0-866" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Export the last error information.""" </ span >
< a id = "__codelineno-0-867" name = "__codelineno-0-867" ></ a > < span class = "n" > _execute_export</ span >< span class = "p" > (</ span >< span class = "n" > ctx</ span >< span class = "p" > ,</ span > < span class = "k" > lambda</ span > < span class = "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 >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.main" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > main</ span >
< a href = "#mt5cli.cli.main" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > main</ span >< span class = "p" > ()</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Run the mt5cli CLI.</ p >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-1450" > 1450</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1451" > 1451</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-1452" > 1452</ a ></ span ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-1450" name = "__codelineno-0-1450" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > main</ span >< span class = "p" > ()</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-1451" name = "__codelineno-0-1451" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Run the mt5cli CLI.""" </ span >
< a id = "__codelineno-0-1452" name = "__codelineno-0-1452" ></ a > < span class = "n" > app</ span >< span class = "p" > ()</ span >
2026-04-26 12:50:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.market_book" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > market_book</ span >
< a href = "#mt5cli.cli.market_book" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > market_book</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-2" name = "__codelineno-0-2" href = "#__codelineno-0-2" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typer.Context" > Context</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >< span class = "n" >< span title = "str" > str</ span ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol name." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Export market depth (order book) for a symbol.</ p >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-882" > 882</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-883" > 883</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-884" > 884</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-885" > 885</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-886" > 886</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-887" > 887</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-888" > 888</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-889" > 889</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-890" > 890</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-891" > 891</ a ></ span ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-882" name = "__codelineno-0-882" ></ a >< span class = "nd" > @app</ span >< span class = "o" > .</ span >< span class = "n" > command</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-883" name = "__codelineno-0-883" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > market_book</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-884" name = "__codelineno-0-884" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Context</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-885" name = "__codelineno-0-885" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > str</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol name." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-886" name = "__codelineno-0-886" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-887" name = "__codelineno-0-887" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Export market depth (order book) for a symbol.""" </ span >
< a id = "__codelineno-0-888" name = "__codelineno-0-888" ></ a > < span class = "n" > _execute_export</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-889" name = "__codelineno-0-889" ></ a > < span class = "n" > ctx</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-890" name = "__codelineno-0-890" ></ 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" > 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 >
< a id = "__codelineno-0-891" name = "__codelineno-0-891" ></ a > < span class = "p" > )</ span >
2026-04-26 12:50:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.order_check" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > order_check</ span >
< a href = "#mt5cli.cli.order_check" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > order_check</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-2" name = "__codelineno-0-2" href = "#__codelineno-0-2" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typer.Context" > Context</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" ></ a > < span class = "n" > request</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" ></ a > < span class = "n" >< span title = "dict" > dict</ span ></ span >< span class = "p" > [</ span >< span class = "n" >< span title = "str" > str</ span ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typing.Any" > Any</ span ></ span >< span class = "p" > ],</ span >
< a id = "__codelineno-0-5" name = "__codelineno-0-5" href = "#__codelineno-0-5" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-6" name = "__codelineno-0-6" href = "#__codelineno-0-6" ></ a > < span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "REQUEST_TYPE
module-attribute
(mt5cli.cli.REQUEST_TYPE)" href = "#mt5cli.cli.REQUEST_TYPE" > REQUEST_TYPE</ a ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-7" name = "__codelineno-0-7" href = "#__codelineno-0-7" ></ a > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< span title = "mt5cli.cli._REQUEST_OPTION_HELP" > _REQUEST_OPTION_HELP</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-8" name = "__codelineno-0-8" href = "#__codelineno-0-8" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-9" name = "__codelineno-0-9" href = "#__codelineno-0-9" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-10" name = "__codelineno-0-10" href = "#__codelineno-0-10" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Check funds sufficiency for a trading operation.</ p >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-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 ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-894" name = "__codelineno-0-894" ></ a >< span class = "nd" > @app</ span >< span class = "o" > .</ span >< span class = "n" > command</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-895" name = "__codelineno-0-895" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > order_check</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-896" name = "__codelineno-0-896" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Context</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-897" name = "__codelineno-0-897" ></ a > < span class = "n" > request</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-898" name = "__codelineno-0-898" ></ a > < span class = "nb" > dict</ span >< span class = "p" > [</ span >< span class = "nb" > str</ span >< span class = "p" > ,</ span > < span class = "n" > Any</ span >< span class = "p" > ],</ span >
< a id = "__codelineno-0-899" name = "__codelineno-0-899" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > REQUEST_TYPE</ span >< span class = "p" > ,</ span > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "n" > _REQUEST_OPTION_HELP</ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-900" name = "__codelineno-0-900" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-901" name = "__codelineno-0-901" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-902" name = "__codelineno-0-902" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Check funds sufficiency for a trading operation.""" </ span >
< a id = "__codelineno-0-903" name = "__codelineno-0-903" ></ a > < span class = "n" > _execute_export</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-904" name = "__codelineno-0-904" ></ a > < span class = "n" > ctx</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-905" name = "__codelineno-0-905" ></ a > < span class = "k" > lambda</ span > < span class = "n" > c</ span >< span class = "p" > :</ span > < span class = "n" > c</ span >< span class = "o" > .</ span >< span class = "n" > order_check_as_df</ span >< span class = "p" > (</ span >< span class = "n" > request</ span >< span class = "o" > =</ span >< span class = "n" > request</ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-906" name = "__codelineno-0-906" ></ a > < span class = "p" > )</ span >
2026-04-26 12:50:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.order_send" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > order_send</ span >
< a href = "#mt5cli.cli.order_send" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > order_send</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-2" name = "__codelineno-0-2" href = "#__codelineno-0-2" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typer.Context" > Context</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" ></ a > < span class = "n" > request</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" ></ a > < span class = "n" >< span title = "dict" > dict</ span ></ span >< span class = "p" > [</ span >< span class = "n" >< span title = "str" > str</ span ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typing.Any" > Any</ span ></ span >< span class = "p" > ],</ span >
< a id = "__codelineno-0-5" name = "__codelineno-0-5" href = "#__codelineno-0-5" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-6" name = "__codelineno-0-6" href = "#__codelineno-0-6" ></ a > < span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "REQUEST_TYPE
module-attribute
(mt5cli.cli.REQUEST_TYPE)" href = "#mt5cli.cli.REQUEST_TYPE" > REQUEST_TYPE</ a ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-7" name = "__codelineno-0-7" href = "#__codelineno-0-7" ></ a > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< span title = "mt5cli.cli._REQUEST_OPTION_HELP" > _REQUEST_OPTION_HELP</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-8" name = "__codelineno-0-8" href = "#__codelineno-0-8" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-9" name = "__codelineno-0-9" href = "#__codelineno-0-9" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-10" name = "__codelineno-0-10" href = "#__codelineno-0-10" ></ a > < span class = "n" > yes</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-11" name = "__codelineno-0-11" href = "#__codelineno-0-11" ></ a > < span class = "n" >< span title = "bool" > bool</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-12" name = "__codelineno-0-12" href = "#__codelineno-0-12" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-13" name = "__codelineno-0-13" href = "#__codelineno-0-13" ></ a > < span class = "s2" > " --yes" </ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Confirm the live trade request." </ span >
< a id = "__codelineno-0-14" name = "__codelineno-0-14" href = "#__codelineno-0-14" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-15" name = "__codelineno-0-15" href = "#__codelineno-0-15" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > False</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-16" name = "__codelineno-0-16" href = "#__codelineno-0-16" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Send a trading operation request to the trade server.</ p >
< p >< span class = "doc-section-title" > Raises:</ span ></ p >
< table >
< thead >
< tr >
< th > Type</ th >
< th > Description</ th >
</ tr >
</ thead >
< tbody >
< tr class = "doc-section-item" >
< td >
< code >< span title = "typer.BadParameter" > BadParameter</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
< p > If --yes is not provided.</ p >
</ div >
</ td >
</ tr >
</ tbody >
</ table >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-909" > 909</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-910" > 910</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-911" > 911</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-912" > 912</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-913" > 913</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-914" > 914</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-915" > 915</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-916" > 916</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-917" > 917</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-918" > 918</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-919" > 919</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-920" > 920</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-921" > 921</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-922" > 922</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-923" > 923</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-924" > 924</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-925" > 925</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-926" > 926</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-927" > 927</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-928" > 928</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-929" > 929</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-930" > 930</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-931" > 931</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-932" > 932</ a ></ span ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-909" name = "__codelineno-0-909" ></ a >< span class = "nd" > @app</ span >< span class = "o" > .</ span >< span class = "n" > command</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-910" name = "__codelineno-0-910" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > order_send</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-911" name = "__codelineno-0-911" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Context</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-912" name = "__codelineno-0-912" ></ a > < span class = "n" > request</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-913" name = "__codelineno-0-913" ></ a > < span class = "nb" > dict</ span >< span class = "p" > [</ span >< span class = "nb" > str</ span >< span class = "p" > ,</ span > < span class = "n" > Any</ span >< span class = "p" > ],</ span >
< a id = "__codelineno-0-914" name = "__codelineno-0-914" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > REQUEST_TYPE</ span >< span class = "p" > ,</ span > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "n" > _REQUEST_OPTION_HELP</ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-915" name = "__codelineno-0-915" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-916" name = "__codelineno-0-916" ></ a > < span class = "n" > yes</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-917" name = "__codelineno-0-917" ></ a > < span class = "nb" > bool</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-918" name = "__codelineno-0-918" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "s2" > " --yes" </ span >< span class = "p" > ,</ span > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Confirm the live trade request." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-919" name = "__codelineno-0-919" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > False</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-920" name = "__codelineno-0-920" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-921" name = "__codelineno-0-921" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Send a trading operation request to the trade server.</ span >
< a id = "__codelineno-0-922" name = "__codelineno-0-922" ></ a >
< a id = "__codelineno-0-923" name = "__codelineno-0-923" ></ a >< span class = "sd" > Raises:</ span >
< a id = "__codelineno-0-924" name = "__codelineno-0-924" ></ a >< span class = "sd" > typer.BadParameter: If --yes is not provided.</ span >
< a id = "__codelineno-0-925" name = "__codelineno-0-925" ></ a >< span class = "sd" > """ </ span >
< a id = "__codelineno-0-926" name = "__codelineno-0-926" ></ a > < span class = "k" > if</ span > < span class = "ow" > not</ span > < span class = "n" > yes</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-927" name = "__codelineno-0-927" ></ a > < span class = "n" > msg</ span > < span class = "o" > =</ span > < span class = "s2" > " Pass --yes to send a live trade request." </ span >
< a id = "__codelineno-0-928" name = "__codelineno-0-928" ></ a > < span class = "k" > raise</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > BadParameter</ span >< span class = "p" > (</ span >< span class = "n" > msg</ span >< span class = "p" > ,</ span > < span class = "n" > param_hint</ span >< span class = "o" > =</ span >< span class = "s2" > " --yes" </ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-929" name = "__codelineno-0-929" ></ a > < span class = "n" > _execute_export</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-930" name = "__codelineno-0-930" ></ a > < span class = "n" > ctx</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-931" name = "__codelineno-0-931" ></ a > < span class = "k" > lambda</ span > < span class = "n" > c</ span >< span class = "p" > :</ span > < span class = "n" > c</ span >< span class = "o" > .</ span >< span class = "n" > order_send_as_df</ span >< span class = "p" > (</ span >< span class = "n" > request</ span >< span class = "o" > =</ span >< span class = "n" > request</ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-932" name = "__codelineno-0-932" ></ a > < span class = "p" > )</ span >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.orders" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > orders</ span >
< a href = "#mt5cli.cli.orders" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > orders</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-2" name = "__codelineno-0-2" href = "#__codelineno-0-2" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typer.Context" > Context</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" ></ a > < span class = "n" >< span title = "str" > str</ span ></ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol filter." </ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-5" name = "__codelineno-0-5" href = "#__codelineno-0-5" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-6" name = "__codelineno-0-6" href = "#__codelineno-0-6" ></ a > < span class = "n" > group</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-7" name = "__codelineno-0-7" href = "#__codelineno-0-7" ></ a > < span class = "n" >< span title = "str" > str</ span ></ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Group filter." </ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-8" name = "__codelineno-0-8" href = "#__codelineno-0-8" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-9" name = "__codelineno-0-9" href = "#__codelineno-0-9" ></ a > < span class = "n" > ticket</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-10" name = "__codelineno-0-10" href = "#__codelineno-0-10" ></ a > < span class = "n" >< span title = "int" > int</ span ></ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Ticket filter." </ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-11" name = "__codelineno-0-11" href = "#__codelineno-0-11" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-12" name = "__codelineno-0-12" href = "#__codelineno-0-12" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Export active orders.</ p >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-762" > 762</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-763" > 763</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-764" > 764</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-765" > 765</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-766" > 766</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-767" > 767</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-768" > 768</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-769" > 769</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-770" > 770</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-771" > 771</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-772" > 772</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-773" > 773</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-774" > 774</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-775" > 775</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-776" > 776</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-777" > 777</ a ></ span ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-762" name = "__codelineno-0-762" ></ a >< span class = "nd" > @app</ span >< span class = "o" > .</ span >< span class = "n" > command</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-763" name = "__codelineno-0-763" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > orders</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-764" name = "__codelineno-0-764" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Context</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-765" name = "__codelineno-0-765" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > str</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol filter." </ span >< span class = "p" > )]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-766" name = "__codelineno-0-766" ></ a > < span class = "n" > group</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > str</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Group filter." </ span >< span class = "p" > )]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-767" name = "__codelineno-0-767" ></ a > < span class = "n" > ticket</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > int</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Ticket filter." </ span >< span class = "p" > )]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-768" name = "__codelineno-0-768" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-769" name = "__codelineno-0-769" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Export active orders.""" </ span >
< a id = "__codelineno-0-770" name = "__codelineno-0-770" ></ a > < span class = "n" > _execute_export</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-771" name = "__codelineno-0-771" ></ a > < span class = "n" > ctx</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-772" name = "__codelineno-0-772" ></ 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-773" name = "__codelineno-0-773" ></ a > < span class = "n" > symbol</ span >< span class = "o" > =</ span >< span class = "n" > symbol</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-774" name = "__codelineno-0-774" ></ a > < span class = "n" > group</ span >< span class = "o" > =</ span >< span class = "n" > group</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-775" name = "__codelineno-0-775" ></ a > < span class = "n" > ticket</ span >< span class = "o" > =</ span >< span class = "n" > ticket</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-776" name = "__codelineno-0-776" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-777" name = "__codelineno-0-777" ></ a > < span class = "p" > )</ span >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.parse_datetime" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > parse_datetime</ span >
< a href = "#mt5cli.cli.parse_datetime" 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" > parse_datetime</ span >< span class = "p" > (</ span >< span class = "n" > value</ 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 = "datetime.datetime" > datetime</ span ></ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Parse an ISO 8601 datetime string to a timezone-aware datetime.</ 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 > value</ code >
</ td >
< td >
< code >< span title = "str" > str</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
< p > ISO 8601 datetime string (e.g., '2024-01-01' or
'2024-01-01T12:00:00+00:00').</ 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 = "datetime.datetime" > datetime</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
< p > Parsed datetime with UTC timezone if no timezone is specified.</ p >
</ div >
</ td >
</ tr >
</ tbody >
</ table >
< p >< span class = "doc-section-title" > Raises:</ span ></ p >
< table >
< thead >
< tr >
< th > Type</ th >
< th > Description</ th >
</ tr >
</ thead >
< tbody >
< tr class = "doc-section-item" >
< td >
< code >< span title = "ValueError" > ValueError</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
< p > If the string cannot be parsed.</ p >
</ div >
</ td >
</ tr >
</ tbody >
</ table >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-343" > 343</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-344" > 344</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-345" > 345</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-346" > 346</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-347" > 347</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-348" > 348</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-349" > 349</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-350" > 350</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-351" > 351</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-352" > 352</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-353" > 353</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-354" > 354</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-355" > 355</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-356" > 356</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-357" > 357</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-358" > 358</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-359" > 359</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-360" > 360</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-361" > 361</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-362" > 362</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-363" > 363</ a ></ span ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-343" name = "__codelineno-0-343" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > parse_datetime</ span >< span class = "p" > (</ span >< span class = "n" > value</ span >< span class = "p" > :</ span > < span class = "nb" > str</ span >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "n" > datetime</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-344" name = "__codelineno-0-344" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Parse an ISO 8601 datetime string to a timezone-aware datetime.</ span >
< a id = "__codelineno-0-345" name = "__codelineno-0-345" ></ a >
< a id = "__codelineno-0-346" name = "__codelineno-0-346" ></ a >< span class = "sd" > Args:</ span >
< a id = "__codelineno-0-347" name = "__codelineno-0-347" ></ a >< span class = "sd" > value: ISO 8601 datetime string (e.g., ' 2024-01-01' or</ span >
< a id = "__codelineno-0-348" name = "__codelineno-0-348" ></ a >< span class = "sd" > ' 2024-01-01T12:00:00+00:00' ).</ span >
< a id = "__codelineno-0-349" name = "__codelineno-0-349" ></ a >
< a id = "__codelineno-0-350" name = "__codelineno-0-350" ></ a >< span class = "sd" > Returns:</ span >
< a id = "__codelineno-0-351" name = "__codelineno-0-351" ></ a >< span class = "sd" > Parsed datetime with UTC timezone if no timezone is specified.</ span >
< a id = "__codelineno-0-352" name = "__codelineno-0-352" ></ a >
< a id = "__codelineno-0-353" name = "__codelineno-0-353" ></ a >< span class = "sd" > Raises:</ span >
< a id = "__codelineno-0-354" name = "__codelineno-0-354" ></ a >< span class = "sd" > ValueError: If the string cannot be parsed.</ span >
< a id = "__codelineno-0-355" name = "__codelineno-0-355" ></ a >< span class = "sd" > """ </ span >
< a id = "__codelineno-0-356" name = "__codelineno-0-356" ></ a > < span class = "k" > try</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-357" name = "__codelineno-0-357" ></ a > < span class = "n" > dt</ span > < span class = "o" > =</ span > < span class = "n" > datetime</ span >< span class = "o" > .</ span >< span class = "n" > fromisoformat</ span >< span class = "p" > (</ span >< span class = "n" > value</ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-358" name = "__codelineno-0-358" ></ a > < span class = "k" > except</ span > < span class = "ne" > ValueError</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-359" name = "__codelineno-0-359" ></ a > < span class = "n" > msg</ span > < span class = "o" > =</ span > < span class = "sa" > f</ span >< span class = "s2" > " Invalid datetime format: ' </ span >< span class = "si" > {</ span >< span class = "n" > value</ span >< span class = "si" > }</ span >< span class = "s2" > ' . Use ISO 8601 format." </ span >
< a id = "__codelineno-0-360" name = "__codelineno-0-360" ></ a > < span class = "k" > raise</ span > < span class = "ne" > ValueError</ span >< span class = "p" > (</ span >< span class = "n" > msg</ span >< span class = "p" > )</ span > < span class = "kn" > from</ span >< span class = "w" > </ span >< span class = "kc" > None</ span >
< a id = "__codelineno-0-361" name = "__codelineno-0-361" ></ a > < span class = "k" > if</ span > < span class = "n" > dt</ span >< span class = "o" > .</ span >< span class = "n" > tzinfo</ span > < span class = "ow" > is</ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-362" name = "__codelineno-0-362" ></ a > < span class = "n" > dt</ span > < span class = "o" > =</ span > < span class = "n" > dt</ span >< span class = "o" > .</ span >< span class = "n" > replace</ span >< span class = "p" > (</ span >< span class = "n" > tzinfo</ span >< span class = "o" > =</ span >< span class = "n" > UTC</ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-363" name = "__codelineno-0-363" ></ a > < span class = "k" > return</ span > < span class = "n" > dt</ span >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
2026-04-26 12:50:38 +00:00
< h3 id = "mt5cli.cli.parse_request" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > parse_request</ span >
2026-04-22 17:11:38 +00:00
2026-04-26 12:50:38 +00:00
< a href = "#mt5cli.cli.parse_request" 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" > parse_request</ span >< span class = "p" > (</ span >< span class = "n" > value</ 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 = "dict" > dict</ span ></ span >< span class = "p" > [</ span >< span class = "n" >< span title = "str" > str</ span ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typing.Any" > Any</ span ></ span >< span class = "p" > ]</ span >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
2026-04-26 12:50:38 +00:00
< p > Parse a JSON-formatted order request string or file reference.</ p >
2026-04-22 17:11:38 +00:00
< 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 > value</ code >
</ td >
< td >
< code >< span title = "str" > str</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
2026-04-26 12:50:38 +00:00
< p > JSON object string, or '@path' to read JSON from a file.</ p >
2026-04-22 17:11:38 +00:00
</ 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 >
2026-04-26 12:50:38 +00:00
< code >< span title = "dict" > dict</ span > [< span title = "str" > str</ span > , < span title = "typing.Any" > Any</ span > ]</ code >
2026-04-22 17:11:38 +00:00
</ td >
< td >
< div class = "doc-md-description" >
2026-04-26 12:50:38 +00:00
< p > Parsed request dictionary.</ p >
2026-04-22 17:11:38 +00:00
</ div >
</ td >
</ tr >
</ tbody >
</ table >
< p >< span class = "doc-section-title" > Raises:</ span ></ p >
< table >
< thead >
< tr >
< th > Type</ th >
< th > Description</ th >
</ tr >
</ thead >
< tbody >
< tr class = "doc-section-item" >
< td >
< code >< span title = "ValueError" > ValueError</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
2026-04-26 12:50:38 +00:00
< p > If the request file cannot be read or the value is not a
JSON object.</ p >
2026-04-22 17:11:38 +00:00
</ div >
</ td >
</ tr >
</ tbody >
</ table >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-416" > 416</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-417" > 417</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-418" > 418</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-419" > 419</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-420" > 420</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-421" > 421</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-422" > 422</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-423" > 423</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-424" > 424</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-425" > 425</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-426" > 426</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-427" > 427</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-428" > 428</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-429" > 429</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-430" > 430</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-431" > 431</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-432" > 432</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-433" > 433</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-434" > 434</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-435" > 435</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-436" > 436</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-437" > 437</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-438" > 438</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-439" > 439</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-440" > 440</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-441" > 441</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-442" > 442</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-443" > 443</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-444" > 444</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-445" > 445</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-446" > 446</ a ></ span ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-416" name = "__codelineno-0-416" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > parse_request</ span >< span class = "p" > (</ span >< span class = "n" > value</ span >< span class = "p" > :</ span > < span class = "nb" > str</ span >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "nb" > dict</ span >< span class = "p" > [</ span >< span class = "nb" > str</ span >< span class = "p" > ,</ span > < span class = "n" > Any</ span >< span class = "p" > ]:</ span >
< a id = "__codelineno-0-417" name = "__codelineno-0-417" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Parse a JSON-formatted order request string or file reference.</ span >
< a id = "__codelineno-0-418" name = "__codelineno-0-418" ></ a >
< a id = "__codelineno-0-419" name = "__codelineno-0-419" ></ a >< span class = "sd" > Args:</ span >
< a id = "__codelineno-0-420" name = "__codelineno-0-420" ></ a >< span class = "sd" > value: JSON object string, or ' @path' to read JSON from a file.</ span >
< a id = "__codelineno-0-421" name = "__codelineno-0-421" ></ a >
< a id = "__codelineno-0-422" name = "__codelineno-0-422" ></ a >< span class = "sd" > Returns:</ span >
< a id = "__codelineno-0-423" name = "__codelineno-0-423" ></ a >< span class = "sd" > Parsed request dictionary.</ span >
< a id = "__codelineno-0-424" name = "__codelineno-0-424" ></ a >
< a id = "__codelineno-0-425" name = "__codelineno-0-425" ></ a >< span class = "sd" > Raises:</ span >
< a id = "__codelineno-0-426" name = "__codelineno-0-426" ></ a >< span class = "sd" > ValueError: If the request file cannot be read or the value is not a</ span >
< a id = "__codelineno-0-427" name = "__codelineno-0-427" ></ a >< span class = "sd" > JSON object.</ span >
< a id = "__codelineno-0-428" name = "__codelineno-0-428" ></ a >< span class = "sd" > """ </ span >
< a id = "__codelineno-0-429" name = "__codelineno-0-429" ></ a > < span class = "k" > if</ span > < span class = "n" > value</ span >< span class = "o" > .</ span >< span class = "n" > startswith</ span >< span class = "p" > (</ span >< span class = "s2" > " @" </ span >< span class = "p" > ):</ span >
< a id = "__codelineno-0-430" name = "__codelineno-0-430" ></ a > < span class = "n" > path</ span > < span class = "o" > =</ span > < span class = "n" > Path</ span >< span class = "p" > (</ span >< span class = "n" > value</ span >< span class = "p" > [</ span >< span class = "mi" > 1</ span >< span class = "p" > :])</ span >
< a id = "__codelineno-0-431" name = "__codelineno-0-431" ></ a > < span class = "k" > try</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-432" name = "__codelineno-0-432" ></ a > < span class = "n" > text</ span > < span class = "o" > =</ span > < span class = "n" > path</ span >< span class = "o" > .</ span >< span class = "n" > read_text</ span >< span class = "p" > (</ span >< span class = "n" > encoding</ span >< span class = "o" > =</ span >< span class = "s2" > " utf-8" </ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-433" name = "__codelineno-0-433" ></ a > < span class = "k" > except</ span > < span class = "p" > (</ span >< span class = "ne" > OSError</ span >< span class = "p" > ,</ span > < span class = "ne" > UnicodeDecodeError</ span >< span class = "p" > )</ span > < span class = "k" > as</ span > < span class = "n" > exc</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-434" name = "__codelineno-0-434" ></ a > < span class = "n" > msg</ span > < span class = "o" > =</ span > < span class = "sa" > f</ span >< span class = "s2" > " Failed to read JSON request file ' </ span >< span class = "si" > {</ span >< span class = "n" > path</ span >< span class = "si" > }</ span >< span class = "s2" > ' : </ span >< span class = "si" > {</ span >< span class = "n" > exc</ span >< span class = "si" > }</ span >< span class = "s2" > " </ span >
< a id = "__codelineno-0-435" name = "__codelineno-0-435" ></ a > < span class = "k" > raise</ span > < span class = "ne" > ValueError</ span >< span class = "p" > (</ span >< span class = "n" > msg</ span >< span class = "p" > )</ span > < span class = "kn" > from</ span >< span class = "w" > </ span >< span class = "nn" > exc</ span >
< a id = "__codelineno-0-436" name = "__codelineno-0-436" ></ a > < span class = "k" > else</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-437" name = "__codelineno-0-437" ></ a > < span class = "n" > text</ span > < span class = "o" > =</ span > < span class = "n" > value</ span >
< a id = "__codelineno-0-438" name = "__codelineno-0-438" ></ a > < span class = "k" > try</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-439" name = "__codelineno-0-439" ></ a > < span class = "n" > parsed</ span >< span class = "p" > :</ span > < span class = "nb" > object</ span > < span class = "o" > =</ span > < span class = "n" > json</ span >< span class = "o" > .</ span >< span class = "n" > loads</ span >< span class = "p" > (</ span >< span class = "n" > text</ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-440" name = "__codelineno-0-440" ></ a > < span class = "k" > except</ span > < span class = "n" > json</ span >< span class = "o" > .</ span >< span class = "n" > JSONDecodeError</ span > < span class = "k" > as</ span > < span class = "n" > exc</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-441" name = "__codelineno-0-441" ></ a > < span class = "n" > msg</ span > < span class = "o" > =</ span > < span class = "sa" > f</ span >< span class = "s2" > " Invalid JSON request: </ span >< span class = "si" > {</ span >< span class = "n" > exc</ span >< span class = "si" > }</ span >< span class = "s2" > " </ span >
< a id = "__codelineno-0-442" name = "__codelineno-0-442" ></ a > < span class = "k" > raise</ span > < span class = "ne" > ValueError</ span >< span class = "p" > (</ span >< span class = "n" > msg</ span >< span class = "p" > )</ span > < span class = "kn" > from</ span >< span class = "w" > </ span >< span class = "nn" > exc</ span >
< a id = "__codelineno-0-443" name = "__codelineno-0-443" ></ a > < span class = "k" > if</ span > < span class = "ow" > not</ span > < span class = "n" > _is_request_dict</ span >< span class = "p" > (</ span >< span class = "n" > parsed</ span >< span class = "p" > ):</ span >
< a id = "__codelineno-0-444" name = "__codelineno-0-444" ></ a > < span class = "n" > msg</ span > < span class = "o" > =</ span > < span class = "s2" > " Order request must be a JSON object." </ span >
< a id = "__codelineno-0-445" name = "__codelineno-0-445" ></ a > < span class = "k" > raise</ span > < span class = "ne" > ValueError</ span >< span class = "p" > (</ span >< span class = "n" > msg</ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-446" name = "__codelineno-0-446" ></ a > < span class = "k" > return</ span > < span class = "n" > parsed</ span >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
2026-04-26 12:50:38 +00:00
< h3 id = "mt5cli.cli.parse_tick_flags" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > parse_tick_flags</ span >
2026-04-22 17:11:38 +00:00
2026-04-26 12:50:38 +00:00
< a href = "#mt5cli.cli.parse_tick_flags" 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" > parse_tick_flags</ span >< span class = "p" > (</ span >< span class = "n" > value</ 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 = "int" > int</ span ></ span >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
2026-04-26 12:50:38 +00:00
< p > Parse tick flags string or integer value.</ p >
2026-04-22 17:11:38 +00:00
< 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 > value</ code >
</ td >
< td >
< code >< span title = "str" > str</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
2026-04-26 12:50:38 +00:00
< p > Tick flag name (ALL, INFO, TRADE) or integer value.</ p >
2026-04-22 17:11:38 +00:00
</ 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 = "int" > int</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
2026-04-26 12:50:38 +00:00
< p > Integer tick flag value.</ p >
2026-04-22 17:11:38 +00:00
</ div >
</ td >
</ tr >
</ tbody >
</ table >
< p >< span class = "doc-section-title" > Raises:</ span ></ p >
< table >
< thead >
< tr >
< th > Type</ th >
< th > Description</ th >
</ tr >
</ thead >
< tbody >
< tr class = "doc-section-item" >
< td >
< code >< span title = "ValueError" > ValueError</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
2026-04-26 12:50:38 +00:00
< p > If the flag is invalid.</ p >
2026-04-22 17:11:38 +00:00
</ div >
</ td >
</ tr >
</ tbody >
</ table >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-389" > 389</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-390" > 390</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-391" > 391</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-392" > 392</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-393" > 393</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-394" > 394</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-395" > 395</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-396" > 396</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-397" > 397</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-398" > 398</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-399" > 399</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-400" > 400</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-401" > 401</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-402" > 402</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-403" > 403</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-404" > 404</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-405" > 405</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-406" > 406</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-407" > 407</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-408" > 408</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-409" > 409</ a ></ span ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-389" name = "__codelineno-0-389" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > parse_tick_flags</ span >< span class = "p" > (</ span >< span class = "n" > value</ span >< span class = "p" > :</ span > < span class = "nb" > str</ span >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "nb" > int</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-390" name = "__codelineno-0-390" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Parse tick flags string or integer value.</ span >
< a id = "__codelineno-0-391" name = "__codelineno-0-391" ></ a >
< a id = "__codelineno-0-392" name = "__codelineno-0-392" ></ a >< span class = "sd" > Args:</ span >
< a id = "__codelineno-0-393" name = "__codelineno-0-393" ></ a >< span class = "sd" > value: Tick flag name (ALL, INFO, TRADE) or integer value.</ span >
< a id = "__codelineno-0-394" name = "__codelineno-0-394" ></ a >
< a id = "__codelineno-0-395" name = "__codelineno-0-395" ></ a >< span class = "sd" > Returns:</ span >
< a id = "__codelineno-0-396" name = "__codelineno-0-396" ></ a >< span class = "sd" > Integer tick flag value.</ span >
< a id = "__codelineno-0-397" name = "__codelineno-0-397" ></ a >
< a id = "__codelineno-0-398" name = "__codelineno-0-398" ></ a >< span class = "sd" > Raises:</ span >
< a id = "__codelineno-0-399" name = "__codelineno-0-399" ></ a >< span class = "sd" > ValueError: If the flag is invalid.</ span >
< a id = "__codelineno-0-400" name = "__codelineno-0-400" ></ a >< span class = "sd" > """ </ span >
< a id = "__codelineno-0-401" name = "__codelineno-0-401" ></ a > < span class = "n" > upper</ span > < span class = "o" > =</ span > < span class = "n" > value</ span >< span class = "o" > .</ span >< span class = "n" > upper</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-402" name = "__codelineno-0-402" ></ a > < span class = "k" > if</ span > < span class = "n" > upper</ span > < span class = "ow" > in</ span > < span class = "n" > TICK_FLAG_MAP</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-403" name = "__codelineno-0-403" ></ a > < span class = "k" > return</ span > < span class = "n" > TICK_FLAG_MAP</ span >< span class = "p" > [</ span >< span class = "n" > upper</ span >< span class = "p" > ]</ span >
< a id = "__codelineno-0-404" name = "__codelineno-0-404" ></ a > < span class = "k" > try</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-405" name = "__codelineno-0-405" ></ a > < span class = "k" > return</ span > < span class = "nb" > int</ span >< span class = "p" > (</ span >< span class = "n" > value</ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-406" name = "__codelineno-0-406" ></ a > < span class = "k" > except</ span > < span class = "ne" > ValueError</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-407" name = "__codelineno-0-407" ></ a > < span class = "n" > valid</ span > < span class = "o" > =</ span > < span class = "s2" > " , " </ span >< span class = "o" > .</ span >< span class = "n" > join</ span >< span class = "p" > (</ span >< span class = "n" > TICK_FLAG_MAP</ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-408" name = "__codelineno-0-408" ></ a > < span class = "n" > msg</ span > < span class = "o" > =</ span > < span class = "sa" > f</ span >< span class = "s2" > " Invalid tick flags: ' </ span >< span class = "si" > {</ span >< span class = "n" > value</ span >< span class = "si" > }</ span >< span class = "s2" > ' . Use one of: </ span >< span class = "si" > {</ span >< span class = "n" > valid</ span >< span class = "si" > }</ span >< span class = "s2" > , or an integer." </ span >
< a id = "__codelineno-0-409" name = "__codelineno-0-409" ></ a > < span class = "k" > raise</ span > < span class = "ne" > ValueError</ span >< span class = "p" > (</ span >< span class = "n" > msg</ span >< span class = "p" > )</ span > < span class = "kn" > from</ span >< span class = "w" > </ span >< span class = "kc" > None</ span >
2026-04-26 12:50:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.parse_timeframe" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > parse_timeframe</ span >
< a href = "#mt5cli.cli.parse_timeframe" 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" > parse_timeframe</ span >< span class = "p" > (</ span >< span class = "n" > value</ 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 = "int" > int</ span ></ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Parse a timeframe string or integer value.</ 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 > value</ code >
</ td >
< td >
< code >< span title = "str" > str</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
< p > Timeframe name (e.g., 'M1', 'H1', 'D1') or integer value.</ 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 = "int" > int</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
< p > Integer timeframe value.</ p >
</ div >
</ td >
</ tr >
</ tbody >
</ table >
< p >< span class = "doc-section-title" > Raises:</ span ></ p >
< table >
< thead >
< tr >
< th > Type</ th >
< th > Description</ th >
</ tr >
</ thead >
< tbody >
< tr class = "doc-section-item" >
< td >
< code >< span title = "ValueError" > ValueError</ span ></ code >
</ td >
< td >
< div class = "doc-md-description" >
< p > If the timeframe is invalid.</ p >
</ div >
</ td >
</ tr >
</ tbody >
</ table >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-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 >
< span class = "normal" >< a href = "#__codelineno-0-376" > 376</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-377" > 377</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-378" > 378</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-379" > 379</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-380" > 380</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-381" > 381</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-382" > 382</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-383" > 383</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-384" > 384</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-385" > 385</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-386" > 386</ a ></ span ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-366" name = "__codelineno-0-366" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > parse_timeframe</ span >< span class = "p" > (</ span >< span class = "n" > value</ span >< span class = "p" > :</ span > < span class = "nb" > str</ span >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "nb" > int</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-367" name = "__codelineno-0-367" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Parse a timeframe string or integer value.</ span >
< a id = "__codelineno-0-368" name = "__codelineno-0-368" ></ a >
< a id = "__codelineno-0-369" name = "__codelineno-0-369" ></ a >< span class = "sd" > Args:</ span >
< a id = "__codelineno-0-370" name = "__codelineno-0-370" ></ a >< span class = "sd" > value: Timeframe name (e.g., ' M1' , ' H1' , ' D1' ) or integer value.</ span >
< a id = "__codelineno-0-371" name = "__codelineno-0-371" ></ a >
< a id = "__codelineno-0-372" name = "__codelineno-0-372" ></ a >< span class = "sd" > Returns:</ span >
< a id = "__codelineno-0-373" name = "__codelineno-0-373" ></ a >< span class = "sd" > Integer timeframe value.</ span >
< a id = "__codelineno-0-374" name = "__codelineno-0-374" ></ a >
< a id = "__codelineno-0-375" name = "__codelineno-0-375" ></ a >< span class = "sd" > Raises:</ span >
< a id = "__codelineno-0-376" name = "__codelineno-0-376" ></ a >< span class = "sd" > ValueError: If the timeframe is invalid.</ span >
< a id = "__codelineno-0-377" name = "__codelineno-0-377" ></ a >< span class = "sd" > """ </ span >
< a id = "__codelineno-0-378" name = "__codelineno-0-378" ></ a > < span class = "n" > upper</ span > < span class = "o" > =</ span > < span class = "n" > value</ span >< span class = "o" > .</ span >< span class = "n" > upper</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-379" name = "__codelineno-0-379" ></ a > < span class = "k" > if</ span > < span class = "n" > upper</ span > < span class = "ow" > in</ span > < span class = "n" > TIMEFRAME_MAP</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-380" name = "__codelineno-0-380" ></ a > < span class = "k" > return</ span > < span class = "n" > TIMEFRAME_MAP</ span >< span class = "p" > [</ span >< span class = "n" > upper</ span >< span class = "p" > ]</ span >
< a id = "__codelineno-0-381" name = "__codelineno-0-381" ></ a > < span class = "k" > try</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-382" name = "__codelineno-0-382" ></ a > < span class = "k" > return</ span > < span class = "nb" > int</ span >< span class = "p" > (</ span >< span class = "n" > value</ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-383" name = "__codelineno-0-383" ></ a > < span class = "k" > except</ span > < span class = "ne" > ValueError</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-384" name = "__codelineno-0-384" ></ a > < span class = "n" > valid</ span > < span class = "o" > =</ span > < span class = "s2" > " , " </ span >< span class = "o" > .</ span >< span class = "n" > join</ span >< span class = "p" > (</ span >< span class = "n" > TIMEFRAME_MAP</ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-385" name = "__codelineno-0-385" ></ a > < span class = "n" > msg</ span > < span class = "o" > =</ span > < span class = "sa" > f</ span >< span class = "s2" > " Invalid timeframe: ' </ span >< span class = "si" > {</ span >< span class = "n" > value</ span >< span class = "si" > }</ span >< span class = "s2" > ' . Use one of: </ span >< span class = "si" > {</ span >< span class = "n" > valid</ span >< span class = "si" > }</ span >< span class = "s2" > , or an integer." </ span >
< a id = "__codelineno-0-386" name = "__codelineno-0-386" ></ a > < span class = "k" > raise</ span > < span class = "ne" > ValueError</ span >< span class = "p" > (</ span >< span class = "n" > msg</ span >< span class = "p" > )</ span > < span class = "kn" > from</ span >< span class = "w" > </ span >< span class = "kc" > None</ span >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.positions" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > positions</ span >
< a href = "#mt5cli.cli.positions" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > positions</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-2" name = "__codelineno-0-2" href = "#__codelineno-0-2" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typer.Context" > Context</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" ></ a > < span class = "n" >< span title = "str" > str</ span ></ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol filter." </ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-5" name = "__codelineno-0-5" href = "#__codelineno-0-5" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-6" name = "__codelineno-0-6" href = "#__codelineno-0-6" ></ a > < span class = "n" > group</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-7" name = "__codelineno-0-7" href = "#__codelineno-0-7" ></ a > < span class = "n" >< span title = "str" > str</ span ></ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Group filter." </ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-8" name = "__codelineno-0-8" href = "#__codelineno-0-8" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-9" name = "__codelineno-0-9" href = "#__codelineno-0-9" ></ a > < span class = "n" > ticket</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-10" name = "__codelineno-0-10" href = "#__codelineno-0-10" ></ a > < span class = "n" >< span title = "int" > int</ span ></ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Ticket filter." </ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-11" name = "__codelineno-0-11" href = "#__codelineno-0-11" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-12" name = "__codelineno-0-12" href = "#__codelineno-0-12" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
2026-05-28 16:23:36 +00:00
< div class = "doc doc-contents " >
< p > Export open positions.</ p >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ 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 ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-780" name = "__codelineno-0-780" ></ a >< span class = "nd" > @app</ span >< span class = "o" > .</ span >< span class = "n" > command</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-781" name = "__codelineno-0-781" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > positions</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-782" name = "__codelineno-0-782" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Context</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-783" name = "__codelineno-0-783" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > str</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol filter." </ span >< span class = "p" > )]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-784" name = "__codelineno-0-784" ></ a > < span class = "n" > group</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > str</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Group filter." </ span >< span class = "p" > )]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-785" name = "__codelineno-0-785" ></ a > < span class = "n" > ticket</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > int</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Ticket filter." </ span >< span class = "p" > )]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-786" name = "__codelineno-0-786" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-787" name = "__codelineno-0-787" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Export open positions.""" </ span >
< a id = "__codelineno-0-788" name = "__codelineno-0-788" ></ a > < span class = "n" > _execute_export</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-789" name = "__codelineno-0-789" ></ a > < span class = "n" > ctx</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-790" name = "__codelineno-0-790" ></ 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-791" name = "__codelineno-0-791" ></ a > < span class = "n" > symbol</ span >< span class = "o" > =</ span >< span class = "n" > symbol</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-792" name = "__codelineno-0-792" ></ a > < span class = "n" > group</ span >< span class = "o" > =</ span >< span class = "n" > group</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-793" name = "__codelineno-0-793" ></ a > < span class = "n" > ticket</ span >< span class = "o" > =</ span >< span class = "n" > ticket</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-794" name = "__codelineno-0-794" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-795" name = "__codelineno-0-795" ></ a > < span class = "p" > )</ span >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.rates_from" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > rates_from</ span >
< a href = "#mt5cli.cli.rates_from" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > rates_from</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-2" name = "__codelineno-0-2" href = "#__codelineno-0-2" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typer.Context" > Context</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >< span class = "n" >< span title = "str" > str</ span ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol name." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" ></ a > < span class = "n" > timeframe</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-5" name = "__codelineno-0-5" href = "#__codelineno-0-5" ></ a > < span class = "n" >< span title = "int" > int</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-6" name = "__codelineno-0-6" href = "#__codelineno-0-6" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-7" name = "__codelineno-0-7" href = "#__codelineno-0-7" ></ a > < span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "TIMEFRAME_TYPE
module-attribute
(mt5cli.cli.TIMEFRAME_TYPE)" href = "#mt5cli.cli.TIMEFRAME_TYPE" > TIMEFRAME_TYPE</ a ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-8" name = "__codelineno-0-8" href = "#__codelineno-0-8" ></ a > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Timeframe (e.g., M1, H1, D1, or integer)." </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-9" name = "__codelineno-0-9" href = "#__codelineno-0-9" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-10" name = "__codelineno-0-10" href = "#__codelineno-0-10" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-11" name = "__codelineno-0-11" href = "#__codelineno-0-11" ></ a > < span class = "n" > date_from</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-12" name = "__codelineno-0-12" href = "#__codelineno-0-12" ></ a > < span class = "n" >< span title = "datetime.datetime" > datetime</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-13" name = "__codelineno-0-13" href = "#__codelineno-0-13" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-14" name = "__codelineno-0-14" href = "#__codelineno-0-14" ></ a > < span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "DATETIME_TYPE
module-attribute
(mt5cli.cli.DATETIME_TYPE)" href = "#mt5cli.cli.DATETIME_TYPE" > DATETIME_TYPE</ a ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-15" name = "__codelineno-0-15" href = "#__codelineno-0-15" ></ a > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Start date in ISO 8601 format." </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-16" name = "__codelineno-0-16" href = "#__codelineno-0-16" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-17" name = "__codelineno-0-17" href = "#__codelineno-0-17" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-18" name = "__codelineno-0-18" href = "#__codelineno-0-18" ></ a > < span class = "n" > count</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-19" name = "__codelineno-0-19" href = "#__codelineno-0-19" ></ a > < span class = "n" >< span title = "int" > int</ span ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Number of records." </ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-20" name = "__codelineno-0-20" href = "#__codelineno-0-20" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-21" name = "__codelineno-0-21" href = "#__codelineno-0-21" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Export rates from a start date.</ p >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-575" > 575</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-576" > 576</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-577" > 577</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-578" > 578</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-579" > 579</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-580" > 580</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-581" > 581</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-582" > 582</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-583" > 583</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-584" > 584</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-585" > 585</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-586" > 586</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-587" > 587</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-588" > 588</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-589" > 589</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-590" > 590</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-591" > 591</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-592" > 592</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-593" > 593</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-594" > 594</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-595" > 595</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-596" > 596</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-597" > 597</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-598" > 598</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-599" > 599</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-600" > 600</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-601" > 601</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-602" > 602</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-603" > 603</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-604" > 604</ a ></ span ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-575" name = "__codelineno-0-575" ></ a >< span class = "nd" > @app</ span >< span class = "o" > .</ span >< span class = "n" > command</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-576" name = "__codelineno-0-576" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > rates_from</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-577" name = "__codelineno-0-577" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Context</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-578" name = "__codelineno-0-578" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > str</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol name." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-579" name = "__codelineno-0-579" ></ a > < span class = "n" > timeframe</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-580" name = "__codelineno-0-580" ></ a > < span class = "nb" > int</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-581" name = "__codelineno-0-581" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-582" name = "__codelineno-0-582" ></ a > < span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > TIMEFRAME_TYPE</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-583" name = "__codelineno-0-583" ></ a > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Timeframe (e.g., M1, H1, D1, or integer)." </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-584" name = "__codelineno-0-584" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-585" name = "__codelineno-0-585" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-586" name = "__codelineno-0-586" ></ a > < span class = "n" > date_from</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-587" name = "__codelineno-0-587" ></ a > < span class = "n" > datetime</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-588" name = "__codelineno-0-588" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-589" name = "__codelineno-0-589" ></ a > < span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > DATETIME_TYPE</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-590" name = "__codelineno-0-590" ></ a > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Start date in ISO 8601 format." </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-591" name = "__codelineno-0-591" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-592" name = "__codelineno-0-592" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-593" name = "__codelineno-0-593" ></ a > < span class = "n" > count</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > int</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Number of records." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-594" name = "__codelineno-0-594" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-595" name = "__codelineno-0-595" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Export rates from a start date.""" </ span >
< a id = "__codelineno-0-596" name = "__codelineno-0-596" ></ a > < span class = "n" > _execute_export</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-597" name = "__codelineno-0-597" ></ a > < span class = "n" > ctx</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-598" name = "__codelineno-0-598" ></ a > < span class = "k" > lambda</ span > < span class = "n" > 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-599" name = "__codelineno-0-599" ></ a > < span class = "n" > symbol</ span >< span class = "o" > =</ span >< span class = "n" > symbol</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-600" name = "__codelineno-0-600" ></ a > < span class = "n" > timeframe</ span >< span class = "o" > =</ span >< span class = "n" > timeframe</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-601" name = "__codelineno-0-601" ></ 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-602" name = "__codelineno-0-602" ></ a > < span class = "n" > count</ span >< span class = "o" > =</ span >< span class = "n" > count</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-603" name = "__codelineno-0-603" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-604" name = "__codelineno-0-604" ></ a > < span class = "p" > )</ span >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.rates_from_pos" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > rates_from_pos</ span >
< a href = "#mt5cli.cli.rates_from_pos" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > rates_from_pos</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-2" name = "__codelineno-0-2" href = "#__codelineno-0-2" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typer.Context" > Context</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >< span class = "n" >< span title = "str" > str</ span ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol name." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" ></ a > < span class = "n" > timeframe</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-5" name = "__codelineno-0-5" href = "#__codelineno-0-5" ></ a > < span class = "n" >< span title = "int" > int</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-6" name = "__codelineno-0-6" href = "#__codelineno-0-6" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-7" name = "__codelineno-0-7" href = "#__codelineno-0-7" ></ a > < span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "TIMEFRAME_TYPE
module-attribute
(mt5cli.cli.TIMEFRAME_TYPE)" href = "#mt5cli.cli.TIMEFRAME_TYPE" > TIMEFRAME_TYPE</ a ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Timeframe." </ span >
< a id = "__codelineno-0-8" name = "__codelineno-0-8" href = "#__codelineno-0-8" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-9" name = "__codelineno-0-9" href = "#__codelineno-0-9" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-10" name = "__codelineno-0-10" href = "#__codelineno-0-10" ></ a > < span class = "n" > start_pos</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-11" name = "__codelineno-0-11" href = "#__codelineno-0-11" ></ a > < span class = "n" >< span title = "int" > int</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-12" name = "__codelineno-0-12" href = "#__codelineno-0-12" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Start position (0 = current bar)." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-13" name = "__codelineno-0-13" href = "#__codelineno-0-13" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-14" name = "__codelineno-0-14" href = "#__codelineno-0-14" ></ a > < span class = "n" > count</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-15" name = "__codelineno-0-15" href = "#__codelineno-0-15" ></ a > < span class = "n" >< span title = "int" > int</ span ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Number of records." </ span >< span class = "p" > )</ span >
< a id = "__codelineno-0-16" name = "__codelineno-0-16" href = "#__codelineno-0-16" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-17" name = "__codelineno-0-17" href = "#__codelineno-0-17" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Export rates from a start position.</ p >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-607" > 607</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-608" > 608</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-609" > 609</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-610" > 610</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-611" > 611</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-612" > 612</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-613" > 613</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-614" > 614</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-615" > 615</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-616" > 616</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-617" > 617</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-618" > 618</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-619" > 619</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-620" > 620</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-621" > 621</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-622" > 622</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-623" > 623</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-624" > 624</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-625" > 625</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-626" > 626</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-627" > 627</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-628" > 628</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-629" > 629</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-630" > 630</ a ></ span ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-607" name = "__codelineno-0-607" ></ a >< span class = "nd" > @app</ span >< span class = "o" > .</ span >< span class = "n" > command</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-608" name = "__codelineno-0-608" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > rates_from_pos</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-609" name = "__codelineno-0-609" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Context</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-610" name = "__codelineno-0-610" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > str</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol name." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-611" name = "__codelineno-0-611" ></ a > < span class = "n" > timeframe</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-612" name = "__codelineno-0-612" ></ a > < span class = "nb" > int</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-613" name = "__codelineno-0-613" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-614" name = "__codelineno-0-614" ></ a > < span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > TIMEFRAME_TYPE</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-615" name = "__codelineno-0-615" ></ a > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Timeframe." </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-616" name = "__codelineno-0-616" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-617" name = "__codelineno-0-617" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-618" name = "__codelineno-0-618" ></ a > < span class = "n" > start_pos</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > int</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Start position (0 = current bar)." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-619" name = "__codelineno-0-619" ></ a > < span class = "n" > count</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > int</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Number of records." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-620" name = "__codelineno-0-620" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-621" name = "__codelineno-0-621" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Export rates from a start position.""" </ span >
< a id = "__codelineno-0-622" name = "__codelineno-0-622" ></ a > < span class = "n" > _execute_export</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-623" name = "__codelineno-0-623" ></ a > < span class = "n" > ctx</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-624" name = "__codelineno-0-624" ></ 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-625" name = "__codelineno-0-625" ></ a > < span class = "n" > symbol</ span >< span class = "o" > =</ span >< span class = "n" > symbol</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-626" name = "__codelineno-0-626" ></ a > < span class = "n" > timeframe</ span >< span class = "o" > =</ span >< span class = "n" > timeframe</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-627" name = "__codelineno-0-627" ></ 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-628" name = "__codelineno-0-628" ></ a > < span class = "n" > count</ span >< span class = "o" > =</ span >< span class = "n" > count</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-629" name = "__codelineno-0-629" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-630" name = "__codelineno-0-630" ></ a > < span class = "p" > )</ span >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.rates_range" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > rates_range</ span >
< a href = "#mt5cli.cli.rates_range" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > rates_range</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-2" name = "__codelineno-0-2" href = "#__codelineno-0-2" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typer.Context" > Context</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >< span class = "n" >< span title = "str" > str</ span ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol name." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" ></ a > < span class = "n" > timeframe</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-5" name = "__codelineno-0-5" href = "#__codelineno-0-5" ></ a > < span class = "n" >< span title = "int" > int</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-6" name = "__codelineno-0-6" href = "#__codelineno-0-6" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-7" name = "__codelineno-0-7" href = "#__codelineno-0-7" ></ a > < span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "TIMEFRAME_TYPE
module-attribute
(mt5cli.cli.TIMEFRAME_TYPE)" href = "#mt5cli.cli.TIMEFRAME_TYPE" > TIMEFRAME_TYPE</ a ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Timeframe." </ span >
< a id = "__codelineno-0-8" name = "__codelineno-0-8" href = "#__codelineno-0-8" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-9" name = "__codelineno-0-9" href = "#__codelineno-0-9" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-10" name = "__codelineno-0-10" href = "#__codelineno-0-10" ></ a > < span class = "n" > date_from</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-11" name = "__codelineno-0-11" href = "#__codelineno-0-11" ></ a > < span class = "n" >< span title = "datetime.datetime" > datetime</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-12" name = "__codelineno-0-12" href = "#__codelineno-0-12" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-13" name = "__codelineno-0-13" href = "#__codelineno-0-13" ></ a > < span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "DATETIME_TYPE
module-attribute
(mt5cli.cli.DATETIME_TYPE)" href = "#mt5cli.cli.DATETIME_TYPE" > DATETIME_TYPE</ a ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Start date." </ span >
< a id = "__codelineno-0-14" name = "__codelineno-0-14" href = "#__codelineno-0-14" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-15" name = "__codelineno-0-15" href = "#__codelineno-0-15" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-16" name = "__codelineno-0-16" href = "#__codelineno-0-16" ></ a > < span class = "n" > date_to</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-17" name = "__codelineno-0-17" href = "#__codelineno-0-17" ></ a > < span class = "n" >< span title = "datetime.datetime" > datetime</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-18" name = "__codelineno-0-18" href = "#__codelineno-0-18" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "DATETIME_TYPE
module-attribute
(mt5cli.cli.DATETIME_TYPE)" href = "#mt5cli.cli.DATETIME_TYPE" > DATETIME_TYPE</ a ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " End date." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-19" name = "__codelineno-0-19" href = "#__codelineno-0-19" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-20" name = "__codelineno-0-20" href = "#__codelineno-0-20" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Export rates for a date range.</ p >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-633" > 633</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-634" > 634</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-635" > 635</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-636" > 636</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-637" > 637</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-638" > 638</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-639" > 639</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-640" > 640</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-641" > 641</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-642" > 642</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-643" > 643</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-644" > 644</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-645" > 645</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-646" > 646</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-647" > 647</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-648" > 648</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-649" > 649</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-650" > 650</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-651" > 651</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-652" > 652</ a ></ span >
< 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 ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-633" name = "__codelineno-0-633" ></ a >< span class = "nd" > @app</ span >< span class = "o" > .</ span >< span class = "n" > command</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-634" name = "__codelineno-0-634" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > rates_range</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-635" name = "__codelineno-0-635" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Context</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-636" name = "__codelineno-0-636" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > str</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol name." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-637" name = "__codelineno-0-637" ></ a > < span class = "n" > timeframe</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-638" name = "__codelineno-0-638" ></ a > < span class = "nb" > int</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-639" name = "__codelineno-0-639" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-640" name = "__codelineno-0-640" ></ a > < span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > TIMEFRAME_TYPE</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-641" name = "__codelineno-0-641" ></ a > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Timeframe." </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-642" name = "__codelineno-0-642" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-643" name = "__codelineno-0-643" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-644" name = "__codelineno-0-644" ></ a > < span class = "n" > date_from</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-645" name = "__codelineno-0-645" ></ a > < span class = "n" > datetime</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-646" name = "__codelineno-0-646" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > DATETIME_TYPE</ span >< span class = "p" > ,</ span > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Start date." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-647" name = "__codelineno-0-647" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-648" name = "__codelineno-0-648" ></ a > < span class = "n" > date_to</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-649" name = "__codelineno-0-649" ></ a > < span class = "n" > datetime</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-650" name = "__codelineno-0-650" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > DATETIME_TYPE</ span >< span class = "p" > ,</ span > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " End date." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-651" name = "__codelineno-0-651" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-652" name = "__codelineno-0-652" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-653" name = "__codelineno-0-653" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Export rates for a date range.""" </ span >
< a id = "__codelineno-0-654" name = "__codelineno-0-654" ></ a > < span class = "n" > _execute_export</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-655" name = "__codelineno-0-655" ></ a > < span class = "n" > ctx</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-656" name = "__codelineno-0-656" ></ 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-657" name = "__codelineno-0-657" ></ a > < span class = "n" > symbol</ span >< span class = "o" > =</ span >< span class = "n" > symbol</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-658" name = "__codelineno-0-658" ></ a > < span class = "n" > timeframe</ span >< span class = "o" > =</ span >< span class = "n" > timeframe</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-659" name = "__codelineno-0-659" ></ 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-660" name = "__codelineno-0-660" ></ 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-661" name = "__codelineno-0-661" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-662" name = "__codelineno-0-662" ></ a > < span class = "p" > )</ span >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.symbol_info" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > symbol_info</ span >
< a href = "#mt5cli.cli.symbol_info" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > symbol_info</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-2" name = "__codelineno-0-2" href = "#__codelineno-0-2" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typer.Context" > Context</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >< span class = "n" >< span title = "str" > str</ span ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol name." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Export symbol details.</ p >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-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 ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-750" name = "__codelineno-0-750" ></ a >< span class = "nd" > @app</ span >< span class = "o" > .</ span >< span class = "n" > command</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-751" name = "__codelineno-0-751" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > symbol_info</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-752" name = "__codelineno-0-752" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Context</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-753" name = "__codelineno-0-753" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > str</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol name." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-754" name = "__codelineno-0-754" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-755" name = "__codelineno-0-755" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Export symbol details.""" </ span >
< a id = "__codelineno-0-756" name = "__codelineno-0-756" ></ a > < span class = "n" > _execute_export</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-757" name = "__codelineno-0-757" ></ a > < span class = "n" > ctx</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-758" name = "__codelineno-0-758" ></ 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" > 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 >
< a id = "__codelineno-0-759" name = "__codelineno-0-759" ></ a > < span class = "p" > )</ span >
2026-04-26 12:50:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.symbol_info_tick" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > symbol_info_tick</ span >
< a href = "#mt5cli.cli.symbol_info_tick" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > symbol_info_tick</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-2" name = "__codelineno-0-2" href = "#__codelineno-0-2" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typer.Context" > Context</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >< span class = "n" >< span title = "str" > str</ span ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol name." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Export the last tick for a symbol.</ p >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-870" > 870</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-871" > 871</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-872" > 872</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-873" > 873</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-874" > 874</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-875" > 875</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-876" > 876</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-877" > 877</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-878" > 878</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-879" > 879</ a ></ span ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-870" name = "__codelineno-0-870" ></ a >< span class = "nd" > @app</ span >< span class = "o" > .</ span >< span class = "n" > command</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-871" name = "__codelineno-0-871" ></ 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-872" name = "__codelineno-0-872" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Context</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-873" name = "__codelineno-0-873" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > str</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol name." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-874" name = "__codelineno-0-874" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-875" name = "__codelineno-0-875" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Export the last tick for a symbol.""" </ span >
< a id = "__codelineno-0-876" name = "__codelineno-0-876" ></ a > < span class = "n" > _execute_export</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-877" name = "__codelineno-0-877" ></ a > < span class = "n" > ctx</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-878" name = "__codelineno-0-878" ></ 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" > 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 >
< a id = "__codelineno-0-879" name = "__codelineno-0-879" ></ a > < span class = "p" > )</ span >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.symbols" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > symbols</ span >
< a href = "#mt5cli.cli.symbols" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > symbols</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-2" name = "__codelineno-0-2" href = "#__codelineno-0-2" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typer.Context" > Context</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" ></ a > < span class = "n" > group</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" ></ a > < span class = "n" >< span title = "str" > str</ span ></ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-5" name = "__codelineno-0-5" href = "#__codelineno-0-5" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol group filter (e.g., *USD*)." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-6" name = "__codelineno-0-6" href = "#__codelineno-0-6" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-7" name = "__codelineno-0-7" href = "#__codelineno-0-7" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Export symbol list.</ p >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-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 ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-735" name = "__codelineno-0-735" ></ a >< span class = "nd" > @app</ span >< span class = "o" > .</ span >< span class = "n" > command</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-736" name = "__codelineno-0-736" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > symbols</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-737" name = "__codelineno-0-737" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Context</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-738" name = "__codelineno-0-738" ></ a > < span class = "n" > group</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-739" name = "__codelineno-0-739" ></ a > < span class = "nb" > str</ span > < span class = "o" > |</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-740" name = "__codelineno-0-740" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol group filter (e.g., *USD*)." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-741" name = "__codelineno-0-741" ></ a > < span class = "p" > ]</ span > < span class = "o" > =</ span > < span class = "kc" > None</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-742" name = "__codelineno-0-742" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-743" name = "__codelineno-0-743" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Export symbol list.""" </ span >
< a id = "__codelineno-0-744" name = "__codelineno-0-744" ></ a > < span class = "n" > _execute_export</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-745" name = "__codelineno-0-745" ></ a > < span class = "n" > ctx</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-746" name = "__codelineno-0-746" ></ 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" > 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 >
< a id = "__codelineno-0-747" name = "__codelineno-0-747" ></ a > < span class = "p" > )</ span >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.terminal_info" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > terminal_info</ span >
< a href = "#mt5cli.cli.terminal_info" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > terminal_info</ span >< span class = "p" > (</ span >< span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typer.Context" > Context</ span ></ span >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Export terminal information.</ p >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-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 ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-729" name = "__codelineno-0-729" ></ a >< span class = "nd" > @app</ span >< span class = "o" > .</ span >< span class = "n" > command</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-730" name = "__codelineno-0-730" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > terminal_info</ span >< span class = "p" > (</ span >< span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Context</ span >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-731" name = "__codelineno-0-731" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Export terminal information.""" </ span >
< a id = "__codelineno-0-732" name = "__codelineno-0-732" ></ a > < span class = "n" > _execute_export</ span >< span class = "p" > (</ span >< span class = "n" > ctx</ span >< span class = "p" > ,</ span > < span class = "k" > lambda</ span > < span class = "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 >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.ticks_from" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > ticks_from</ span >
< a href = "#mt5cli.cli.ticks_from" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > ticks_from</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-2" name = "__codelineno-0-2" href = "#__codelineno-0-2" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typer.Context" > Context</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >< span class = "n" >< span title = "str" > str</ span ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol name." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" ></ a > < span class = "n" > date_from</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-5" name = "__codelineno-0-5" href = "#__codelineno-0-5" ></ a > < span class = "n" >< span title = "datetime.datetime" > datetime</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-6" name = "__codelineno-0-6" href = "#__codelineno-0-6" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-7" name = "__codelineno-0-7" href = "#__codelineno-0-7" ></ a > < span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "DATETIME_TYPE
module-attribute
(mt5cli.cli.DATETIME_TYPE)" href = "#mt5cli.cli.DATETIME_TYPE" > DATETIME_TYPE</ a ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Start date." </ span >
< a id = "__codelineno-0-8" name = "__codelineno-0-8" href = "#__codelineno-0-8" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-9" name = "__codelineno-0-9" href = "#__codelineno-0-9" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-10" name = "__codelineno-0-10" href = "#__codelineno-0-10" ></ a > < span class = "n" > count</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >< span class = "n" >< span title = "int" > int</ span ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Number of ticks." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-11" name = "__codelineno-0-11" href = "#__codelineno-0-11" ></ a > < span class = "n" > flags</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-12" name = "__codelineno-0-12" href = "#__codelineno-0-12" ></ a > < span class = "n" >< span title = "int" > int</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-13" name = "__codelineno-0-13" href = "#__codelineno-0-13" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-14" name = "__codelineno-0-14" href = "#__codelineno-0-14" ></ a > < span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "TICK_FLAGS_TYPE
module-attribute
(mt5cli.cli.TICK_FLAGS_TYPE)" href = "#mt5cli.cli.TICK_FLAGS_TYPE" > TICK_FLAGS_TYPE</ a ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-15" name = "__codelineno-0-15" href = "#__codelineno-0-15" ></ a > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Tick flags (ALL, INFO, TRADE, or integer)." </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-16" name = "__codelineno-0-16" href = "#__codelineno-0-16" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-17" name = "__codelineno-0-17" href = "#__codelineno-0-17" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-18" name = "__codelineno-0-18" href = "#__codelineno-0-18" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Export ticks from a start date.</ p >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-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 ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-665" name = "__codelineno-0-665" ></ a >< span class = "nd" > @app</ span >< span class = "o" > .</ span >< span class = "n" > command</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-666" name = "__codelineno-0-666" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > ticks_from</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-667" name = "__codelineno-0-667" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Context</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-668" name = "__codelineno-0-668" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > str</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol name." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-669" name = "__codelineno-0-669" ></ a > < span class = "n" > date_from</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-670" name = "__codelineno-0-670" ></ a > < span class = "n" > datetime</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-671" name = "__codelineno-0-671" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > DATETIME_TYPE</ span >< span class = "p" > ,</ span > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Start date." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-672" name = "__codelineno-0-672" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-673" name = "__codelineno-0-673" ></ a > < span class = "n" > count</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > int</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Number of ticks." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-674" name = "__codelineno-0-674" ></ a > < span class = "n" > flags</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-675" name = "__codelineno-0-675" ></ a > < span class = "nb" > int</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-676" name = "__codelineno-0-676" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-677" name = "__codelineno-0-677" ></ a > < span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > TICK_FLAGS_TYPE</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-678" name = "__codelineno-0-678" ></ a > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Tick flags (ALL, INFO, TRADE, or integer)." </ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-679" name = "__codelineno-0-679" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-680" name = "__codelineno-0-680" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-681" name = "__codelineno-0-681" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-682" name = "__codelineno-0-682" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Export ticks from a start date.""" </ span >
< a id = "__codelineno-0-683" name = "__codelineno-0-683" ></ a > < span class = "n" > _execute_export</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-684" name = "__codelineno-0-684" ></ a > < span class = "n" > ctx</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-685" name = "__codelineno-0-685" ></ 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-686" name = "__codelineno-0-686" ></ a > < span class = "n" > symbol</ span >< span class = "o" > =</ span >< span class = "n" > symbol</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-687" name = "__codelineno-0-687" ></ 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-688" name = "__codelineno-0-688" ></ a > < span class = "n" > count</ span >< span class = "o" > =</ span >< span class = "n" > count</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-689" name = "__codelineno-0-689" ></ a > < span class = "n" > flags</ span >< span class = "o" > =</ span >< span class = "n" > flags</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-690" name = "__codelineno-0-690" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-691" name = "__codelineno-0-691" ></ a > < span class = "p" > )</ span >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.ticks_range" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > ticks_range</ span >
< a href = "#mt5cli.cli.ticks_range" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > ticks_range</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-2" name = "__codelineno-0-2" href = "#__codelineno-0-2" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typer.Context" > Context</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >< span class = "n" >< span title = "str" > str</ span ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol name." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" ></ a > < span class = "n" > date_from</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-5" name = "__codelineno-0-5" href = "#__codelineno-0-5" ></ a > < span class = "n" >< span title = "datetime.datetime" > datetime</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-6" name = "__codelineno-0-6" href = "#__codelineno-0-6" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-7" name = "__codelineno-0-7" href = "#__codelineno-0-7" ></ a > < span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "DATETIME_TYPE
module-attribute
(mt5cli.cli.DATETIME_TYPE)" href = "#mt5cli.cli.DATETIME_TYPE" > DATETIME_TYPE</ a ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Start date." </ span >
< a id = "__codelineno-0-8" name = "__codelineno-0-8" href = "#__codelineno-0-8" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-9" name = "__codelineno-0-9" href = "#__codelineno-0-9" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-10" name = "__codelineno-0-10" href = "#__codelineno-0-10" ></ a > < span class = "n" > date_to</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-11" name = "__codelineno-0-11" href = "#__codelineno-0-11" ></ a > < span class = "n" >< span title = "datetime.datetime" > datetime</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-12" name = "__codelineno-0-12" href = "#__codelineno-0-12" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >< span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "DATETIME_TYPE
module-attribute
(mt5cli.cli.DATETIME_TYPE)" href = "#mt5cli.cli.DATETIME_TYPE" > DATETIME_TYPE</ a ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " End date." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-13" name = "__codelineno-0-13" href = "#__codelineno-0-13" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-14" name = "__codelineno-0-14" href = "#__codelineno-0-14" ></ a > < span class = "n" > flags</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typing.Annotated" > Annotated</ span ></ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-15" name = "__codelineno-0-15" href = "#__codelineno-0-15" ></ a > < span class = "n" >< span title = "int" > int</ span ></ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-16" name = "__codelineno-0-16" href = "#__codelineno-0-16" ></ a > < span class = "n" >< span title = "typer.Option" > Option</ span ></ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-17" name = "__codelineno-0-17" href = "#__codelineno-0-17" ></ a > < span class = "n" >< span title = "typer.Option(click_type)" > click_type</ span ></ span >< span class = "o" > =</ span >< span class = "n" >< a class = "autorefs autorefs-internal" title = "TICK_FLAGS_TYPE
module-attribute
(mt5cli.cli.TICK_FLAGS_TYPE)" href = "#mt5cli.cli.TICK_FLAGS_TYPE" > TICK_FLAGS_TYPE</ a ></ span >< span class = "p" > ,</ span > < span class = "n" >< span title = "typer.Option(help)" > help</ span ></ span >< span class = "o" > =</ span >< span class = "s2" > " Tick flags." </ span >
< a id = "__codelineno-0-18" name = "__codelineno-0-18" href = "#__codelineno-0-18" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-19" name = "__codelineno-0-19" href = "#__codelineno-0-19" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-20" name = "__codelineno-0-20" href = "#__codelineno-0-20" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Export ticks for a date range.</ p >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-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 ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-694" name = "__codelineno-0-694" ></ a >< span class = "nd" > @app</ span >< span class = "o" > .</ span >< span class = "n" > command</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-695" name = "__codelineno-0-695" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > ticks_range</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-696" name = "__codelineno-0-696" ></ a > < span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Context</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-697" name = "__codelineno-0-697" ></ a > < span class = "n" > symbol</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >< span class = "nb" > str</ span >< span class = "p" > ,</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Symbol name." </ span >< span class = "p" > )],</ span >
< a id = "__codelineno-0-698" name = "__codelineno-0-698" ></ a > < span class = "n" > date_from</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-699" name = "__codelineno-0-699" ></ a > < span class = "n" > datetime</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-700" name = "__codelineno-0-700" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > DATETIME_TYPE</ span >< span class = "p" > ,</ span > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Start date." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-701" name = "__codelineno-0-701" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-702" name = "__codelineno-0-702" ></ a > < span class = "n" > date_to</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-703" name = "__codelineno-0-703" ></ a > < span class = "n" > datetime</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-704" name = "__codelineno-0-704" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > DATETIME_TYPE</ span >< span class = "p" > ,</ span > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " End date." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-705" name = "__codelineno-0-705" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-706" name = "__codelineno-0-706" ></ a > < span class = "n" > flags</ span >< span class = "p" > :</ span > < span class = "n" > Annotated</ span >< span class = "p" > [</ span >
< a id = "__codelineno-0-707" name = "__codelineno-0-707" ></ a > < span class = "nb" > int</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-708" name = "__codelineno-0-708" ></ a > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Option</ span >< span class = "p" > (</ span >< span class = "n" > click_type</ span >< span class = "o" > =</ span >< span class = "n" > TICK_FLAGS_TYPE</ span >< span class = "p" > ,</ span > < span class = "n" > help</ span >< span class = "o" > =</ span >< span class = "s2" > " Tick flags." </ span >< span class = "p" > ),</ span >
< a id = "__codelineno-0-709" name = "__codelineno-0-709" ></ a > < span class = "p" > ],</ span >
< a id = "__codelineno-0-710" name = "__codelineno-0-710" ></ a >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-711" name = "__codelineno-0-711" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Export ticks for a date range.""" </ span >
< a id = "__codelineno-0-712" name = "__codelineno-0-712" ></ a > < span class = "n" > _execute_export</ span >< span class = "p" > (</ span >
< a id = "__codelineno-0-713" name = "__codelineno-0-713" ></ a > < span class = "n" > ctx</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-714" name = "__codelineno-0-714" ></ 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-715" name = "__codelineno-0-715" ></ a > < span class = "n" > symbol</ span >< span class = "o" > =</ span >< span class = "n" > symbol</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-716" name = "__codelineno-0-716" ></ 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-717" name = "__codelineno-0-717" ></ 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-718" name = "__codelineno-0-718" ></ a > < span class = "n" > flags</ span >< span class = "o" > =</ span >< span class = "n" > flags</ span >< span class = "p" > ,</ span >
< a id = "__codelineno-0-719" name = "__codelineno-0-719" ></ a > < span class = "p" > ),</ span >
< a id = "__codelineno-0-720" name = "__codelineno-0-720" ></ a > < span class = "p" > )</ span >
2026-04-26 12:50:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
< div class = "doc doc-object doc-function" >
< h3 id = "mt5cli.cli.version" class = "doc doc-heading" >
< span class = "doc doc-object-name doc-function-name" > version</ span >
< a href = "#mt5cli.cli.version" class = "headerlink" title = "Permanent link" > ¶ </ a ></ h3 >
< div class = "doc-signature highlight" >< pre >< span ></ span >< code >< a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" ></ a >< span class = "nf" > version</ span >< span class = "p" > (</ span >< span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" >< span title = "typer.Context" > Context</ span ></ span >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >
</ code ></ pre ></ div >
< div class = "doc doc-contents " >
< p > Export MetaTrader5 version information.</ p >
< details class = "mkdocstrings-source" >
< summary > Source code in < code > mt5cli/cli.py</ code ></ summary >
2026-05-28 16:23:36 +00:00
< div class = "highlight" >< table class = "highlighttable" >< tr >< td class = "linenos" >< div class = "linenodiv" >< pre >< span ></ span >< span class = "normal" >< a href = "#__codelineno-0-858" > 858</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-859" > 859</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-860" > 860</ a ></ span >
< span class = "normal" >< a href = "#__codelineno-0-861" > 861</ a ></ span ></ pre ></ div ></ td >< td class = "code" >< div >< pre >< span ></ span >< code >< a id = "__codelineno-0-858" name = "__codelineno-0-858" ></ a >< span class = "nd" > @app</ span >< span class = "o" > .</ span >< span class = "n" > command</ span >< span class = "p" > ()</ span >
< a id = "__codelineno-0-859" name = "__codelineno-0-859" ></ a >< span class = "k" > def</ span >< span class = "w" > </ span >< span class = "nf" > version</ span >< span class = "p" > (</ span >< span class = "n" > ctx</ span >< span class = "p" > :</ span > < span class = "n" > typer</ span >< span class = "o" > .</ span >< span class = "n" > Context</ span >< span class = "p" > )</ span > < span class = "o" > -> </ span > < span class = "kc" > None</ span >< span class = "p" > :</ span >
< a id = "__codelineno-0-860" name = "__codelineno-0-860" ></ a >< span class = "w" > </ span >< span class = "sd" > """ Export MetaTrader5 version information.""" </ span >
< a id = "__codelineno-0-861" name = "__codelineno-0-861" ></ a > < span class = "n" > _execute_export</ span >< span class = "p" > (</ span >< span class = "n" > ctx</ span >< span class = "p" > ,</ span > < span class = "k" > lambda</ span > < span class = "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 >
2026-04-22 17:11:38 +00:00
</ code ></ pre ></ div ></ td ></ tr ></ table ></ div >
</ details >
</ div >
</ div >
</ div >
</ div >
2026-05-24 16:49:15 +00:00
</ div ></ div >
</ div >
</ div >
2026-04-22 17:11:38 +00:00
2026-05-24 16:49:15 +00:00
< footer class = "col-md-12" >
< hr >
< p > Documentation built with < a href = "https://www.mkdocs.org/" > MkDocs</ a > .</ p >
</ footer >
< script src = "../../js/bootstrap.bundle.min.js" ></ script >
< script >
var base_url = "../.." ,
shortcuts = { "help" : 191 , "next" : 78 , "previous" : 80 , "search" : 83 };
</ script >
< script src = "../../js/base.js" ></ script >
< script src = "../../search/main.js" ></ script >
< div class = "modal" id = "mkdocs_search_modal" tabindex = "-1" role = "dialog" aria-labelledby = "searchModalLabel" aria-hidden = "true" >
< div class = "modal-dialog modal-lg" >
< div class = "modal-content" >
< div class = "modal-header" >
< h4 class = "modal-title" id = "searchModalLabel" > Search</ h4 >
< button type = "button" class = "btn-close" data-bs-dismiss = "modal" aria-label = "Close" ></ button >
</ div >
< div class = "modal-body" >
< p > From here you can search these documents. Enter your search terms below.</ p >
< form >
< div class = "form-group" >
< input type = "search" class = "form-control" placeholder = "Search..." id = "mkdocs-search-query" title = "Type search term here" >
</ div >
</ form >
< div id = "mkdocs-search-results" data-no-results-text = "No results found" ></ div >
</ div >
< div class = "modal-footer" >
2026-04-22 17:11:38 +00:00
</ div >
</ div >
</ div >
2026-05-24 16:49:15 +00:00
</ div >< div class = "modal" id = "mkdocs_keyboard_modal" tabindex = "-1" role = "dialog" aria-labelledby = "keyboardModalLabel" aria-hidden = "true" >
< div class = "modal-dialog" >
< div class = "modal-content" >
< div class = "modal-header" >
< h4 class = "modal-title" id = "keyboardModalLabel" > Keyboard Shortcuts</ h4 >
< button type = "button" class = "btn-close" data-bs-dismiss = "modal" aria-label = "Close" ></ button >
</ div >
< div class = "modal-body" >
< table class = "table" >
< thead >
< tr >
< th style = "width: 20%;" > Keys</ th >
< th > Action</ th >
</ tr >
</ thead >
< tbody >
< tr >
< td class = "help shortcut" >< kbd > ?</ kbd ></ td >
< td > Open this help</ td >
</ tr >
< tr >
< td class = "next shortcut" >< kbd > n</ kbd ></ td >
< td > Next page</ td >
</ tr >
< tr >
< td class = "prev shortcut" >< kbd > p</ kbd ></ td >
< td > Previous page</ td >
</ tr >
< tr >
< td class = "search shortcut" >< kbd > s</ kbd ></ td >
< td > Search</ td >
</ tr >
</ tbody >
</ table >
</ div >
< div class = "modal-footer" >
</ div >
</ div >
2026-04-22 17:11:38 +00:00
</ div >
2026-05-24 16:49:15 +00:00
</ div >
</ body >
</ html >
