From a58f209556d9e8a5a1cbdd406052bbd0353f43ba Mon Sep 17 00:00:00 2001 From: dceoy Date: Thu, 28 May 2026 16:23:36 +0000 Subject: [PATCH] deploy: da74c11087ef4406311708f32dfb8d56e3910531 --- api/cli/index.html | 2513 ++++++++++++++++++++++++-------------- index.html | 76 +- objects.inv | Bin 558 -> 629 bytes search/search_index.json | 2 +- sitemap.xml | 6 +- sitemap.xml.gz | Bin 204 -> 204 bytes 6 files changed, 1650 insertions(+), 947 deletions(-) diff --git a/api/cli/index.html b/api/cli/index.html index 077cde6..f241f22 100644 --- a/api/cli/index.html +++ b/api/cli/index.html @@ -349,6 +349,263 @@ +

+ Dataset + + +

+ + +
+

+ Bases: StrEnum

+ + + +

Datasets supported by the collect-history command.

+ + + + + + + + + + + +
+ + + + + + + +
+ + + +

+ history_deals + + + + class-attribute + instance-attribute + + +

+
history_deals = 'history-deals'
+
+ +
+ +
+ +
+ +
+ + + +

+ history_orders + + + + class-attribute + instance-attribute + + +

+
history_orders = 'history-orders'
+
+ +
+ +
+ +
+ +
+ + + +

+ rates + + + + class-attribute + instance-attribute + + +

+
rates = 'rates'
+
+ +
+ +
+ +
+ +
+ + + +

+ ticks + + + + class-attribute + instance-attribute + + +

+
ticks = 'ticks'
+
+ +
+ +
+ +
+ + + + + + +
+ +
+ + + +
+ + + +

+ IfExists + + +

+ + +
+

+ Bases: StrEnum

+ + + +

SQLite table conflict behavior for the collect-history command.

+ + + + + + + + + + + +
+ + + + + + + +
+ + + +

+ APPEND + + + + class-attribute + instance-attribute + + +

+
APPEND = 'append'
+
+ +
+ +
+ +
+ +
+ + + +

+ FAIL + + + + class-attribute + instance-attribute + + +

+
FAIL = 'fail'
+
+ +
+ +
+ +
+ +
+ + + +

+ REPLACE + + + + class-attribute + instance-attribute + + +

+
REPLACE = 'replace'
+
+ +
+ +
+ +
+ + + + + + +
+ +
+ +
+ +
+ + +

LogLevel @@ -644,13 +901,385 @@
Source code in mt5cli/cli.py - 
685
-686
-687
-688
@app.command()
-def account_info(ctx: typer.Context) -> None:
-    """Export account information."""
-    _execute_export(ctx, lambda c: c.account_info_as_df())
+              
723
+724
+725
+726
@app.command()
+def account_info(ctx: typer.Context) -> None:
+    """Export account information."""
+    _execute_export(ctx, lambda c: c.account_info_as_df())
+

+            
+
+ + + +
+ + +

+ collect_history + + +

+
collect_history(
+    ctx: Context,
+    symbol: Annotated[
+        list[str],
+        Option(
+            "--symbol",
+            "-s",
+            help="Symbol to collect (repeat for multiple symbols).",
+        ),
+    ],
+    date_from: Annotated[
+        datetime,
+        Option(
+            click_type=DATETIME_TYPE, help="Start date."
+        ),
+    ],
+    date_to: Annotated[
+        datetime,
+        Option(click_type=DATETIME_TYPE, help="End date."),
+    ],
+    dataset: Annotated[
+        list[Dataset] | None,
+        Option(
+            "--dataset",
+            help="Dataset to include (repeat for multiple). Defaults to all: rates, ticks, history-orders, history-deals.",
+        ),
+    ] = None,
+    timeframe: Annotated[
+        int,
+        Option(
+            click_type=TIMEFRAME_TYPE,
+            help="Rates timeframe (e.g., M1, H1, D1).",
+        ),
+    ] = 1,
+    flags: Annotated[
+        int,
+        Option(
+            click_type=TICK_FLAGS_TYPE,
+            help="Tick copy flags (ALL, INFO, TRADE, or integer).",
+        ),
+    ] = 1,
+    if_exists: Annotated[
+        IfExists,
+        Option(
+            "--if-exists",
+            help="Behavior when a target table already exists.",
+        ),
+    ] = FAIL,
+    with_views: Annotated[
+        bool,
+        Option(
+            "--with-views",
+            help="Add cash_events and positions_reconstructed SQLite views derived from history_deals.",
+        ),
+    ] = False,
+) -> None
+
+ +
+ +

Collect historical datasets into a single SQLite database.

+

Tables written depend on --dataset: rates, ticks, +history_orders, history_deals. History datasets are fetched per +symbol and concatenated. Rates rows carry the requested timeframe so +appended runs at different timeframes remain distinguishable.

+

With --with-views (requires the history-deals dataset), optional +views cash_events and positions_reconstructed are derived from +history_deals when the required columns are present.

+ + +

Raises:

+ + + + + + + + + + + + + +
TypeDescription
+ BadParameter + +
+

If the output format is not SQLite3.

+
+
+ + +
+ Source code in mt5cli/cli.py + 
1329
+1330
+1331
+1332
+1333
+1334
+1335
+1336
+1337
+1338
+1339
+1340
+1341
+1342
+1343
+1344
+1345
+1346
+1347
+1348
+1349
+1350
+1351
+1352
+1353
+1354
+1355
+1356
+1357
+1358
+1359
+1360
+1361
+1362
+1363
+1364
+1365
+1366
+1367
+1368
+1369
+1370
+1371
+1372
+1373
+1374
+1375
+1376
+1377
+1378
+1379
+1380
+1381
+1382
+1383
+1384
+1385
+1386
+1387
+1388
+1389
+1390
+1391
+1392
+1393
+1394
+1395
+1396
+1397
+1398
+1399
+1400
+1401
+1402
+1403
+1404
+1405
+1406
+1407
+1408
+1409
+1410
+1411
+1412
+1413
+1414
+1415
+1416
+1417
+1418
+1419
+1420
+1421
+1422
+1423
+1424
+1425
+1426
+1427
+1428
+1429
+1430
+1431
+1432
+1433
+1434
+1435
+1436
+1437
+1438
+1439
+1440
+1441
+1442
+1443
+1444
+1445
+1446
+1447
@app.command()
+def collect_history(
+    ctx: typer.Context,
+    symbol: Annotated[
+        list[str],
+        typer.Option(
+            "--symbol",
+            "-s",
+            help="Symbol to collect (repeat for multiple symbols).",
+        ),
+    ],
+    date_from: Annotated[
+        datetime,
+        typer.Option(click_type=DATETIME_TYPE, help="Start date."),
+    ],
+    date_to: Annotated[
+        datetime,
+        typer.Option(click_type=DATETIME_TYPE, help="End date."),
+    ],
+    dataset: Annotated[
+        list[Dataset] | None,
+        typer.Option(
+            "--dataset",
+            help=(
+                "Dataset to include (repeat for multiple)."
+                " Defaults to all: rates, ticks, history-orders, history-deals."
+            ),
+        ),
+    ] = None,
+    timeframe: Annotated[
+        int,
+        typer.Option(
+            click_type=TIMEFRAME_TYPE,
+            help="Rates timeframe (e.g., M1, H1, D1).",
+        ),
+    ] = 1,
+    flags: Annotated[
+        int,
+        typer.Option(
+            click_type=TICK_FLAGS_TYPE,
+            help="Tick copy flags (ALL, INFO, TRADE, or integer).",
+        ),
+    ] = 1,
+    if_exists: Annotated[
+        IfExists,
+        typer.Option(
+            "--if-exists",
+            help="Behavior when a target table already exists.",
+        ),
+    ] = IfExists.FAIL,
+    with_views: Annotated[
+        bool,
+        typer.Option(
+            "--with-views",
+            help=(
+                "Add cash_events and positions_reconstructed SQLite views"
+                " derived from history_deals."
+            ),
+        ),
+    ] = False,
+) -> None:
+    """Collect historical datasets into a single SQLite database.
+
+    Tables written depend on ``--dataset``: ``rates``, ``ticks``,
+    ``history_orders``, ``history_deals``. History datasets are fetched per
+    symbol and concatenated. Rates rows carry the requested ``timeframe`` so
+    appended runs at different timeframes remain distinguishable.
+
+    With ``--with-views`` (requires the ``history-deals`` dataset), optional
+    views ``cash_events`` and ``positions_reconstructed`` are derived from
+    ``history_deals`` when the required columns are present.
+
+    Raises:
+        typer.BadParameter: If the output format is not SQLite3.
+    """
+    export_ctx = _get_export_context(ctx)
+    if export_ctx.output_format != "sqlite3":
+        msg = (
+            "collect-history requires SQLite3 output."
+            " Use a .db/.sqlite/.sqlite3 extension or --format sqlite3."
+        )
+        raise typer.BadParameter(msg)
+    datasets = set(dataset) if dataset else set(Dataset)
+    client = Mt5DataClient(config=export_ctx.config)
+    client.initialize_and_login_mt5()
+    try:
+        with sqlite3.connect(export_ctx.output) as conn:
+            conn.execute("PRAGMA journal_mode=WAL")
+            conn.execute("PRAGMA synchronous=NORMAL")
+            written_tables, written_columns = _write_collected_datasets(
+                conn,
+                client,
+                symbol,
+                datasets,
+                timeframe,
+                flags,
+                date_from,
+                date_to,
+                if_exists,
+            )
+            _create_collect_history_indexes(conn, written_columns)
+            if with_views and Dataset.history_deals in written_tables:
+                _create_cash_events_view(conn, written_columns[Dataset.history_deals])
+                _create_positions_reconstructed_view(
+                    conn,
+                    written_columns[Dataset.history_deals],
+                )
+            elif with_views:
+                logger.warning(
+                    "--with-views ignored: history_deals table was not written"
+                )
+        logger.info(
+            "Collected %s for %d symbol(s) into %s",
+            ", ".join(sorted(ds.value for ds in datasets)),
+            len(symbol),
+            export_ctx.output,
+        )
+    finally:
+        client.shutdown()
@@ -770,57 +1399,57 @@
Source code in mt5cli/cli.py - 
236
-237
-238
-239
-240
-241
-242
-243
-244
-245
-246
-247
-248
-249
-250
-251
-252
-253
-254
-255
-256
-257
-258
-259
-260
-261
def detect_format(
-    output_path: Path,
-    explicit_format: str | None = None,
-) -> str:
-    """Detect the output format from a file extension or explicit format string.
-
-    Args:
-        output_path: Path to the output file.
-        explicit_format: Explicitly specified format, if any.
-
-    Returns:
-        The detected format string.
-
-    Raises:
-        ValueError: If the format cannot be determined.
-    """
-    if explicit_format is not None:
-        return explicit_format
-    suffix = output_path.suffix.lower()
-    if suffix in _FORMAT_EXTENSIONS:
-        return _FORMAT_EXTENSIONS[suffix]
-    msg = (
-        f"Cannot detect format from extension '{suffix}'."
-        " Use --format to specify the output format."
-    )
-    raise ValueError(msg)
+              
274
+275
+276
+277
+278
+279
+280
+281
+282
+283
+284
+285
+286
+287
+288
+289
+290
+291
+292
+293
+294
+295
+296
+297
+298
+299
def detect_format(
+    output_path: Path,
+    explicit_format: str | None = None,
+) -> str:
+    """Detect the output format from a file extension or explicit format string.
+
+    Args:
+        output_path: Path to the output file.
+        explicit_format: Explicitly specified format, if any.
+
+    Returns:
+        The detected format string.
+
+    Raises:
+        ValueError: If the format cannot be determined.
+    """
+    if explicit_format is not None:
+        return explicit_format
+    suffix = output_path.suffix.lower()
+    if suffix in _FORMAT_EXTENSIONS:
+        return _FORMAT_EXTENSIONS[suffix]
+    msg = (
+        f"Cannot detect format from extension '{suffix}'."
+        " Use --format to specify the output format."
+    )
+    raise ValueError(msg)
@@ -952,83 +1581,83 @@
Source code in mt5cli/cli.py - 
264
-265
-266
-267
-268
-269
-270
-271
-272
-273
-274
-275
-276
-277
-278
-279
-280
-281
-282
-283
-284
-285
-286
-287
-288
-289
-290
-291
-292
-293
-294
-295
-296
-297
-298
-299
-300
-301
-302
def export_dataframe(
-    df: pd.DataFrame,
-    output_path: Path,
-    output_format: str,
-    table_name: str = "data",
-) -> None:
-    """Export a pandas DataFrame to the specified file format.
-
-    Args:
-        df: DataFrame to export.
-        output_path: Path to the output file.
-        output_format: Output format (csv, json, parquet, or sqlite3).
-        table_name: Table name for SQLite3 output.
-
-    Raises:
-        ValueError: If the output format is not supported.
-    """
-    if output_format == "csv":
-        df.to_csv(output_path, index=False)
-    elif output_format == "json":
-        df.to_json(
-            output_path,
-            orient="records",
-            date_format="iso",
-            indent=2,
-        )
-    elif output_format == "parquet":
-        df.to_parquet(output_path, index=False)
-    elif output_format == "sqlite3":
-        with sqlite3.connect(output_path) as conn:
-            df.to_sql(  # type: ignore[reportUnknownMemberType]
-                table_name,
-                conn,
-                if_exists="replace",
-                index=False,
-            )
-    else:
-        msg = f"Unsupported output format: {output_format}"
-        raise ValueError(msg)
+              
302
+303
+304
+305
+306
+307
+308
+309
+310
+311
+312
+313
+314
+315
+316
+317
+318
+319
+320
+321
+322
+323
+324
+325
+326
+327
+328
+329
+330
+331
+332
+333
+334
+335
+336
+337
+338
+339
+340
def export_dataframe(
+    df: pd.DataFrame,
+    output_path: Path,
+    output_format: str,
+    table_name: str = "data",
+) -> None:
+    """Export a pandas DataFrame to the specified file format.
+
+    Args:
+        df: DataFrame to export.
+        output_path: Path to the output file.
+        output_format: Output format (csv, json, parquet, or sqlite3).
+        table_name: Table name for SQLite3 output.
+
+    Raises:
+        ValueError: If the output format is not supported.
+    """
+    if output_format == "csv":
+        df.to_csv(output_path, index=False)
+    elif output_format == "json":
+        df.to_json(
+            output_path,
+            orient="records",
+            date_format="iso",
+            indent=2,
+        )
+    elif output_format == "parquet":
+        df.to_parquet(output_path, index=False)
+    elif output_format == "sqlite3":
+        with sqlite3.connect(output_path) as conn:
+            df.to_sql(  # type: ignore[reportUnknownMemberType]
+                table_name,
+                conn,
+                if_exists="replace",
+                index=False,
+            )
+    else:
+        msg = f"Unsupported output format: {output_format}"
+        raise ValueError(msg)
@@ -1087,61 +1716,61 @@
Source code in mt5cli/cli.py - 
790
-791
-792
-793
-794
-795
-796
-797
-798
-799
-800
-801
-802
-803
-804
-805
-806
-807
-808
-809
-810
-811
-812
-813
-814
-815
-816
-817
@app.command()
-def history_deals(
-    ctx: typer.Context,
-    date_from: Annotated[
-        datetime | None,
-        typer.Option(click_type=DATETIME_TYPE, help="Start date."),
-    ] = None,
-    date_to: Annotated[
-        datetime | None,
-        typer.Option(click_type=DATETIME_TYPE, help="End date."),
-    ] = None,
-    group: Annotated[str | None, typer.Option(help="Group filter.")] = None,
-    symbol: Annotated[str | None, typer.Option(help="Symbol filter.")] = None,
-    ticket: Annotated[int | None, typer.Option(help="Order ticket.")] = None,
-    position: Annotated[int | None, typer.Option(help="Position ticket.")] = None,
-) -> None:
-    """Export historical deals."""
-    _execute_export(
-        ctx,
-        lambda c: c.history_deals_get_as_df(
-            date_from=date_from,
-            date_to=date_to,
-            group=group,
-            symbol=symbol,
-            ticket=ticket,
-            position=position,
-        ),
-    )
+              
828
+829
+830
+831
+832
+833
+834
+835
+836
+837
+838
+839
+840
+841
+842
+843
+844
+845
+846
+847
+848
+849
+850
+851
+852
+853
+854
+855
@app.command()
+def history_deals(
+    ctx: typer.Context,
+    date_from: Annotated[
+        datetime | None,
+        typer.Option(click_type=DATETIME_TYPE, help="Start date."),
+    ] = None,
+    date_to: Annotated[
+        datetime | None,
+        typer.Option(click_type=DATETIME_TYPE, help="End date."),
+    ] = None,
+    group: Annotated[str | None, typer.Option(help="Group filter.")] = None,
+    symbol: Annotated[str | None, typer.Option(help="Symbol filter.")] = None,
+    ticket: Annotated[int | None, typer.Option(help="Order ticket.")] = None,
+    position: Annotated[int | None, typer.Option(help="Position ticket.")] = None,
+) -> None:
+    """Export historical deals."""
+    _execute_export(
+        ctx,
+        lambda c: c.history_deals_get_as_df(
+            date_from=date_from,
+            date_to=date_to,
+            group=group,
+            symbol=symbol,
+            ticket=ticket,
+            position=position,
+        ),
+    )
@@ -1200,61 +1829,61 @@
Source code in mt5cli/cli.py - 
760
-761
-762
-763
-764
-765
-766
-767
-768
-769
-770
-771
-772
-773
-774
-775
-776
-777
-778
-779
-780
-781
-782
-783
-784
-785
-786
-787
@app.command()
-def history_orders(
-    ctx: typer.Context,
-    date_from: Annotated[
-        datetime | None,
-        typer.Option(click_type=DATETIME_TYPE, help="Start date."),
-    ] = None,
-    date_to: Annotated[
-        datetime | None,
-        typer.Option(click_type=DATETIME_TYPE, help="End date."),
-    ] = None,
-    group: Annotated[str | None, typer.Option(help="Group filter.")] = None,
-    symbol: Annotated[str | None, typer.Option(help="Symbol filter.")] = None,
-    ticket: Annotated[int | None, typer.Option(help="Order ticket.")] = None,
-    position: Annotated[int | None, typer.Option(help="Position ticket.")] = None,
-) -> None:
-    """Export historical orders."""
-    _execute_export(
-        ctx,
-        lambda c: c.history_orders_get_as_df(
-            date_from=date_from,
-            date_to=date_to,
-            group=group,
-            symbol=symbol,
-            ticket=ticket,
-            position=position,
-        ),
-    )
+              
798
+799
+800
+801
+802
+803
+804
+805
+806
+807
+808
+809
+810
+811
+812
+813
+814
+815
+816
+817
+818
+819
+820
+821
+822
+823
+824
+825
@app.command()
+def history_orders(
+    ctx: typer.Context,
+    date_from: Annotated[
+        datetime | None,
+        typer.Option(click_type=DATETIME_TYPE, help="Start date."),
+    ] = None,
+    date_to: Annotated[
+        datetime | None,
+        typer.Option(click_type=DATETIME_TYPE, help="End date."),
+    ] = None,
+    group: Annotated[str | None, typer.Option(help="Group filter.")] = None,
+    symbol: Annotated[str | None, typer.Option(help="Symbol filter.")] = None,
+    ticket: Annotated[int | None, typer.Option(help="Order ticket.")] = None,
+    position: Annotated[int | None, typer.Option(help="Position ticket.")] = None,
+) -> None:
+    """Export historical orders."""
+    _execute_export(
+        ctx,
+        lambda c: c.history_orders_get_as_df(
+            date_from=date_from,
+            date_to=date_to,
+            group=group,
+            symbol=symbol,
+            ticket=ticket,
+            position=position,
+        ),
+    )
@@ -1279,13 +1908,13 @@
Source code in mt5cli/cli.py - 
826
-827
-828
-829
@app.command()
-def last_error(ctx: typer.Context) -> None:
-    """Export the last error information."""
-    _execute_export(ctx, lambda c: c.last_error_as_df())
+              
864
+865
+866
+867
@app.command()
+def last_error(ctx: typer.Context) -> None:
+    """Export the last error information."""
+    _execute_export(ctx, lambda c: c.last_error_as_df())
@@ -1310,11 +1939,11 @@
Source code in mt5cli/cli.py - 
897
-898
-899
def main() -> None:
-    """Run the mt5cli CLI."""
-    app()
+              
1450
+1451
+1452
def main() -> None:
+    """Run the mt5cli CLI."""
+    app()
@@ -1342,25 +1971,25 @@
Source code in mt5cli/cli.py - 
844
-845
-846
-847
-848
-849
-850
-851
-852
-853
@app.command()
-def market_book(
-    ctx: typer.Context,
-    symbol: Annotated[str, typer.Option(help="Symbol name.")],
-) -> None:
-    """Export market depth (order book) for a symbol."""
-    _execute_export(
-        ctx,
-        lambda c: c.market_book_get_as_df(symbol=symbol),
-    )
+              
882
+883
+884
+885
+886
+887
+888
+889
+890
+891
@app.command()
+def market_book(
+    ctx: typer.Context,
+    symbol: Annotated[str, typer.Option(help="Symbol name.")],
+) -> None:
+    """Export market depth (order book) for a symbol."""
+    _execute_export(
+        ctx,
+        lambda c: c.market_book_get_as_df(symbol=symbol),
+    )
@@ -1399,31 +2028,31 @@
Source code in mt5cli/cli.py - 
856
-857
-858
-859
-860
-861
-862
-863
-864
-865
-866
-867
-868
@app.command()
-def order_check(
-    ctx: typer.Context,
-    request: Annotated[
-        dict[str, Any],
-        typer.Option(click_type=REQUEST_TYPE, help=_REQUEST_OPTION_HELP),
-    ],
-) -> None:
-    """Check funds sufficiency for a trading operation."""
-    _execute_export(
-        ctx,
-        lambda c: c.order_check_as_df(request=request),
-    )
+              
894
+895
+896
+897
+898
+899
+900
+901
+902
+903
+904
+905
+906
@app.command()
+def order_check(
+    ctx: typer.Context,
+    request: Annotated[
+        dict[str, Any],
+        typer.Option(click_type=REQUEST_TYPE, help=_REQUEST_OPTION_HELP),
+    ],
+) -> None:
+    """Check funds sufficiency for a trading operation."""
+    _execute_export(
+        ctx,
+        lambda c: c.order_check_as_df(request=request),
+    )
@@ -1491,53 +2120,53 @@
Source code in mt5cli/cli.py - 
871
-872
-873
-874
-875
-876
-877
-878
-879
-880
-881
-882
-883
-884
-885
-886
-887
-888
-889
-890
-891
-892
-893
-894
@app.command()
-def order_send(
-    ctx: typer.Context,
-    request: Annotated[
-        dict[str, Any],
-        typer.Option(click_type=REQUEST_TYPE, help=_REQUEST_OPTION_HELP),
-    ],
-    yes: Annotated[
-        bool,
-        typer.Option("--yes", help="Confirm the live trade request."),
-    ] = False,
-) -> None:
-    """Send a trading operation request to the trade server.
-
-    Raises:
-        typer.BadParameter: If --yes is not provided.
-    """
-    if not yes:
-        msg = "Pass --yes to send a live trade request."
-        raise typer.BadParameter(msg, param_hint="--yes")
-    _execute_export(
-        ctx,
-        lambda c: c.order_send_as_df(request=request),
-    )
+              
909
+910
+911
+912
+913
+914
+915
+916
+917
+918
+919
+920
+921
+922
+923
+924
+925
+926
+927
+928
+929
+930
+931
+932
@app.command()
+def order_send(
+    ctx: typer.Context,
+    request: Annotated[
+        dict[str, Any],
+        typer.Option(click_type=REQUEST_TYPE, help=_REQUEST_OPTION_HELP),
+    ],
+    yes: Annotated[
+        bool,
+        typer.Option("--yes", help="Confirm the live trade request."),
+    ] = False,
+) -> None:
+    """Send a trading operation request to the trade server.
+
+    Raises:
+        typer.BadParameter: If --yes is not provided.
+    """
+    if not yes:
+        msg = "Pass --yes to send a live trade request."
+        raise typer.BadParameter(msg, param_hint="--yes")
+    _execute_export(
+        ctx,
+        lambda c: c.order_send_as_df(request=request),
+    )
@@ -1573,37 +2202,37 @@
Source code in mt5cli/cli.py - 
724
-725
-726
-727
-728
-729
-730
-731
-732
-733
-734
-735
-736
-737
-738
-739
@app.command()
-def orders(
-    ctx: typer.Context,
-    symbol: Annotated[str | None, typer.Option(help="Symbol filter.")] = None,
-    group: Annotated[str | None, typer.Option(help="Group filter.")] = None,
-    ticket: Annotated[int | None, typer.Option(help="Ticket filter.")] = None,
-) -> None:
-    """Export active orders."""
-    _execute_export(
-        ctx,
-        lambda c: c.orders_get_as_df(
-            symbol=symbol,
-            group=group,
-            ticket=ticket,
-        ),
-    )
+              
762
+763
+764
+765
+766
+767
+768
+769
+770
+771
+772
+773
+774
+775
+776
+777
@app.command()
+def orders(
+    ctx: typer.Context,
+    symbol: Annotated[str | None, typer.Option(help="Symbol filter.")] = None,
+    group: Annotated[str | None, typer.Option(help="Group filter.")] = None,
+    ticket: Annotated[int | None, typer.Option(help="Ticket filter.")] = None,
+) -> None:
+    """Export active orders."""
+    _execute_export(
+        ctx,
+        lambda c: c.orders_get_as_df(
+            symbol=symbol,
+            group=group,
+            ticket=ticket,
+        ),
+    )
@@ -1706,47 +2335,47 @@
Source code in mt5cli/cli.py - 
305
-306
-307
-308
-309
-310
-311
-312
-313
-314
-315
-316
-317
-318
-319
-320
-321
-322
-323
-324
-325
def parse_datetime(value: str) -> datetime:
-    """Parse an ISO 8601 datetime string to a timezone-aware datetime.
-
-    Args:
-        value: ISO 8601 datetime string (e.g., '2024-01-01' or
-            '2024-01-01T12:00:00+00:00').
-
-    Returns:
-        Parsed datetime with UTC timezone if no timezone is specified.
-
-    Raises:
-        ValueError: If the string cannot be parsed.
-    """
-    try:
-        dt = datetime.fromisoformat(value)
-    except ValueError:
-        msg = f"Invalid datetime format: '{value}'. Use ISO 8601 format."
-        raise ValueError(msg) from None
-    if dt.tzinfo is None:
-        dt = dt.replace(tzinfo=UTC)
-    return dt
+              
343
+344
+345
+346
+347
+348
+349
+350
+351
+352
+353
+354
+355
+356
+357
+358
+359
+360
+361
+362
+363
def parse_datetime(value: str) -> datetime:
+    """Parse an ISO 8601 datetime string to a timezone-aware datetime.
+
+    Args:
+        value: ISO 8601 datetime string (e.g., '2024-01-01' or
+            '2024-01-01T12:00:00+00:00').
+
+    Returns:
+        Parsed datetime with UTC timezone if no timezone is specified.
+
+    Raises:
+        ValueError: If the string cannot be parsed.
+    """
+    try:
+        dt = datetime.fromisoformat(value)
+    except ValueError:
+        msg = f"Invalid datetime format: '{value}'. Use ISO 8601 format."
+        raise ValueError(msg) from None
+    if dt.tzinfo is None:
+        dt = dt.replace(tzinfo=UTC)
+    return dt
@@ -1849,67 +2478,67 @@ JSON object.

Source code in mt5cli/cli.py - 
378
-379
-380
-381
-382
-383
-384
-385
-386
-387
-388
-389
-390
-391
-392
-393
-394
-395
-396
-397
-398
-399
-400
-401
-402
-403
-404
-405
-406
-407
-408
def parse_request(value: str) -> dict[str, Any]:
-    """Parse a JSON-formatted order request string or file reference.
-
-    Args:
-        value: JSON object string, or '@path' to read JSON from a file.
-
-    Returns:
-        Parsed request dictionary.
-
-    Raises:
-        ValueError: If the request file cannot be read or the value is not a
-            JSON object.
-    """
-    if value.startswith("@"):
-        path = Path(value[1:])
-        try:
-            text = path.read_text(encoding="utf-8")
-        except (OSError, UnicodeDecodeError) as exc:
-            msg = f"Failed to read JSON request file '{path}': {exc}"
-            raise ValueError(msg) from exc
-    else:
-        text = value
-    try:
-        parsed: object = json.loads(text)
-    except json.JSONDecodeError as exc:
-        msg = f"Invalid JSON request: {exc}"
-        raise ValueError(msg) from exc
-    if not _is_request_dict(parsed):
-        msg = "Order request must be a JSON object."
-        raise ValueError(msg)
-    return parsed
+              
416
+417
+418
+419
+420
+421
+422
+423
+424
+425
+426
+427
+428
+429
+430
+431
+432
+433
+434
+435
+436
+437
+438
+439
+440
+441
+442
+443
+444
+445
+446
def parse_request(value: str) -> dict[str, Any]:
+    """Parse a JSON-formatted order request string or file reference.
+
+    Args:
+        value: JSON object string, or '@path' to read JSON from a file.
+
+    Returns:
+        Parsed request dictionary.
+
+    Raises:
+        ValueError: If the request file cannot be read or the value is not a
+            JSON object.
+    """
+    if value.startswith("@"):
+        path = Path(value[1:])
+        try:
+            text = path.read_text(encoding="utf-8")
+        except (OSError, UnicodeDecodeError) as exc:
+            msg = f"Failed to read JSON request file '{path}': {exc}"
+            raise ValueError(msg) from exc
+    else:
+        text = value
+    try:
+        parsed: object = json.loads(text)
+    except json.JSONDecodeError as exc:
+        msg = f"Invalid JSON request: {exc}"
+        raise ValueError(msg) from exc
+    if not _is_request_dict(parsed):
+        msg = "Order request must be a JSON object."
+        raise ValueError(msg)
+    return parsed
@@ -2011,47 +2640,47 @@ JSON object.

Source code in mt5cli/cli.py - 
351
-352
-353
-354
-355
-356
-357
-358
-359
-360
-361
-362
-363
-364
-365
-366
-367
-368
-369
-370
-371
def parse_tick_flags(value: str) -> int:
-    """Parse tick flags string or integer value.
-
-    Args:
-        value: Tick flag name (ALL, INFO, TRADE) or integer value.
-
-    Returns:
-        Integer tick flag value.
-
-    Raises:
-        ValueError: If the flag is invalid.
-    """
-    upper = value.upper()
-    if upper in TICK_FLAG_MAP:
-        return TICK_FLAG_MAP[upper]
-    try:
-        return int(value)
-    except ValueError:
-        valid = ", ".join(TICK_FLAG_MAP)
-        msg = f"Invalid tick flags: '{value}'. Use one of: {valid}, or an integer."
-        raise ValueError(msg) from None
+              
389
+390
+391
+392
+393
+394
+395
+396
+397
+398
+399
+400
+401
+402
+403
+404
+405
+406
+407
+408
+409
def parse_tick_flags(value: str) -> int:
+    """Parse tick flags string or integer value.
+
+    Args:
+        value: Tick flag name (ALL, INFO, TRADE) or integer value.
+
+    Returns:
+        Integer tick flag value.
+
+    Raises:
+        ValueError: If the flag is invalid.
+    """
+    upper = value.upper()
+    if upper in TICK_FLAG_MAP:
+        return TICK_FLAG_MAP[upper]
+    try:
+        return int(value)
+    except ValueError:
+        valid = ", ".join(TICK_FLAG_MAP)
+        msg = f"Invalid tick flags: '{value}'. Use one of: {valid}, or an integer."
+        raise ValueError(msg) from None
@@ -2153,47 +2782,47 @@ JSON object.

Source code in mt5cli/cli.py - 
328
-329
-330
-331
-332
-333
-334
-335
-336
-337
-338
-339
-340
-341
-342
-343
-344
-345
-346
-347
-348
def parse_timeframe(value: str) -> int:
-    """Parse a timeframe string or integer value.
-
-    Args:
-        value: Timeframe name (e.g., 'M1', 'H1', 'D1') or integer value.
-
-    Returns:
-        Integer timeframe value.
-
-    Raises:
-        ValueError: If the timeframe is invalid.
-    """
-    upper = value.upper()
-    if upper in TIMEFRAME_MAP:
-        return TIMEFRAME_MAP[upper]
-    try:
-        return int(value)
-    except ValueError:
-        valid = ", ".join(TIMEFRAME_MAP)
-        msg = f"Invalid timeframe: '{value}'. Use one of: {valid}, or an integer."
-        raise ValueError(msg) from None
+              
366
+367
+368
+369
+370
+371
+372
+373
+374
+375
+376
+377
+378
+379
+380
+381
+382
+383
+384
+385
+386
def parse_timeframe(value: str) -> int:
+    """Parse a timeframe string or integer value.
+
+    Args:
+        value: Timeframe name (e.g., 'M1', 'H1', 'D1') or integer value.
+
+    Returns:
+        Integer timeframe value.
+
+    Raises:
+        ValueError: If the timeframe is invalid.
+    """
+    upper = value.upper()
+    if upper in TIMEFRAME_MAP:
+        return TIMEFRAME_MAP[upper]
+    try:
+        return int(value)
+    except ValueError:
+        valid = ", ".join(TIMEFRAME_MAP)
+        msg = f"Invalid timeframe: '{value}'. Use one of: {valid}, or an integer."
+        raise ValueError(msg) from None
@@ -2229,37 +2858,37 @@ JSON object.

Source code in mt5cli/cli.py - 
742
-743
-744
-745
-746
-747
-748
-749
-750
-751
-752
-753
-754
-755
-756
-757
@app.command()
-def positions(
-    ctx: typer.Context,
-    symbol: Annotated[str | None, typer.Option(help="Symbol filter.")] = None,
-    group: Annotated[str | None, typer.Option(help="Group filter.")] = None,
-    ticket: Annotated[int | None, typer.Option(help="Ticket filter.")] = None,
-) -> None:
-    """Export open positions."""
-    _execute_export(
-        ctx,
-        lambda c: c.positions_get_as_df(
-            symbol=symbol,
-            group=group,
-            ticket=ticket,
-        ),
-    )
+              
780
+781
+782
+783
+784
+785
+786
+787
+788
+789
+790
+791
+792
+793
+794
+795
@app.command()
+def positions(
+    ctx: typer.Context,
+    symbol: Annotated[str | None, typer.Option(help="Symbol filter.")] = None,
+    group: Annotated[str | None, typer.Option(help="Group filter.")] = None,
+    ticket: Annotated[int | None, typer.Option(help="Ticket filter.")] = None,
+) -> None:
+    """Export open positions."""
+    _execute_export(
+        ctx,
+        lambda c: c.positions_get_as_df(
+            symbol=symbol,
+            group=group,
+            ticket=ticket,
+        ),
+    )
@@ -2314,65 +2943,65 @@ JSON object.

Source code in mt5cli/cli.py - 
537
-538
-539
-540
-541
-542
-543
-544
-545
-546
-547
-548
-549
-550
-551
-552
-553
-554
-555
-556
-557
-558
-559
-560
-561
-562
-563
-564
-565
-566
@app.command()
-def rates_from(
-    ctx: typer.Context,
-    symbol: Annotated[str, typer.Option(help="Symbol name.")],
-    timeframe: Annotated[
-        int,
-        typer.Option(
-            click_type=TIMEFRAME_TYPE,
-            help="Timeframe (e.g., M1, H1, D1, or integer).",
-        ),
-    ],
-    date_from: Annotated[
-        datetime,
-        typer.Option(
-            click_type=DATETIME_TYPE,
-            help="Start date in ISO 8601 format.",
-        ),
-    ],
-    count: Annotated[int, typer.Option(help="Number of records.")],
-) -> None:
-    """Export rates from a start date."""
-    _execute_export(
-        ctx,
-        lambda c: c.copy_rates_from_as_df(
-            symbol=symbol,
-            timeframe=timeframe,
-            date_from=date_from,
-            count=count,
-        ),
-    )
+              
575
+576
+577
+578
+579
+580
+581
+582
+583
+584
+585
+586
+587
+588
+589
+590
+591
+592
+593
+594
+595
+596
+597
+598
+599
+600
+601
+602
+603
+604
@app.command()
+def rates_from(
+    ctx: typer.Context,
+    symbol: Annotated[str, typer.Option(help="Symbol name.")],
+    timeframe: Annotated[
+        int,
+        typer.Option(
+            click_type=TIMEFRAME_TYPE,
+            help="Timeframe (e.g., M1, H1, D1, or integer).",
+        ),
+    ],
+    date_from: Annotated[
+        datetime,
+        typer.Option(
+            click_type=DATETIME_TYPE,
+            help="Start date in ISO 8601 format.",
+        ),
+    ],
+    count: Annotated[int, typer.Option(help="Number of records.")],
+) -> None:
+    """Export rates from a start date."""
+    _execute_export(
+        ctx,
+        lambda c: c.copy_rates_from_as_df(
+            symbol=symbol,
+            timeframe=timeframe,
+            date_from=date_from,
+            count=count,
+        ),
+    )
@@ -2418,53 +3047,53 @@ JSON object.

Source code in mt5cli/cli.py - 
569
-570
-571
-572
-573
-574
-575
-576
-577
-578
-579
-580
-581
-582
-583
-584
-585
-586
-587
-588
-589
-590
-591
-592
@app.command()
-def rates_from_pos(
-    ctx: typer.Context,
-    symbol: Annotated[str, typer.Option(help="Symbol name.")],
-    timeframe: Annotated[
-        int,
-        typer.Option(
-            click_type=TIMEFRAME_TYPE,
-            help="Timeframe.",
-        ),
-    ],
-    start_pos: Annotated[int, typer.Option(help="Start position (0 = current bar).")],
-    count: Annotated[int, typer.Option(help="Number of records.")],
-) -> None:
-    """Export rates from a start position."""
-    _execute_export(
-        ctx,
-        lambda c: c.copy_rates_from_pos_as_df(
-            symbol=symbol,
-            timeframe=timeframe,
-            start_pos=start_pos,
-            count=count,
-        ),
-    )
+              
607
+608
+609
+610
+611
+612
+613
+614
+615
+616
+617
+618
+619
+620
+621
+622
+623
+624
+625
+626
+627
+628
+629
+630
@app.command()
+def rates_from_pos(
+    ctx: typer.Context,
+    symbol: Annotated[str, typer.Option(help="Symbol name.")],
+    timeframe: Annotated[
+        int,
+        typer.Option(
+            click_type=TIMEFRAME_TYPE,
+            help="Timeframe.",
+        ),
+    ],
+    start_pos: Annotated[int, typer.Option(help="Start position (0 = current bar).")],
+    count: Annotated[int, typer.Option(help="Number of records.")],
+) -> None:
+    """Export rates from a start position."""
+    _execute_export(
+        ctx,
+        lambda c: c.copy_rates_from_pos_as_df(
+            symbol=symbol,
+            timeframe=timeframe,
+            start_pos=start_pos,
+            count=count,
+        ),
+    )
@@ -2523,65 +3152,65 @@ JSON object.

Source code in mt5cli/cli.py - 
595
-596
-597
-598
-599
-600
-601
-602
-603
-604
-605
-606
-607
-608
-609
-610
-611
-612
-613
-614
-615
-616
-617
-618
-619
-620
-621
-622
-623
-624
@app.command()
-def rates_range(
-    ctx: typer.Context,
-    symbol: Annotated[str, typer.Option(help="Symbol name.")],
-    timeframe: Annotated[
-        int,
-        typer.Option(
-            click_type=TIMEFRAME_TYPE,
-            help="Timeframe.",
-        ),
-    ],
-    date_from: Annotated[
-        datetime,
-        typer.Option(click_type=DATETIME_TYPE, help="Start date."),
-    ],
-    date_to: Annotated[
-        datetime,
-        typer.Option(click_type=DATETIME_TYPE, help="End date."),
-    ],
-) -> None:
-    """Export rates for a date range."""
-    _execute_export(
-        ctx,
-        lambda c: c.copy_rates_range_as_df(
-            symbol=symbol,
-            timeframe=timeframe,
-            date_from=date_from,
-            date_to=date_to,
-        ),
-    )
+              
633
+634
+635
+636
+637
+638
+639
+640
+641
+642
+643
+644
+645
+646
+647
+648
+649
+650
+651
+652
+653
+654
+655
+656
+657
+658
+659
+660
+661
+662
@app.command()
+def rates_range(
+    ctx: typer.Context,
+    symbol: Annotated[str, typer.Option(help="Symbol name.")],
+    timeframe: Annotated[
+        int,
+        typer.Option(
+            click_type=TIMEFRAME_TYPE,
+            help="Timeframe.",
+        ),
+    ],
+    date_from: Annotated[
+        datetime,
+        typer.Option(click_type=DATETIME_TYPE, help="Start date."),
+    ],
+    date_to: Annotated[
+        datetime,
+        typer.Option(click_type=DATETIME_TYPE, help="End date."),
+    ],
+) -> None:
+    """Export rates for a date range."""
+    _execute_export(
+        ctx,
+        lambda c: c.copy_rates_range_as_df(
+            symbol=symbol,
+            timeframe=timeframe,
+            date_from=date_from,
+            date_to=date_to,
+        ),
+    )
@@ -2609,25 +3238,25 @@ JSON object.

Source code in mt5cli/cli.py - 
712
-713
-714
-715
-716
-717
-718
-719
-720
-721
@app.command()
-def symbol_info(
-    ctx: typer.Context,
-    symbol: Annotated[str, typer.Option(help="Symbol name.")],
-) -> None:
-    """Export symbol details."""
-    _execute_export(
-        ctx,
-        lambda c: c.symbol_info_as_df(symbol=symbol),
-    )
+              
750
+751
+752
+753
+754
+755
+756
+757
+758
+759
@app.command()
+def symbol_info(
+    ctx: typer.Context,
+    symbol: Annotated[str, typer.Option(help="Symbol name.")],
+) -> None:
+    """Export symbol details."""
+    _execute_export(
+        ctx,
+        lambda c: c.symbol_info_as_df(symbol=symbol),
+    )
@@ -2655,25 +3284,25 @@ JSON object.

Source code in mt5cli/cli.py - 
832
-833
-834
-835
-836
-837
-838
-839
-840
-841
@app.command()
-def symbol_info_tick(
-    ctx: typer.Context,
-    symbol: Annotated[str, typer.Option(help="Symbol name.")],
-) -> None:
-    """Export the last tick for a symbol."""
-    _execute_export(
-        ctx,
-        lambda c: c.symbol_info_tick_as_df(symbol=symbol),
-    )
+              
870
+871
+872
+873
+874
+875
+876
+877
+878
+879
@app.command()
+def symbol_info_tick(
+    ctx: typer.Context,
+    symbol: Annotated[str, typer.Option(help="Symbol name.")],
+) -> None:
+    """Export the last tick for a symbol."""
+    _execute_export(
+        ctx,
+        lambda c: c.symbol_info_tick_as_df(symbol=symbol),
+    )
@@ -2704,31 +3333,31 @@ JSON object.

Source code in mt5cli/cli.py - 
697
-698
-699
-700
-701
-702
-703
-704
-705
-706
-707
-708
-709
@app.command()
-def symbols(
-    ctx: typer.Context,
-    group: Annotated[
-        str | None,
-        typer.Option(help="Symbol group filter (e.g., *USD*)."),
-    ] = None,
-) -> None:
-    """Export symbol list."""
-    _execute_export(
-        ctx,
-        lambda c: c.symbols_get_as_df(group=group),
-    )
+              
735
+736
+737
+738
+739
+740
+741
+742
+743
+744
+745
+746
+747
@app.command()
+def symbols(
+    ctx: typer.Context,
+    group: Annotated[
+        str | None,
+        typer.Option(help="Symbol group filter (e.g., *USD*)."),
+    ] = None,
+) -> None:
+    """Export symbol list."""
+    _execute_export(
+        ctx,
+        lambda c: c.symbols_get_as_df(group=group),
+    )
@@ -2753,13 +3382,13 @@ JSON object.

Source code in mt5cli/cli.py - 
691
-692
-693
-694
@app.command()
-def terminal_info(ctx: typer.Context) -> None:
-    """Export terminal information."""
-    _execute_export(ctx, lambda c: c.terminal_info_as_df())
+              
729
+730
+731
+732
@app.command()
+def terminal_info(ctx: typer.Context) -> None:
+    """Export terminal information."""
+    _execute_export(ctx, lambda c: c.terminal_info_as_df())
@@ -2811,59 +3440,59 @@ JSON object.

Source code in mt5cli/cli.py - 
627
-628
-629
-630
-631
-632
-633
-634
-635
-636
-637
-638
-639
-640
-641
-642
-643
-644
-645
-646
-647
-648
-649
-650
-651
-652
-653
@app.command()
-def ticks_from(
-    ctx: typer.Context,
-    symbol: Annotated[str, typer.Option(help="Symbol name.")],
-    date_from: Annotated[
-        datetime,
-        typer.Option(click_type=DATETIME_TYPE, help="Start date."),
-    ],
-    count: Annotated[int, typer.Option(help="Number of ticks.")],
-    flags: Annotated[
-        int,
-        typer.Option(
-            click_type=TICK_FLAGS_TYPE,
-            help="Tick flags (ALL, INFO, TRADE, or integer).",
-        ),
-    ],
-) -> None:
-    """Export ticks from a start date."""
-    _execute_export(
-        ctx,
-        lambda c: c.copy_ticks_from_as_df(
-            symbol=symbol,
-            date_from=date_from,
-            count=count,
-            flags=flags,
-        ),
-    )
+              
665
+666
+667
+668
+669
+670
+671
+672
+673
+674
+675
+676
+677
+678
+679
+680
+681
+682
+683
+684
+685
+686
+687
+688
+689
+690
+691
@app.command()
+def ticks_from(
+    ctx: typer.Context,
+    symbol: Annotated[str, typer.Option(help="Symbol name.")],
+    date_from: Annotated[
+        datetime,
+        typer.Option(click_type=DATETIME_TYPE, help="Start date."),
+    ],
+    count: Annotated[int, typer.Option(help="Number of ticks.")],
+    flags: Annotated[
+        int,
+        typer.Option(
+            click_type=TICK_FLAGS_TYPE,
+            help="Tick flags (ALL, INFO, TRADE, or integer).",
+        ),
+    ],
+) -> None:
+    """Export ticks from a start date."""
+    _execute_export(
+        ctx,
+        lambda c: c.copy_ticks_from_as_df(
+            symbol=symbol,
+            date_from=date_from,
+            count=count,
+            flags=flags,
+        ),
+    )
@@ -2922,59 +3551,59 @@ JSON object.

Source code in mt5cli/cli.py - 
656
-657
-658
-659
-660
-661
-662
-663
-664
-665
-666
-667
-668
-669
-670
-671
-672
-673
-674
-675
-676
-677
-678
-679
-680
-681
-682
@app.command()
-def ticks_range(
-    ctx: typer.Context,
-    symbol: Annotated[str, typer.Option(help="Symbol name.")],
-    date_from: Annotated[
-        datetime,
-        typer.Option(click_type=DATETIME_TYPE, help="Start date."),
-    ],
-    date_to: Annotated[
-        datetime,
-        typer.Option(click_type=DATETIME_TYPE, help="End date."),
-    ],
-    flags: Annotated[
-        int,
-        typer.Option(click_type=TICK_FLAGS_TYPE, help="Tick flags."),
-    ],
-) -> None:
-    """Export ticks for a date range."""
-    _execute_export(
-        ctx,
-        lambda c: c.copy_ticks_range_as_df(
-            symbol=symbol,
-            date_from=date_from,
-            date_to=date_to,
-            flags=flags,
-        ),
-    )
+              
694
+695
+696
+697
+698
+699
+700
+701
+702
+703
+704
+705
+706
+707
+708
+709
+710
+711
+712
+713
+714
+715
+716
+717
+718
+719
+720
@app.command()
+def ticks_range(
+    ctx: typer.Context,
+    symbol: Annotated[str, typer.Option(help="Symbol name.")],
+    date_from: Annotated[
+        datetime,
+        typer.Option(click_type=DATETIME_TYPE, help="Start date."),
+    ],
+    date_to: Annotated[
+        datetime,
+        typer.Option(click_type=DATETIME_TYPE, help="End date."),
+    ],
+    flags: Annotated[
+        int,
+        typer.Option(click_type=TICK_FLAGS_TYPE, help="Tick flags."),
+    ],
+) -> None:
+    """Export ticks for a date range."""
+    _execute_export(
+        ctx,
+        lambda c: c.copy_ticks_range_as_df(
+            symbol=symbol,
+            date_from=date_from,
+            date_to=date_to,
+            flags=flags,
+        ),
+    )
@@ -2999,13 +3628,13 @@ JSON object.

Source code in mt5cli/cli.py - 
820
-821
-822
-823
@app.command()
-def version(ctx: typer.Context) -> None:
-    """Export MetaTrader5 version information."""
-    _execute_export(ctx, lambda c: c.version_as_df())
+              
858
+859
+860
+861
@app.command()
+def version(ctx: typer.Context) -> None:
+    """Export MetaTrader5 version information."""
+    _execute_export(ctx, lambda c: c.version_as_df())
diff --git a/index.html b/index.html index 3051f5e..114b3cf 100644 --- a/index.html +++ b/index.html @@ -296,6 +296,80 @@

Use order-check to validate a request payload before running order-send --yes.

+

Bulk Collection

+ + + + + + + + + + + + + +
CommandDescription
collect-historyCollect rates, ticks, history-orders, and history-deals for one or more symbols into a single SQLite database (optional cash-event/position views)
+
mt5cli -o history.db collect-history \
+  --symbol EURUSD --symbol GBPUSD \
+  --date-from 2024-01-01 --date-to 2024-02-01 \
+  --dataset rates --dataset history-deals \
+  --timeframe M1 --flags ALL --if-exists append --with-views
+
+

collect-history options:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionDefaultDescription
--symbol/-srequiredSymbol to collect (repeat for multiple).
--date-fromrequiredStart date in ISO 8601.
--date-torequiredEnd date in ISO 8601.
--datasetall fourRepeatable: rates, ticks, history-orders, history-deals.
--timeframeM1Rates timeframe; recorded in a timeframe column on the rates table.
--flagsALLTick copy flags forwarded to copy_ticks_range.
--if-existsfailappend, replace, or fail when a target table already exists.
--with-viewsoffAdd cash_events and positions_reconstructed views (requires the history-deals dataset).
+

History orders and deals are fetched per symbol and concatenated, so the symbol filter is applied consistently across all datasets. The cash_events view is derived from symbol-filtered history_deals, so account-level cash events with empty or non-matching symbols may be excluded. The positions_reconstructed view excludes positions with no closing deal, uses volume-weighted open/close prices, and reports reversal deals (DEAL_ENTRY_INOUT) via volume_reversal / reversal_count.

Global Options

@@ -445,5 +519,5 @@ diff --git a/objects.inv b/objects.inv index 03e1c4750294cda389e67871f993dfb8a86e74e9..44181120f50268e434e6ea99e392bc4d2ea5c721 100644 GIT binary patch delta 499 zcmVCPnanGL(|*41MNv(Ga%n9KO?^3(b3;>;d3$vj<) zb-oaC{ks$sQ7crZ^zm~5oRqp#A^cyOJeYva?_>?C3lpdiJ%599z6Q?$y+YvV(dZ3D zpEu$u<`gK!zi5-REX8uph@NC=UU2l4D2wz;5Rk&P1#F?C6!4-==HkcQH6wT;s%lkn zfP9&)IQm~{wak~4oK_jNzyMwR;AH&xO!qjN^3XvC{5qEN#2aTMiaN@1TqYS zz}j^kXq3;^M2uYnPEd0^h6Dzl2Io;u`7~ZxAY$*lmchLGECGsxgc7`Wo(j0O1yAU) zRi-D#w90P)<-KzoBC)Sg>Icv~B0yhr0BRfK@CTT78EnvyH~9d0h_(@s#Y{JyY&z8j zCT4+i3I`X=B%!Xdzp!QFon-?uuEm19>RW0ZVQ24M$FY$&#J<@qj9LhSx29LD#P5>1A^bWZ=`wKO`x{)(e_Co*w delta 428 zcmV;d0aO0<1g->-jDM6(PuoBchVT4}NbMCPsCwzm6bD7k2Q@~hr`56^n{B)vGdqr& zf6p4EfJBLA4!&6L^X_~H{_Z-TrEfOue*~<@4rb>wJNUEo@9fLh+386*XtJxkDyqe* zFx8)%Vj^nG_K1Fo?Gkp-O;Xp{7zNtws<^zno(RiK5}+u{O@FBY7VG&&qrcC~^PT8VL;Y79D6ptZ*Y<~WAE6f)*L~GL10`1gJaVi21?)z{{|#B zlXF8hfDn81k$;i)rUu(ZC4*E0Nujh7Y=8(!3Sip;391#W?}eVh(iYe}AZ~@kOOD1p zg3}QZ`dR}>%b3vg;M^}G=xD7 znDmwkBHOppJmNk)V5d018CRe?>xs3l7L3TUdeOJna*vb&!j#EUom Wrw8<4bM!|3-{}K#dh!eq8x{aHx6(!c diff --git a/search/search_index.json b/search/search_index.json index 7e0f3bf..0333110 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"mt5cli \u00b6 Command-line tool for MetaTrader 5 data export. Overview \u00b6 mt5cli is a CLI application that exports MetaTrader 5 trading data to multiple file formats. It is built on top of pdmt5 , a pandas-based data handler for MetaTrader 5. Features \u00b6 Multi-format export : CSV, JSON, Parquet, and SQLite3 output formats Auto-detection : Format detection from file extensions Comprehensive data access : Rates, ticks, account info, symbols, orders, positions, and trading history Flexible timeframes : Named timeframes (M1, H1, D1, etc.) and numeric values Connection management : Optional credentials, server, and timeout configuration Installation \u00b6 pip install mt5cli Quick Start \u00b6 # Export account information to CSV mt5cli -o account.csv account-info # Export EURUSD M1 rates to Parquet mt5cli -o rates.parquet rates-from --symbol EURUSD --timeframe M1 \\ --date-from 2024 -01-01 --count 1000 # Export ticks to JSON mt5cli -o ticks.json ticks-from --symbol EURUSD \\ --date-from 2024 -01-01 --count 500 --flags ALL # Export symbols to SQLite3 with custom table name mt5cli -o data.db --table symbols symbols --group \"*USD*\" # Export with connection credentials mt5cli --login 12345 --password mypass --server MyBroker-Demo \\ -o positions.csv positions Commands \u00b6 Rates \u00b6 Command Description rates-from Export rates from a start date rates-from-pos Export rates from a start position rates-range Export rates for a date range Ticks \u00b6 Command Description ticks-from Export ticks from a start date ticks-range Export ticks for a date range Information \u00b6 Command Description account-info Export account information terminal-info Export terminal information version Export MetaTrader 5 version information last-error Export the last error information symbols Export symbol list symbol-info Export symbol details symbol-info-tick Export the last tick for a symbol market-book Export market depth (order book) Trading \u00b6 Command Description orders Export active orders positions Export open positions history-orders Export historical orders history-deals Export historical deals order-check Check funds sufficiency for a trade request order-send Send a trade request to the trade server ( --yes required) Use order-check to validate a request payload before running order-send --yes . Global Options \u00b6 Option Description -o, --output Output file path (required) -f, --format Output format (auto-detected from extension if omitted) --table Table name for SQLite3 output (default: \"data\") --login Trading account login --password Trading account password --server Trading server name --path Path to MetaTrader5 terminal EXE file --timeout Connection timeout in milliseconds --log-level Logging level (DEBUG, INFO, WARNING, ERROR) Requirements \u00b6 Python 3.11+ Windows OS (MetaTrader 5 requirement) MetaTrader 5 platform API Reference \u00b6 Browse the API documentation for detailed module information: CLI Module - CLI application with export commands and utility functions Development \u00b6 This project follows strict code quality standards: Type hints required (strict mode) Comprehensive linting with Ruff Test coverage tracking Google-style docstrings License \u00b6 MIT License - see LICENSE file for details.","title":"Home"},{"location":"#mt5cli","text":"Command-line tool for MetaTrader 5 data export.","title":"mt5cli"},{"location":"#overview","text":"mt5cli is a CLI application that exports MetaTrader 5 trading data to multiple file formats. It is built on top of pdmt5 , a pandas-based data handler for MetaTrader 5.","title":"Overview"},{"location":"#features","text":"Multi-format export : CSV, JSON, Parquet, and SQLite3 output formats Auto-detection : Format detection from file extensions Comprehensive data access : Rates, ticks, account info, symbols, orders, positions, and trading history Flexible timeframes : Named timeframes (M1, H1, D1, etc.) and numeric values Connection management : Optional credentials, server, and timeout configuration","title":"Features"},{"location":"#installation","text":"pip install mt5cli","title":"Installation"},{"location":"#quick-start","text":"# Export account information to CSV mt5cli -o account.csv account-info # Export EURUSD M1 rates to Parquet mt5cli -o rates.parquet rates-from --symbol EURUSD --timeframe M1 \\ --date-from 2024 -01-01 --count 1000 # Export ticks to JSON mt5cli -o ticks.json ticks-from --symbol EURUSD \\ --date-from 2024 -01-01 --count 500 --flags ALL # Export symbols to SQLite3 with custom table name mt5cli -o data.db --table symbols symbols --group \"*USD*\" # Export with connection credentials mt5cli --login 12345 --password mypass --server MyBroker-Demo \\ -o positions.csv positions","title":"Quick Start"},{"location":"#commands","text":"","title":"Commands"},{"location":"#rates","text":"Command Description rates-from Export rates from a start date rates-from-pos Export rates from a start position rates-range Export rates for a date range","title":"Rates"},{"location":"#ticks","text":"Command Description ticks-from Export ticks from a start date ticks-range Export ticks for a date range","title":"Ticks"},{"location":"#information","text":"Command Description account-info Export account information terminal-info Export terminal information version Export MetaTrader 5 version information last-error Export the last error information symbols Export symbol list symbol-info Export symbol details symbol-info-tick Export the last tick for a symbol market-book Export market depth (order book)","title":"Information"},{"location":"#trading","text":"Command Description orders Export active orders positions Export open positions history-orders Export historical orders history-deals Export historical deals order-check Check funds sufficiency for a trade request order-send Send a trade request to the trade server ( --yes required) Use order-check to validate a request payload before running order-send --yes .","title":"Trading"},{"location":"#global-options","text":"Option Description -o, --output Output file path (required) -f, --format Output format (auto-detected from extension if omitted) --table Table name for SQLite3 output (default: \"data\") --login Trading account login --password Trading account password --server Trading server name --path Path to MetaTrader5 terminal EXE file --timeout Connection timeout in milliseconds --log-level Logging level (DEBUG, INFO, WARNING, ERROR)","title":"Global Options"},{"location":"#requirements","text":"Python 3.11+ Windows OS (MetaTrader 5 requirement) MetaTrader 5 platform","title":"Requirements"},{"location":"#api-reference","text":"Browse the API documentation for detailed module information: CLI Module - CLI application with export commands and utility functions","title":"API Reference"},{"location":"#development","text":"This project follows strict code quality standards: Type hints required (strict mode) Comprehensive linting with Ruff Test coverage tracking Google-style docstrings","title":"Development"},{"location":"#license","text":"MIT License - see LICENSE file for details.","title":"License"},{"location":"api/","text":"API Reference \u00b6 This section contains the complete API documentation for mt5cli. Modules \u00b6 The mt5cli package consists of the following modules: CLI \u00b6 Command-line interface module providing typer-based commands for exporting MetaTrader 5 data to CSV, JSON, Parquet, and SQLite3 formats. Architecture Overview \u00b6 The package follows a simple architecture built on top of pdmt5: CLI Layer ( cli.py ): Typer application with subcommands for each data type, custom Click parameter types for datetime/timeframe/tick flags parsing, and format detection/export utilities. Data Layer (via pdmt5 ): Uses Mt5DataClient and Mt5Config from the pdmt5 package for all MetaTrader 5 data access. Usage Guidelines \u00b6 All modules follow these conventions: Type Safety : All functions include comprehensive type hints Error Handling : User-friendly error messages via typer Documentation : Google-style docstrings with examples Validation : Custom Click parameter types for input validation Quick Start \u00b6 # Export account information to CSV mt5cli -o account.csv account-info # Export EURUSD H1 rates to Parquet mt5cli -o rates.parquet rates-from --symbol EURUSD --timeframe H1 \\ --date-from 2024 -01-01 --count 1000 # Export ticks to JSON mt5cli -o ticks.json ticks-from --symbol EURUSD \\ --date-from 2024 -01-01 --count 500 --flags ALL # Export to SQLite3 with custom table name mt5cli -o data.db --table symbols symbols --group \"*USD*\" Python API \u00b6 from mt5cli import detect_format , export_dataframe import pandas as pd # Detect output format from file extension fmt = detect_format ( Path ( \"output.parquet\" )) # Returns \"parquet\" # Export a DataFrame df = pd . DataFrame ({ \"symbol\" : [ \"EURUSD\" ], \"bid\" : [ 1.1234 ]}) export_dataframe ( df , Path ( \"output.csv\" ), \"csv\" ) Examples \u00b6 See individual module pages for detailed usage examples and code samples.","title":"Overview"},{"location":"api/#api-reference","text":"This section contains the complete API documentation for mt5cli.","title":"API Reference"},{"location":"api/#modules","text":"The mt5cli package consists of the following modules:","title":"Modules"},{"location":"api/#cli","text":"Command-line interface module providing typer-based commands for exporting MetaTrader 5 data to CSV, JSON, Parquet, and SQLite3 formats.","title":"CLI"},{"location":"api/#architecture-overview","text":"The package follows a simple architecture built on top of pdmt5: CLI Layer ( cli.py ): Typer application with subcommands for each data type, custom Click parameter types for datetime/timeframe/tick flags parsing, and format detection/export utilities. Data Layer (via pdmt5 ): Uses Mt5DataClient and Mt5Config from the pdmt5 package for all MetaTrader 5 data access.","title":"Architecture Overview"},{"location":"api/#usage-guidelines","text":"All modules follow these conventions: Type Safety : All functions include comprehensive type hints Error Handling : User-friendly error messages via typer Documentation : Google-style docstrings with examples Validation : Custom Click parameter types for input validation","title":"Usage Guidelines"},{"location":"api/#quick-start","text":"# Export account information to CSV mt5cli -o account.csv account-info # Export EURUSD H1 rates to Parquet mt5cli -o rates.parquet rates-from --symbol EURUSD --timeframe H1 \\ --date-from 2024 -01-01 --count 1000 # Export ticks to JSON mt5cli -o ticks.json ticks-from --symbol EURUSD \\ --date-from 2024 -01-01 --count 500 --flags ALL # Export to SQLite3 with custom table name mt5cli -o data.db --table symbols symbols --group \"*USD*\"","title":"Quick Start"},{"location":"api/#python-api","text":"from mt5cli import detect_format , export_dataframe import pandas as pd # Detect output format from file extension fmt = detect_format ( Path ( \"output.parquet\" )) # Returns \"parquet\" # Export a DataFrame df = pd . DataFrame ({ \"symbol\" : [ \"EURUSD\" ], \"bid\" : [ 1.1234 ]}) export_dataframe ( df , Path ( \"output.csv\" ), \"csv\" )","title":"Python API"},{"location":"api/#examples","text":"See individual module pages for detailed usage examples and code samples.","title":"Examples"},{"location":"api/cli/","text":"CLI Module \u00b6 mt5cli.cli \u00b6 Command-line interface for MetaTrader 5 data export. DATETIME_TYPE module-attribute \u00b6 DATETIME_TYPE = _DateTimeType () REQUEST_TYPE module-attribute \u00b6 REQUEST_TYPE = _RequestType () TICK_FLAGS_TYPE module-attribute \u00b6 TICK_FLAGS_TYPE = _TickFlagsType () TICK_FLAG_MAP module-attribute \u00b6 TICK_FLAG_MAP : dict [ str , int ] = { \"ALL\" : 1 , \"INFO\" : 2 , \"TRADE\" : 4 , } TIMEFRAME_MAP module-attribute \u00b6 TIMEFRAME_MAP : dict [ str , int ] = { \"M1\" : 1 , \"M2\" : 2 , \"M3\" : 3 , \"M4\" : 4 , \"M5\" : 5 , \"M6\" : 6 , \"M10\" : 10 , \"M12\" : 12 , \"M15\" : 15 , \"M20\" : 20 , \"M30\" : 30 , \"H1\" : 16385 , \"H2\" : 16386 , \"H3\" : 16387 , \"H4\" : 16388 , \"H6\" : 16390 , \"H8\" : 16392 , \"H12\" : 16396 , \"D1\" : 16408 , \"W1\" : 32769 , \"MN1\" : 49153 , } TIMEFRAME_TYPE module-attribute \u00b6 TIMEFRAME_TYPE = _TimeframeType () app module-attribute \u00b6 app = Typer ( name = \"mt5cli\" , help = \"Export MetaTrader5 data to CSV, JSON, Parquet, or SQLite3.\" , ) logger module-attribute \u00b6 logger = getLogger ( __name__ ) LogLevel \u00b6 Bases: StrEnum Logging verbosity levels. DEBUG class-attribute instance-attribute \u00b6 DEBUG = 'DEBUG' ERROR class-attribute instance-attribute \u00b6 ERROR = 'ERROR' INFO class-attribute instance-attribute \u00b6 INFO = 'INFO' WARNING class-attribute instance-attribute \u00b6 WARNING = 'WARNING' OutputFormat \u00b6 Bases: StrEnum Supported output file formats. csv class-attribute instance-attribute \u00b6 csv = 'csv' json class-attribute instance-attribute \u00b6 json = 'json' parquet class-attribute instance-attribute \u00b6 parquet = 'parquet' sqlite3 class-attribute instance-attribute \u00b6 sqlite3 = 'sqlite3' account_info \u00b6 account_info ( ctx : Context ) -> None Export account information. Source code in mt5cli/cli.py 685 686 687 688 @app . command () def account_info ( ctx : typer . Context ) -> None : \"\"\"Export account information.\"\"\" _execute_export ( ctx , lambda c : c . account_info_as_df ()) detect_format \u00b6 detect_format ( output_path : Path , explicit_format : str | None = None ) -> str Detect the output format from a file extension or explicit format string. Parameters: Name Type Description Default output_path Path Path to the output file. required explicit_format str | None Explicitly specified format, if any. None Returns: Type Description str The detected format string. Raises: Type Description ValueError If the format cannot be determined. Source code in mt5cli/cli.py 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 def detect_format ( output_path : Path , explicit_format : str | None = None , ) -> str : \"\"\"Detect the output format from a file extension or explicit format string. Args: output_path: Path to the output file. explicit_format: Explicitly specified format, if any. Returns: The detected format string. Raises: ValueError: If the format cannot be determined. \"\"\" if explicit_format is not None : return explicit_format suffix = output_path . suffix . lower () if suffix in _FORMAT_EXTENSIONS : return _FORMAT_EXTENSIONS [ suffix ] msg = ( f \"Cannot detect format from extension ' { suffix } '.\" \" Use --format to specify the output format.\" ) raise ValueError ( msg ) export_dataframe \u00b6 export_dataframe ( df : DataFrame , output_path : Path , output_format : str , table_name : str = \"data\" , ) -> None Export a pandas DataFrame to the specified file format. Parameters: Name Type Description Default df DataFrame DataFrame to export. required output_path Path Path to the output file. required output_format str Output format (csv, json, parquet, or sqlite3). required table_name str Table name for SQLite3 output. 'data' Raises: Type Description ValueError If the output format is not supported. Source code in mt5cli/cli.py 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 def export_dataframe ( df : pd . DataFrame , output_path : Path , output_format : str , table_name : str = \"data\" , ) -> None : \"\"\"Export a pandas DataFrame to the specified file format. Args: df: DataFrame to export. output_path: Path to the output file. output_format: Output format (csv, json, parquet, or sqlite3). table_name: Table name for SQLite3 output. Raises: ValueError: If the output format is not supported. \"\"\" if output_format == \"csv\" : df . to_csv ( output_path , index = False ) elif output_format == \"json\" : df . to_json ( output_path , orient = \"records\" , date_format = \"iso\" , indent = 2 , ) elif output_format == \"parquet\" : df . to_parquet ( output_path , index = False ) elif output_format == \"sqlite3\" : with sqlite3 . connect ( output_path ) as conn : df . to_sql ( # type: ignore[reportUnknownMemberType] table_name , conn , if_exists = \"replace\" , index = False , ) else : msg = f \"Unsupported output format: { output_format } \" raise ValueError ( msg ) history_deals \u00b6 history_deals ( ctx : Context , date_from : Annotated [ datetime | None , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ] = None , date_to : Annotated [ datetime | None , Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ] = None , group : Annotated [ str | None , Option ( help = \"Group filter.\" ) ] = None , symbol : Annotated [ str | None , Option ( help = \"Symbol filter.\" ) ] = None , ticket : Annotated [ int | None , Option ( help = \"Order ticket.\" ) ] = None , position : Annotated [ int | None , Option ( help = \"Position ticket.\" ) ] = None , ) -> None Export historical deals. Source code in mt5cli/cli.py 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 @app . command () def history_deals ( ctx : typer . Context , date_from : Annotated [ datetime | None , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ] = None , date_to : Annotated [ datetime | None , typer . Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ] = None , group : Annotated [ str | None , typer . Option ( help = \"Group filter.\" )] = None , symbol : Annotated [ str | None , typer . Option ( help = \"Symbol filter.\" )] = None , ticket : Annotated [ int | None , typer . Option ( help = \"Order ticket.\" )] = None , position : Annotated [ int | None , typer . Option ( help = \"Position ticket.\" )] = None , ) -> None : \"\"\"Export historical deals.\"\"\" _execute_export ( ctx , lambda c : c . history_deals_get_as_df ( date_from = date_from , date_to = date_to , group = group , symbol = symbol , ticket = ticket , position = position , ), ) history_orders \u00b6 history_orders ( ctx : Context , date_from : Annotated [ datetime | None , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ] = None , date_to : Annotated [ datetime | None , Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ] = None , group : Annotated [ str | None , Option ( help = \"Group filter.\" ) ] = None , symbol : Annotated [ str | None , Option ( help = \"Symbol filter.\" ) ] = None , ticket : Annotated [ int | None , Option ( help = \"Order ticket.\" ) ] = None , position : Annotated [ int | None , Option ( help = \"Position ticket.\" ) ] = None , ) -> None Export historical orders. Source code in mt5cli/cli.py 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 @app . command () def history_orders ( ctx : typer . Context , date_from : Annotated [ datetime | None , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ] = None , date_to : Annotated [ datetime | None , typer . Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ] = None , group : Annotated [ str | None , typer . Option ( help = \"Group filter.\" )] = None , symbol : Annotated [ str | None , typer . Option ( help = \"Symbol filter.\" )] = None , ticket : Annotated [ int | None , typer . Option ( help = \"Order ticket.\" )] = None , position : Annotated [ int | None , typer . Option ( help = \"Position ticket.\" )] = None , ) -> None : \"\"\"Export historical orders.\"\"\" _execute_export ( ctx , lambda c : c . history_orders_get_as_df ( date_from = date_from , date_to = date_to , group = group , symbol = symbol , ticket = ticket , position = position , ), ) last_error \u00b6 last_error ( ctx : Context ) -> None Export the last error information. Source code in mt5cli/cli.py 826 827 828 829 @app . command () def last_error ( ctx : typer . Context ) -> None : \"\"\"Export the last error information.\"\"\" _execute_export ( ctx , lambda c : c . last_error_as_df ()) main \u00b6 main () -> None Run the mt5cli CLI. Source code in mt5cli/cli.py 897 898 899 def main () -> None : \"\"\"Run the mt5cli CLI.\"\"\" app () market_book \u00b6 market_book ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], ) -> None Export market depth (order book) for a symbol. Source code in mt5cli/cli.py 844 845 846 847 848 849 850 851 852 853 @app . command () def market_book ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], ) -> None : \"\"\"Export market depth (order book) for a symbol.\"\"\" _execute_export ( ctx , lambda c : c . market_book_get_as_df ( symbol = symbol ), ) order_check \u00b6 order_check ( ctx : Context , request : Annotated [ dict [ str , Any ], Option ( click_type = REQUEST_TYPE , help = _REQUEST_OPTION_HELP , ), ], ) -> None Check funds sufficiency for a trading operation. Source code in mt5cli/cli.py 856 857 858 859 860 861 862 863 864 865 866 867 868 @app . command () def order_check ( ctx : typer . Context , request : Annotated [ dict [ str , Any ], typer . Option ( click_type = REQUEST_TYPE , help = _REQUEST_OPTION_HELP ), ], ) -> None : \"\"\"Check funds sufficiency for a trading operation.\"\"\" _execute_export ( ctx , lambda c : c . order_check_as_df ( request = request ), ) order_send \u00b6 order_send ( ctx : Context , request : Annotated [ dict [ str , Any ], Option ( click_type = REQUEST_TYPE , help = _REQUEST_OPTION_HELP , ), ], yes : Annotated [ bool , Option ( \"--yes\" , help = \"Confirm the live trade request.\" ), ] = False , ) -> None Send a trading operation request to the trade server. Raises: Type Description BadParameter If --yes is not provided. Source code in mt5cli/cli.py 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 @app . command () def order_send ( ctx : typer . Context , request : Annotated [ dict [ str , Any ], typer . Option ( click_type = REQUEST_TYPE , help = _REQUEST_OPTION_HELP ), ], yes : Annotated [ bool , typer . Option ( \"--yes\" , help = \"Confirm the live trade request.\" ), ] = False , ) -> None : \"\"\"Send a trading operation request to the trade server. Raises: typer.BadParameter: If --yes is not provided. \"\"\" if not yes : msg = \"Pass --yes to send a live trade request.\" raise typer . BadParameter ( msg , param_hint = \"--yes\" ) _execute_export ( ctx , lambda c : c . order_send_as_df ( request = request ), ) orders \u00b6 orders ( ctx : Context , symbol : Annotated [ str | None , Option ( help = \"Symbol filter.\" ) ] = None , group : Annotated [ str | None , Option ( help = \"Group filter.\" ) ] = None , ticket : Annotated [ int | None , Option ( help = \"Ticket filter.\" ) ] = None , ) -> None Export active orders. Source code in mt5cli/cli.py 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 @app . command () def orders ( ctx : typer . Context , symbol : Annotated [ str | None , typer . Option ( help = \"Symbol filter.\" )] = None , group : Annotated [ str | None , typer . Option ( help = \"Group filter.\" )] = None , ticket : Annotated [ int | None , typer . Option ( help = \"Ticket filter.\" )] = None , ) -> None : \"\"\"Export active orders.\"\"\" _execute_export ( ctx , lambda c : c . orders_get_as_df ( symbol = symbol , group = group , ticket = ticket , ), ) parse_datetime \u00b6 parse_datetime ( value : str ) -> datetime Parse an ISO 8601 datetime string to a timezone-aware datetime. Parameters: Name Type Description Default value str ISO 8601 datetime string (e.g., '2024-01-01' or '2024-01-01T12:00:00+00:00'). required Returns: Type Description datetime Parsed datetime with UTC timezone if no timezone is specified. Raises: Type Description ValueError If the string cannot be parsed. Source code in mt5cli/cli.py 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 def parse_datetime ( value : str ) -> datetime : \"\"\"Parse an ISO 8601 datetime string to a timezone-aware datetime. Args: value: ISO 8601 datetime string (e.g., '2024-01-01' or '2024-01-01T12:00:00+00:00'). Returns: Parsed datetime with UTC timezone if no timezone is specified. Raises: ValueError: If the string cannot be parsed. \"\"\" try : dt = datetime . fromisoformat ( value ) except ValueError : msg = f \"Invalid datetime format: ' { value } '. Use ISO 8601 format.\" raise ValueError ( msg ) from None if dt . tzinfo is None : dt = dt . replace ( tzinfo = UTC ) return dt parse_request \u00b6 parse_request ( value : str ) -> dict [ str , Any ] Parse a JSON-formatted order request string or file reference. Parameters: Name Type Description Default value str JSON object string, or '@path' to read JSON from a file. required Returns: Type Description dict [ str , Any ] Parsed request dictionary. Raises: Type Description ValueError If the request file cannot be read or the value is not a JSON object. Source code in mt5cli/cli.py 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 def parse_request ( value : str ) -> dict [ str , Any ]: \"\"\"Parse a JSON-formatted order request string or file reference. Args: value: JSON object string, or '@path' to read JSON from a file. Returns: Parsed request dictionary. Raises: ValueError: If the request file cannot be read or the value is not a JSON object. \"\"\" if value . startswith ( \"@\" ): path = Path ( value [ 1 :]) try : text = path . read_text ( encoding = \"utf-8\" ) except ( OSError , UnicodeDecodeError ) as exc : msg = f \"Failed to read JSON request file ' { path } ': { exc } \" raise ValueError ( msg ) from exc else : text = value try : parsed : object = json . loads ( text ) except json . JSONDecodeError as exc : msg = f \"Invalid JSON request: { exc } \" raise ValueError ( msg ) from exc if not _is_request_dict ( parsed ): msg = \"Order request must be a JSON object.\" raise ValueError ( msg ) return parsed parse_tick_flags \u00b6 parse_tick_flags ( value : str ) -> int Parse tick flags string or integer value. Parameters: Name Type Description Default value str Tick flag name (ALL, INFO, TRADE) or integer value. required Returns: Type Description int Integer tick flag value. Raises: Type Description ValueError If the flag is invalid. Source code in mt5cli/cli.py 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 def parse_tick_flags ( value : str ) -> int : \"\"\"Parse tick flags string or integer value. Args: value: Tick flag name (ALL, INFO, TRADE) or integer value. Returns: Integer tick flag value. Raises: ValueError: If the flag is invalid. \"\"\" upper = value . upper () if upper in TICK_FLAG_MAP : return TICK_FLAG_MAP [ upper ] try : return int ( value ) except ValueError : valid = \", \" . join ( TICK_FLAG_MAP ) msg = f \"Invalid tick flags: ' { value } '. Use one of: { valid } , or an integer.\" raise ValueError ( msg ) from None parse_timeframe \u00b6 parse_timeframe ( value : str ) -> int Parse a timeframe string or integer value. Parameters: Name Type Description Default value str Timeframe name (e.g., 'M1', 'H1', 'D1') or integer value. required Returns: Type Description int Integer timeframe value. Raises: Type Description ValueError If the timeframe is invalid. Source code in mt5cli/cli.py 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 def parse_timeframe ( value : str ) -> int : \"\"\"Parse a timeframe string or integer value. Args: value: Timeframe name (e.g., 'M1', 'H1', 'D1') or integer value. Returns: Integer timeframe value. Raises: ValueError: If the timeframe is invalid. \"\"\" upper = value . upper () if upper in TIMEFRAME_MAP : return TIMEFRAME_MAP [ upper ] try : return int ( value ) except ValueError : valid = \", \" . join ( TIMEFRAME_MAP ) msg = f \"Invalid timeframe: ' { value } '. Use one of: { valid } , or an integer.\" raise ValueError ( msg ) from None positions \u00b6 positions ( ctx : Context , symbol : Annotated [ str | None , Option ( help = \"Symbol filter.\" ) ] = None , group : Annotated [ str | None , Option ( help = \"Group filter.\" ) ] = None , ticket : Annotated [ int | None , Option ( help = \"Ticket filter.\" ) ] = None , ) -> None Export open positions. Source code in mt5cli/cli.py 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 @app . command () def positions ( ctx : typer . Context , symbol : Annotated [ str | None , typer . Option ( help = \"Symbol filter.\" )] = None , group : Annotated [ str | None , typer . Option ( help = \"Group filter.\" )] = None , ticket : Annotated [ int | None , typer . Option ( help = \"Ticket filter.\" )] = None , ) -> None : \"\"\"Export open positions.\"\"\" _execute_export ( ctx , lambda c : c . positions_get_as_df ( symbol = symbol , group = group , ticket = ticket , ), ) rates_from \u00b6 rates_from ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe (e.g., M1, H1, D1, or integer).\" , ), ], date_from : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"Start date in ISO 8601 format.\" , ), ], count : Annotated [ int , Option ( help = \"Number of records.\" ) ], ) -> None Export rates from a start date. Source code in mt5cli/cli.py 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 @app . command () def rates_from ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , typer . Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe (e.g., M1, H1, D1, or integer).\" , ), ], date_from : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date in ISO 8601 format.\" , ), ], count : Annotated [ int , typer . Option ( help = \"Number of records.\" )], ) -> None : \"\"\"Export rates from a start date.\"\"\" _execute_export ( ctx , lambda c : c . copy_rates_from_as_df ( symbol = symbol , timeframe = timeframe , date_from = date_from , count = count , ), ) rates_from_pos \u00b6 rates_from_pos ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe.\" ), ], start_pos : Annotated [ int , Option ( help = \"Start position (0 = current bar).\" ), ], count : Annotated [ int , Option ( help = \"Number of records.\" ) ], ) -> None Export rates from a start position. Source code in mt5cli/cli.py 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 @app . command () def rates_from_pos ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , typer . Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe.\" , ), ], start_pos : Annotated [ int , typer . Option ( help = \"Start position (0 = current bar).\" )], count : Annotated [ int , typer . Option ( help = \"Number of records.\" )], ) -> None : \"\"\"Export rates from a start position.\"\"\" _execute_export ( ctx , lambda c : c . copy_rates_from_pos_as_df ( symbol = symbol , timeframe = timeframe , start_pos = start_pos , count = count , ), ) rates_range \u00b6 rates_range ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe.\" ), ], date_from : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], date_to : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ], ) -> None Export rates for a date range. Source code in mt5cli/cli.py 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 @app . command () def rates_range ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , typer . Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe.\" , ), ], date_from : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], date_to : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ], ) -> None : \"\"\"Export rates for a date range.\"\"\" _execute_export ( ctx , lambda c : c . copy_rates_range_as_df ( symbol = symbol , timeframe = timeframe , date_from = date_from , date_to = date_to , ), ) symbol_info \u00b6 symbol_info ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], ) -> None Export symbol details. Source code in mt5cli/cli.py 712 713 714 715 716 717 718 719 720 721 @app . command () def symbol_info ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], ) -> None : \"\"\"Export symbol details.\"\"\" _execute_export ( ctx , lambda c : c . symbol_info_as_df ( symbol = symbol ), ) symbol_info_tick \u00b6 symbol_info_tick ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], ) -> None Export the last tick for a symbol. Source code in mt5cli/cli.py 832 833 834 835 836 837 838 839 840 841 @app . command () def symbol_info_tick ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], ) -> None : \"\"\"Export the last tick for a symbol.\"\"\" _execute_export ( ctx , lambda c : c . symbol_info_tick_as_df ( symbol = symbol ), ) symbols \u00b6 symbols ( ctx : Context , group : Annotated [ str | None , Option ( help = \"Symbol group filter (e.g., *USD*).\" ), ] = None , ) -> None Export symbol list. Source code in mt5cli/cli.py 697 698 699 700 701 702 703 704 705 706 707 708 709 @app . command () def symbols ( ctx : typer . Context , group : Annotated [ str | None , typer . Option ( help = \"Symbol group filter (e.g., *USD*).\" ), ] = None , ) -> None : \"\"\"Export symbol list.\"\"\" _execute_export ( ctx , lambda c : c . symbols_get_as_df ( group = group ), ) terminal_info \u00b6 terminal_info ( ctx : Context ) -> None Export terminal information. Source code in mt5cli/cli.py 691 692 693 694 @app . command () def terminal_info ( ctx : typer . Context ) -> None : \"\"\"Export terminal information.\"\"\" _execute_export ( ctx , lambda c : c . terminal_info_as_df ()) ticks_from \u00b6 ticks_from ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], date_from : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], count : Annotated [ int , Option ( help = \"Number of ticks.\" )], flags : Annotated [ int , Option ( click_type = TICK_FLAGS_TYPE , help = \"Tick flags (ALL, INFO, TRADE, or integer).\" , ), ], ) -> None Export ticks from a start date. Source code in mt5cli/cli.py 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 @app . command () def ticks_from ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], date_from : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], count : Annotated [ int , typer . Option ( help = \"Number of ticks.\" )], flags : Annotated [ int , typer . Option ( click_type = TICK_FLAGS_TYPE , help = \"Tick flags (ALL, INFO, TRADE, or integer).\" , ), ], ) -> None : \"\"\"Export ticks from a start date.\"\"\" _execute_export ( ctx , lambda c : c . copy_ticks_from_as_df ( symbol = symbol , date_from = date_from , count = count , flags = flags , ), ) ticks_range \u00b6 ticks_range ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], date_from : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], date_to : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ], flags : Annotated [ int , Option ( click_type = TICK_FLAGS_TYPE , help = \"Tick flags.\" ), ], ) -> None Export ticks for a date range. Source code in mt5cli/cli.py 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 @app . command () def ticks_range ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], date_from : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], date_to : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ], flags : Annotated [ int , typer . Option ( click_type = TICK_FLAGS_TYPE , help = \"Tick flags.\" ), ], ) -> None : \"\"\"Export ticks for a date range.\"\"\" _execute_export ( ctx , lambda c : c . copy_ticks_range_as_df ( symbol = symbol , date_from = date_from , date_to = date_to , flags = flags , ), ) version \u00b6 version ( ctx : Context ) -> None Export MetaTrader5 version information. Source code in mt5cli/cli.py 820 821 822 823 @app . command () def version ( ctx : typer . Context ) -> None : \"\"\"Export MetaTrader5 version information.\"\"\" _execute_export ( ctx , lambda c : c . version_as_df ())","title":"CLI"},{"location":"api/cli/#cli-module","text":"","title":"CLI Module"},{"location":"api/cli/#mt5cli.cli","text":"Command-line interface for MetaTrader 5 data export.","title":"cli"},{"location":"api/cli/#mt5cli.cli.DATETIME_TYPE","text":"DATETIME_TYPE = _DateTimeType ()","title":"DATETIME_TYPE"},{"location":"api/cli/#mt5cli.cli.REQUEST_TYPE","text":"REQUEST_TYPE = _RequestType ()","title":"REQUEST_TYPE"},{"location":"api/cli/#mt5cli.cli.TICK_FLAGS_TYPE","text":"TICK_FLAGS_TYPE = _TickFlagsType ()","title":"TICK_FLAGS_TYPE"},{"location":"api/cli/#mt5cli.cli.TICK_FLAG_MAP","text":"TICK_FLAG_MAP : dict [ str , int ] = { \"ALL\" : 1 , \"INFO\" : 2 , \"TRADE\" : 4 , }","title":"TICK_FLAG_MAP"},{"location":"api/cli/#mt5cli.cli.TIMEFRAME_MAP","text":"TIMEFRAME_MAP : dict [ str , int ] = { \"M1\" : 1 , \"M2\" : 2 , \"M3\" : 3 , \"M4\" : 4 , \"M5\" : 5 , \"M6\" : 6 , \"M10\" : 10 , \"M12\" : 12 , \"M15\" : 15 , \"M20\" : 20 , \"M30\" : 30 , \"H1\" : 16385 , \"H2\" : 16386 , \"H3\" : 16387 , \"H4\" : 16388 , \"H6\" : 16390 , \"H8\" : 16392 , \"H12\" : 16396 , \"D1\" : 16408 , \"W1\" : 32769 , \"MN1\" : 49153 , }","title":"TIMEFRAME_MAP"},{"location":"api/cli/#mt5cli.cli.TIMEFRAME_TYPE","text":"TIMEFRAME_TYPE = _TimeframeType ()","title":"TIMEFRAME_TYPE"},{"location":"api/cli/#mt5cli.cli.app","text":"app = Typer ( name = \"mt5cli\" , help = \"Export MetaTrader5 data to CSV, JSON, Parquet, or SQLite3.\" , )","title":"app"},{"location":"api/cli/#mt5cli.cli.logger","text":"logger = getLogger ( __name__ )","title":"logger"},{"location":"api/cli/#mt5cli.cli.LogLevel","text":"Bases: StrEnum Logging verbosity levels.","title":"LogLevel"},{"location":"api/cli/#mt5cli.cli.LogLevel.DEBUG","text":"DEBUG = 'DEBUG'","title":"DEBUG"},{"location":"api/cli/#mt5cli.cli.LogLevel.ERROR","text":"ERROR = 'ERROR'","title":"ERROR"},{"location":"api/cli/#mt5cli.cli.LogLevel.INFO","text":"INFO = 'INFO'","title":"INFO"},{"location":"api/cli/#mt5cli.cli.LogLevel.WARNING","text":"WARNING = 'WARNING'","title":"WARNING"},{"location":"api/cli/#mt5cli.cli.OutputFormat","text":"Bases: StrEnum Supported output file formats.","title":"OutputFormat"},{"location":"api/cli/#mt5cli.cli.OutputFormat.csv","text":"csv = 'csv'","title":"csv"},{"location":"api/cli/#mt5cli.cli.OutputFormat.json","text":"json = 'json'","title":"json"},{"location":"api/cli/#mt5cli.cli.OutputFormat.parquet","text":"parquet = 'parquet'","title":"parquet"},{"location":"api/cli/#mt5cli.cli.OutputFormat.sqlite3","text":"sqlite3 = 'sqlite3'","title":"sqlite3"},{"location":"api/cli/#mt5cli.cli.account_info","text":"account_info ( ctx : Context ) -> None Export account information. Source code in mt5cli/cli.py 685 686 687 688 @app . command () def account_info ( ctx : typer . Context ) -> None : \"\"\"Export account information.\"\"\" _execute_export ( ctx , lambda c : c . account_info_as_df ())","title":"account_info"},{"location":"api/cli/#mt5cli.cli.detect_format","text":"detect_format ( output_path : Path , explicit_format : str | None = None ) -> str Detect the output format from a file extension or explicit format string. Parameters: Name Type Description Default output_path Path Path to the output file. required explicit_format str | None Explicitly specified format, if any. None Returns: Type Description str The detected format string. Raises: Type Description ValueError If the format cannot be determined. Source code in mt5cli/cli.py 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 def detect_format ( output_path : Path , explicit_format : str | None = None , ) -> str : \"\"\"Detect the output format from a file extension or explicit format string. Args: output_path: Path to the output file. explicit_format: Explicitly specified format, if any. Returns: The detected format string. Raises: ValueError: If the format cannot be determined. \"\"\" if explicit_format is not None : return explicit_format suffix = output_path . suffix . lower () if suffix in _FORMAT_EXTENSIONS : return _FORMAT_EXTENSIONS [ suffix ] msg = ( f \"Cannot detect format from extension ' { suffix } '.\" \" Use --format to specify the output format.\" ) raise ValueError ( msg )","title":"detect_format"},{"location":"api/cli/#mt5cli.cli.export_dataframe","text":"export_dataframe ( df : DataFrame , output_path : Path , output_format : str , table_name : str = \"data\" , ) -> None Export a pandas DataFrame to the specified file format. Parameters: Name Type Description Default df DataFrame DataFrame to export. required output_path Path Path to the output file. required output_format str Output format (csv, json, parquet, or sqlite3). required table_name str Table name for SQLite3 output. 'data' Raises: Type Description ValueError If the output format is not supported. Source code in mt5cli/cli.py 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 def export_dataframe ( df : pd . DataFrame , output_path : Path , output_format : str , table_name : str = \"data\" , ) -> None : \"\"\"Export a pandas DataFrame to the specified file format. Args: df: DataFrame to export. output_path: Path to the output file. output_format: Output format (csv, json, parquet, or sqlite3). table_name: Table name for SQLite3 output. Raises: ValueError: If the output format is not supported. \"\"\" if output_format == \"csv\" : df . to_csv ( output_path , index = False ) elif output_format == \"json\" : df . to_json ( output_path , orient = \"records\" , date_format = \"iso\" , indent = 2 , ) elif output_format == \"parquet\" : df . to_parquet ( output_path , index = False ) elif output_format == \"sqlite3\" : with sqlite3 . connect ( output_path ) as conn : df . to_sql ( # type: ignore[reportUnknownMemberType] table_name , conn , if_exists = \"replace\" , index = False , ) else : msg = f \"Unsupported output format: { output_format } \" raise ValueError ( msg )","title":"export_dataframe"},{"location":"api/cli/#mt5cli.cli.history_deals","text":"history_deals ( ctx : Context , date_from : Annotated [ datetime | None , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ] = None , date_to : Annotated [ datetime | None , Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ] = None , group : Annotated [ str | None , Option ( help = \"Group filter.\" ) ] = None , symbol : Annotated [ str | None , Option ( help = \"Symbol filter.\" ) ] = None , ticket : Annotated [ int | None , Option ( help = \"Order ticket.\" ) ] = None , position : Annotated [ int | None , Option ( help = \"Position ticket.\" ) ] = None , ) -> None Export historical deals. Source code in mt5cli/cli.py 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 @app . command () def history_deals ( ctx : typer . Context , date_from : Annotated [ datetime | None , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ] = None , date_to : Annotated [ datetime | None , typer . Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ] = None , group : Annotated [ str | None , typer . Option ( help = \"Group filter.\" )] = None , symbol : Annotated [ str | None , typer . Option ( help = \"Symbol filter.\" )] = None , ticket : Annotated [ int | None , typer . Option ( help = \"Order ticket.\" )] = None , position : Annotated [ int | None , typer . Option ( help = \"Position ticket.\" )] = None , ) -> None : \"\"\"Export historical deals.\"\"\" _execute_export ( ctx , lambda c : c . history_deals_get_as_df ( date_from = date_from , date_to = date_to , group = group , symbol = symbol , ticket = ticket , position = position , ), )","title":"history_deals"},{"location":"api/cli/#mt5cli.cli.history_orders","text":"history_orders ( ctx : Context , date_from : Annotated [ datetime | None , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ] = None , date_to : Annotated [ datetime | None , Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ] = None , group : Annotated [ str | None , Option ( help = \"Group filter.\" ) ] = None , symbol : Annotated [ str | None , Option ( help = \"Symbol filter.\" ) ] = None , ticket : Annotated [ int | None , Option ( help = \"Order ticket.\" ) ] = None , position : Annotated [ int | None , Option ( help = \"Position ticket.\" ) ] = None , ) -> None Export historical orders. Source code in mt5cli/cli.py 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 @app . command () def history_orders ( ctx : typer . Context , date_from : Annotated [ datetime | None , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ] = None , date_to : Annotated [ datetime | None , typer . Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ] = None , group : Annotated [ str | None , typer . Option ( help = \"Group filter.\" )] = None , symbol : Annotated [ str | None , typer . Option ( help = \"Symbol filter.\" )] = None , ticket : Annotated [ int | None , typer . Option ( help = \"Order ticket.\" )] = None , position : Annotated [ int | None , typer . Option ( help = \"Position ticket.\" )] = None , ) -> None : \"\"\"Export historical orders.\"\"\" _execute_export ( ctx , lambda c : c . history_orders_get_as_df ( date_from = date_from , date_to = date_to , group = group , symbol = symbol , ticket = ticket , position = position , ), )","title":"history_orders"},{"location":"api/cli/#mt5cli.cli.last_error","text":"last_error ( ctx : Context ) -> None Export the last error information. Source code in mt5cli/cli.py 826 827 828 829 @app . command () def last_error ( ctx : typer . Context ) -> None : \"\"\"Export the last error information.\"\"\" _execute_export ( ctx , lambda c : c . last_error_as_df ())","title":"last_error"},{"location":"api/cli/#mt5cli.cli.main","text":"main () -> None Run the mt5cli CLI. Source code in mt5cli/cli.py 897 898 899 def main () -> None : \"\"\"Run the mt5cli CLI.\"\"\" app ()","title":"main"},{"location":"api/cli/#mt5cli.cli.market_book","text":"market_book ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], ) -> None Export market depth (order book) for a symbol. Source code in mt5cli/cli.py 844 845 846 847 848 849 850 851 852 853 @app . command () def market_book ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], ) -> None : \"\"\"Export market depth (order book) for a symbol.\"\"\" _execute_export ( ctx , lambda c : c . market_book_get_as_df ( symbol = symbol ), )","title":"market_book"},{"location":"api/cli/#mt5cli.cli.order_check","text":"order_check ( ctx : Context , request : Annotated [ dict [ str , Any ], Option ( click_type = REQUEST_TYPE , help = _REQUEST_OPTION_HELP , ), ], ) -> None Check funds sufficiency for a trading operation. Source code in mt5cli/cli.py 856 857 858 859 860 861 862 863 864 865 866 867 868 @app . command () def order_check ( ctx : typer . Context , request : Annotated [ dict [ str , Any ], typer . Option ( click_type = REQUEST_TYPE , help = _REQUEST_OPTION_HELP ), ], ) -> None : \"\"\"Check funds sufficiency for a trading operation.\"\"\" _execute_export ( ctx , lambda c : c . order_check_as_df ( request = request ), )","title":"order_check"},{"location":"api/cli/#mt5cli.cli.order_send","text":"order_send ( ctx : Context , request : Annotated [ dict [ str , Any ], Option ( click_type = REQUEST_TYPE , help = _REQUEST_OPTION_HELP , ), ], yes : Annotated [ bool , Option ( \"--yes\" , help = \"Confirm the live trade request.\" ), ] = False , ) -> None Send a trading operation request to the trade server. Raises: Type Description BadParameter If --yes is not provided. Source code in mt5cli/cli.py 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 @app . command () def order_send ( ctx : typer . Context , request : Annotated [ dict [ str , Any ], typer . Option ( click_type = REQUEST_TYPE , help = _REQUEST_OPTION_HELP ), ], yes : Annotated [ bool , typer . Option ( \"--yes\" , help = \"Confirm the live trade request.\" ), ] = False , ) -> None : \"\"\"Send a trading operation request to the trade server. Raises: typer.BadParameter: If --yes is not provided. \"\"\" if not yes : msg = \"Pass --yes to send a live trade request.\" raise typer . BadParameter ( msg , param_hint = \"--yes\" ) _execute_export ( ctx , lambda c : c . order_send_as_df ( request = request ), )","title":"order_send"},{"location":"api/cli/#mt5cli.cli.orders","text":"orders ( ctx : Context , symbol : Annotated [ str | None , Option ( help = \"Symbol filter.\" ) ] = None , group : Annotated [ str | None , Option ( help = \"Group filter.\" ) ] = None , ticket : Annotated [ int | None , Option ( help = \"Ticket filter.\" ) ] = None , ) -> None Export active orders. Source code in mt5cli/cli.py 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 @app . command () def orders ( ctx : typer . Context , symbol : Annotated [ str | None , typer . Option ( help = \"Symbol filter.\" )] = None , group : Annotated [ str | None , typer . Option ( help = \"Group filter.\" )] = None , ticket : Annotated [ int | None , typer . Option ( help = \"Ticket filter.\" )] = None , ) -> None : \"\"\"Export active orders.\"\"\" _execute_export ( ctx , lambda c : c . orders_get_as_df ( symbol = symbol , group = group , ticket = ticket , ), )","title":"orders"},{"location":"api/cli/#mt5cli.cli.parse_datetime","text":"parse_datetime ( value : str ) -> datetime Parse an ISO 8601 datetime string to a timezone-aware datetime. Parameters: Name Type Description Default value str ISO 8601 datetime string (e.g., '2024-01-01' or '2024-01-01T12:00:00+00:00'). required Returns: Type Description datetime Parsed datetime with UTC timezone if no timezone is specified. Raises: Type Description ValueError If the string cannot be parsed. Source code in mt5cli/cli.py 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 def parse_datetime ( value : str ) -> datetime : \"\"\"Parse an ISO 8601 datetime string to a timezone-aware datetime. Args: value: ISO 8601 datetime string (e.g., '2024-01-01' or '2024-01-01T12:00:00+00:00'). Returns: Parsed datetime with UTC timezone if no timezone is specified. Raises: ValueError: If the string cannot be parsed. \"\"\" try : dt = datetime . fromisoformat ( value ) except ValueError : msg = f \"Invalid datetime format: ' { value } '. Use ISO 8601 format.\" raise ValueError ( msg ) from None if dt . tzinfo is None : dt = dt . replace ( tzinfo = UTC ) return dt","title":"parse_datetime"},{"location":"api/cli/#mt5cli.cli.parse_request","text":"parse_request ( value : str ) -> dict [ str , Any ] Parse a JSON-formatted order request string or file reference. Parameters: Name Type Description Default value str JSON object string, or '@path' to read JSON from a file. required Returns: Type Description dict [ str , Any ] Parsed request dictionary. Raises: Type Description ValueError If the request file cannot be read or the value is not a JSON object. Source code in mt5cli/cli.py 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 def parse_request ( value : str ) -> dict [ str , Any ]: \"\"\"Parse a JSON-formatted order request string or file reference. Args: value: JSON object string, or '@path' to read JSON from a file. Returns: Parsed request dictionary. Raises: ValueError: If the request file cannot be read or the value is not a JSON object. \"\"\" if value . startswith ( \"@\" ): path = Path ( value [ 1 :]) try : text = path . read_text ( encoding = \"utf-8\" ) except ( OSError , UnicodeDecodeError ) as exc : msg = f \"Failed to read JSON request file ' { path } ': { exc } \" raise ValueError ( msg ) from exc else : text = value try : parsed : object = json . loads ( text ) except json . JSONDecodeError as exc : msg = f \"Invalid JSON request: { exc } \" raise ValueError ( msg ) from exc if not _is_request_dict ( parsed ): msg = \"Order request must be a JSON object.\" raise ValueError ( msg ) return parsed","title":"parse_request"},{"location":"api/cli/#mt5cli.cli.parse_tick_flags","text":"parse_tick_flags ( value : str ) -> int Parse tick flags string or integer value. Parameters: Name Type Description Default value str Tick flag name (ALL, INFO, TRADE) or integer value. required Returns: Type Description int Integer tick flag value. Raises: Type Description ValueError If the flag is invalid. Source code in mt5cli/cli.py 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 def parse_tick_flags ( value : str ) -> int : \"\"\"Parse tick flags string or integer value. Args: value: Tick flag name (ALL, INFO, TRADE) or integer value. Returns: Integer tick flag value. Raises: ValueError: If the flag is invalid. \"\"\" upper = value . upper () if upper in TICK_FLAG_MAP : return TICK_FLAG_MAP [ upper ] try : return int ( value ) except ValueError : valid = \", \" . join ( TICK_FLAG_MAP ) msg = f \"Invalid tick flags: ' { value } '. Use one of: { valid } , or an integer.\" raise ValueError ( msg ) from None","title":"parse_tick_flags"},{"location":"api/cli/#mt5cli.cli.parse_timeframe","text":"parse_timeframe ( value : str ) -> int Parse a timeframe string or integer value. Parameters: Name Type Description Default value str Timeframe name (e.g., 'M1', 'H1', 'D1') or integer value. required Returns: Type Description int Integer timeframe value. Raises: Type Description ValueError If the timeframe is invalid. Source code in mt5cli/cli.py 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 def parse_timeframe ( value : str ) -> int : \"\"\"Parse a timeframe string or integer value. Args: value: Timeframe name (e.g., 'M1', 'H1', 'D1') or integer value. Returns: Integer timeframe value. Raises: ValueError: If the timeframe is invalid. \"\"\" upper = value . upper () if upper in TIMEFRAME_MAP : return TIMEFRAME_MAP [ upper ] try : return int ( value ) except ValueError : valid = \", \" . join ( TIMEFRAME_MAP ) msg = f \"Invalid timeframe: ' { value } '. Use one of: { valid } , or an integer.\" raise ValueError ( msg ) from None","title":"parse_timeframe"},{"location":"api/cli/#mt5cli.cli.positions","text":"positions ( ctx : Context , symbol : Annotated [ str | None , Option ( help = \"Symbol filter.\" ) ] = None , group : Annotated [ str | None , Option ( help = \"Group filter.\" ) ] = None , ticket : Annotated [ int | None , Option ( help = \"Ticket filter.\" ) ] = None , ) -> None Export open positions. Source code in mt5cli/cli.py 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 @app . command () def positions ( ctx : typer . Context , symbol : Annotated [ str | None , typer . Option ( help = \"Symbol filter.\" )] = None , group : Annotated [ str | None , typer . Option ( help = \"Group filter.\" )] = None , ticket : Annotated [ int | None , typer . Option ( help = \"Ticket filter.\" )] = None , ) -> None : \"\"\"Export open positions.\"\"\" _execute_export ( ctx , lambda c : c . positions_get_as_df ( symbol = symbol , group = group , ticket = ticket , ), )","title":"positions"},{"location":"api/cli/#mt5cli.cli.rates_from","text":"rates_from ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe (e.g., M1, H1, D1, or integer).\" , ), ], date_from : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"Start date in ISO 8601 format.\" , ), ], count : Annotated [ int , Option ( help = \"Number of records.\" ) ], ) -> None Export rates from a start date. Source code in mt5cli/cli.py 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 @app . command () def rates_from ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , typer . Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe (e.g., M1, H1, D1, or integer).\" , ), ], date_from : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date in ISO 8601 format.\" , ), ], count : Annotated [ int , typer . Option ( help = \"Number of records.\" )], ) -> None : \"\"\"Export rates from a start date.\"\"\" _execute_export ( ctx , lambda c : c . copy_rates_from_as_df ( symbol = symbol , timeframe = timeframe , date_from = date_from , count = count , ), )","title":"rates_from"},{"location":"api/cli/#mt5cli.cli.rates_from_pos","text":"rates_from_pos ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe.\" ), ], start_pos : Annotated [ int , Option ( help = \"Start position (0 = current bar).\" ), ], count : Annotated [ int , Option ( help = \"Number of records.\" ) ], ) -> None Export rates from a start position. Source code in mt5cli/cli.py 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 @app . command () def rates_from_pos ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , typer . Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe.\" , ), ], start_pos : Annotated [ int , typer . Option ( help = \"Start position (0 = current bar).\" )], count : Annotated [ int , typer . Option ( help = \"Number of records.\" )], ) -> None : \"\"\"Export rates from a start position.\"\"\" _execute_export ( ctx , lambda c : c . copy_rates_from_pos_as_df ( symbol = symbol , timeframe = timeframe , start_pos = start_pos , count = count , ), )","title":"rates_from_pos"},{"location":"api/cli/#mt5cli.cli.rates_range","text":"rates_range ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe.\" ), ], date_from : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], date_to : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ], ) -> None Export rates for a date range. Source code in mt5cli/cli.py 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 @app . command () def rates_range ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , typer . Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe.\" , ), ], date_from : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], date_to : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ], ) -> None : \"\"\"Export rates for a date range.\"\"\" _execute_export ( ctx , lambda c : c . copy_rates_range_as_df ( symbol = symbol , timeframe = timeframe , date_from = date_from , date_to = date_to , ), )","title":"rates_range"},{"location":"api/cli/#mt5cli.cli.symbol_info","text":"symbol_info ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], ) -> None Export symbol details. Source code in mt5cli/cli.py 712 713 714 715 716 717 718 719 720 721 @app . command () def symbol_info ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], ) -> None : \"\"\"Export symbol details.\"\"\" _execute_export ( ctx , lambda c : c . symbol_info_as_df ( symbol = symbol ), )","title":"symbol_info"},{"location":"api/cli/#mt5cli.cli.symbol_info_tick","text":"symbol_info_tick ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], ) -> None Export the last tick for a symbol. Source code in mt5cli/cli.py 832 833 834 835 836 837 838 839 840 841 @app . command () def symbol_info_tick ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], ) -> None : \"\"\"Export the last tick for a symbol.\"\"\" _execute_export ( ctx , lambda c : c . symbol_info_tick_as_df ( symbol = symbol ), )","title":"symbol_info_tick"},{"location":"api/cli/#mt5cli.cli.symbols","text":"symbols ( ctx : Context , group : Annotated [ str | None , Option ( help = \"Symbol group filter (e.g., *USD*).\" ), ] = None , ) -> None Export symbol list. Source code in mt5cli/cli.py 697 698 699 700 701 702 703 704 705 706 707 708 709 @app . command () def symbols ( ctx : typer . Context , group : Annotated [ str | None , typer . Option ( help = \"Symbol group filter (e.g., *USD*).\" ), ] = None , ) -> None : \"\"\"Export symbol list.\"\"\" _execute_export ( ctx , lambda c : c . symbols_get_as_df ( group = group ), )","title":"symbols"},{"location":"api/cli/#mt5cli.cli.terminal_info","text":"terminal_info ( ctx : Context ) -> None Export terminal information. Source code in mt5cli/cli.py 691 692 693 694 @app . command () def terminal_info ( ctx : typer . Context ) -> None : \"\"\"Export terminal information.\"\"\" _execute_export ( ctx , lambda c : c . terminal_info_as_df ())","title":"terminal_info"},{"location":"api/cli/#mt5cli.cli.ticks_from","text":"ticks_from ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], date_from : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], count : Annotated [ int , Option ( help = \"Number of ticks.\" )], flags : Annotated [ int , Option ( click_type = TICK_FLAGS_TYPE , help = \"Tick flags (ALL, INFO, TRADE, or integer).\" , ), ], ) -> None Export ticks from a start date. Source code in mt5cli/cli.py 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 @app . command () def ticks_from ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], date_from : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], count : Annotated [ int , typer . Option ( help = \"Number of ticks.\" )], flags : Annotated [ int , typer . Option ( click_type = TICK_FLAGS_TYPE , help = \"Tick flags (ALL, INFO, TRADE, or integer).\" , ), ], ) -> None : \"\"\"Export ticks from a start date.\"\"\" _execute_export ( ctx , lambda c : c . copy_ticks_from_as_df ( symbol = symbol , date_from = date_from , count = count , flags = flags , ), )","title":"ticks_from"},{"location":"api/cli/#mt5cli.cli.ticks_range","text":"ticks_range ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], date_from : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], date_to : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ], flags : Annotated [ int , Option ( click_type = TICK_FLAGS_TYPE , help = \"Tick flags.\" ), ], ) -> None Export ticks for a date range. Source code in mt5cli/cli.py 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 @app . command () def ticks_range ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], date_from : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], date_to : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ], flags : Annotated [ int , typer . Option ( click_type = TICK_FLAGS_TYPE , help = \"Tick flags.\" ), ], ) -> None : \"\"\"Export ticks for a date range.\"\"\" _execute_export ( ctx , lambda c : c . copy_ticks_range_as_df ( symbol = symbol , date_from = date_from , date_to = date_to , flags = flags , ), )","title":"ticks_range"},{"location":"api/cli/#mt5cli.cli.version","text":"version ( ctx : Context ) -> None Export MetaTrader5 version information. Source code in mt5cli/cli.py 820 821 822 823 @app . command () def version ( ctx : typer . Context ) -> None : \"\"\"Export MetaTrader5 version information.\"\"\" _execute_export ( ctx , lambda c : c . version_as_df ())","title":"version"}]} \ No newline at end of file +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"mt5cli \u00b6 Command-line tool for MetaTrader 5 data export. Overview \u00b6 mt5cli is a CLI application that exports MetaTrader 5 trading data to multiple file formats. It is built on top of pdmt5 , a pandas-based data handler for MetaTrader 5. Features \u00b6 Multi-format export : CSV, JSON, Parquet, and SQLite3 output formats Auto-detection : Format detection from file extensions Comprehensive data access : Rates, ticks, account info, symbols, orders, positions, and trading history Flexible timeframes : Named timeframes (M1, H1, D1, etc.) and numeric values Connection management : Optional credentials, server, and timeout configuration Installation \u00b6 pip install mt5cli Quick Start \u00b6 # Export account information to CSV mt5cli -o account.csv account-info # Export EURUSD M1 rates to Parquet mt5cli -o rates.parquet rates-from --symbol EURUSD --timeframe M1 \\ --date-from 2024 -01-01 --count 1000 # Export ticks to JSON mt5cli -o ticks.json ticks-from --symbol EURUSD \\ --date-from 2024 -01-01 --count 500 --flags ALL # Export symbols to SQLite3 with custom table name mt5cli -o data.db --table symbols symbols --group \"*USD*\" # Export with connection credentials mt5cli --login 12345 --password mypass --server MyBroker-Demo \\ -o positions.csv positions Commands \u00b6 Rates \u00b6 Command Description rates-from Export rates from a start date rates-from-pos Export rates from a start position rates-range Export rates for a date range Ticks \u00b6 Command Description ticks-from Export ticks from a start date ticks-range Export ticks for a date range Information \u00b6 Command Description account-info Export account information terminal-info Export terminal information version Export MetaTrader 5 version information last-error Export the last error information symbols Export symbol list symbol-info Export symbol details symbol-info-tick Export the last tick for a symbol market-book Export market depth (order book) Trading \u00b6 Command Description orders Export active orders positions Export open positions history-orders Export historical orders history-deals Export historical deals order-check Check funds sufficiency for a trade request order-send Send a trade request to the trade server ( --yes required) Use order-check to validate a request payload before running order-send --yes . Bulk Collection \u00b6 Command Description collect-history Collect rates, ticks, history-orders, and history-deals for one or more symbols into a single SQLite database (optional cash-event/position views) mt5cli -o history.db collect-history \\ --symbol EURUSD --symbol GBPUSD \\ --date-from 2024 -01-01 --date-to 2024 -02-01 \\ --dataset rates --dataset history-deals \\ --timeframe M1 --flags ALL --if-exists append --with-views collect-history options: Option Default Description --symbol/-s required Symbol to collect (repeat for multiple). --date-from required Start date in ISO 8601. --date-to required End date in ISO 8601. --dataset all four Repeatable: rates , ticks , history-orders , history-deals . --timeframe M1 Rates timeframe; recorded in a timeframe column on the rates table. --flags ALL Tick copy flags forwarded to copy_ticks_range . --if-exists fail append , replace , or fail when a target table already exists. --with-views off Add cash_events and positions_reconstructed views (requires the history-deals dataset). History orders and deals are fetched per symbol and concatenated, so the symbol filter is applied consistently across all datasets. The cash_events view is derived from symbol-filtered history_deals , so account-level cash events with empty or non-matching symbols may be excluded. The positions_reconstructed view excludes positions with no closing deal, uses volume-weighted open/close prices, and reports reversal deals ( DEAL_ENTRY_INOUT ) via volume_reversal / reversal_count . Global Options \u00b6 Option Description -o, --output Output file path (required) -f, --format Output format (auto-detected from extension if omitted) --table Table name for SQLite3 output (default: \"data\") --login Trading account login --password Trading account password --server Trading server name --path Path to MetaTrader5 terminal EXE file --timeout Connection timeout in milliseconds --log-level Logging level (DEBUG, INFO, WARNING, ERROR) Requirements \u00b6 Python 3.11+ Windows OS (MetaTrader 5 requirement) MetaTrader 5 platform API Reference \u00b6 Browse the API documentation for detailed module information: CLI Module - CLI application with export commands and utility functions Development \u00b6 This project follows strict code quality standards: Type hints required (strict mode) Comprehensive linting with Ruff Test coverage tracking Google-style docstrings License \u00b6 MIT License - see LICENSE file for details.","title":"Home"},{"location":"#mt5cli","text":"Command-line tool for MetaTrader 5 data export.","title":"mt5cli"},{"location":"#overview","text":"mt5cli is a CLI application that exports MetaTrader 5 trading data to multiple file formats. It is built on top of pdmt5 , a pandas-based data handler for MetaTrader 5.","title":"Overview"},{"location":"#features","text":"Multi-format export : CSV, JSON, Parquet, and SQLite3 output formats Auto-detection : Format detection from file extensions Comprehensive data access : Rates, ticks, account info, symbols, orders, positions, and trading history Flexible timeframes : Named timeframes (M1, H1, D1, etc.) and numeric values Connection management : Optional credentials, server, and timeout configuration","title":"Features"},{"location":"#installation","text":"pip install mt5cli","title":"Installation"},{"location":"#quick-start","text":"# Export account information to CSV mt5cli -o account.csv account-info # Export EURUSD M1 rates to Parquet mt5cli -o rates.parquet rates-from --symbol EURUSD --timeframe M1 \\ --date-from 2024 -01-01 --count 1000 # Export ticks to JSON mt5cli -o ticks.json ticks-from --symbol EURUSD \\ --date-from 2024 -01-01 --count 500 --flags ALL # Export symbols to SQLite3 with custom table name mt5cli -o data.db --table symbols symbols --group \"*USD*\" # Export with connection credentials mt5cli --login 12345 --password mypass --server MyBroker-Demo \\ -o positions.csv positions","title":"Quick Start"},{"location":"#commands","text":"","title":"Commands"},{"location":"#rates","text":"Command Description rates-from Export rates from a start date rates-from-pos Export rates from a start position rates-range Export rates for a date range","title":"Rates"},{"location":"#ticks","text":"Command Description ticks-from Export ticks from a start date ticks-range Export ticks for a date range","title":"Ticks"},{"location":"#information","text":"Command Description account-info Export account information terminal-info Export terminal information version Export MetaTrader 5 version information last-error Export the last error information symbols Export symbol list symbol-info Export symbol details symbol-info-tick Export the last tick for a symbol market-book Export market depth (order book)","title":"Information"},{"location":"#trading","text":"Command Description orders Export active orders positions Export open positions history-orders Export historical orders history-deals Export historical deals order-check Check funds sufficiency for a trade request order-send Send a trade request to the trade server ( --yes required) Use order-check to validate a request payload before running order-send --yes .","title":"Trading"},{"location":"#bulk-collection","text":"Command Description collect-history Collect rates, ticks, history-orders, and history-deals for one or more symbols into a single SQLite database (optional cash-event/position views) mt5cli -o history.db collect-history \\ --symbol EURUSD --symbol GBPUSD \\ --date-from 2024 -01-01 --date-to 2024 -02-01 \\ --dataset rates --dataset history-deals \\ --timeframe M1 --flags ALL --if-exists append --with-views collect-history options: Option Default Description --symbol/-s required Symbol to collect (repeat for multiple). --date-from required Start date in ISO 8601. --date-to required End date in ISO 8601. --dataset all four Repeatable: rates , ticks , history-orders , history-deals . --timeframe M1 Rates timeframe; recorded in a timeframe column on the rates table. --flags ALL Tick copy flags forwarded to copy_ticks_range . --if-exists fail append , replace , or fail when a target table already exists. --with-views off Add cash_events and positions_reconstructed views (requires the history-deals dataset). History orders and deals are fetched per symbol and concatenated, so the symbol filter is applied consistently across all datasets. The cash_events view is derived from symbol-filtered history_deals , so account-level cash events with empty or non-matching symbols may be excluded. The positions_reconstructed view excludes positions with no closing deal, uses volume-weighted open/close prices, and reports reversal deals ( DEAL_ENTRY_INOUT ) via volume_reversal / reversal_count .","title":"Bulk Collection"},{"location":"#global-options","text":"Option Description -o, --output Output file path (required) -f, --format Output format (auto-detected from extension if omitted) --table Table name for SQLite3 output (default: \"data\") --login Trading account login --password Trading account password --server Trading server name --path Path to MetaTrader5 terminal EXE file --timeout Connection timeout in milliseconds --log-level Logging level (DEBUG, INFO, WARNING, ERROR)","title":"Global Options"},{"location":"#requirements","text":"Python 3.11+ Windows OS (MetaTrader 5 requirement) MetaTrader 5 platform","title":"Requirements"},{"location":"#api-reference","text":"Browse the API documentation for detailed module information: CLI Module - CLI application with export commands and utility functions","title":"API Reference"},{"location":"#development","text":"This project follows strict code quality standards: Type hints required (strict mode) Comprehensive linting with Ruff Test coverage tracking Google-style docstrings","title":"Development"},{"location":"#license","text":"MIT License - see LICENSE file for details.","title":"License"},{"location":"api/","text":"API Reference \u00b6 This section contains the complete API documentation for mt5cli. Modules \u00b6 The mt5cli package consists of the following modules: CLI \u00b6 Command-line interface module providing typer-based commands for exporting MetaTrader 5 data to CSV, JSON, Parquet, and SQLite3 formats. Architecture Overview \u00b6 The package follows a simple architecture built on top of pdmt5: CLI Layer ( cli.py ): Typer application with subcommands for each data type, custom Click parameter types for datetime/timeframe/tick flags parsing, and format detection/export utilities. Data Layer (via pdmt5 ): Uses Mt5DataClient and Mt5Config from the pdmt5 package for all MetaTrader 5 data access. Usage Guidelines \u00b6 All modules follow these conventions: Type Safety : All functions include comprehensive type hints Error Handling : User-friendly error messages via typer Documentation : Google-style docstrings with examples Validation : Custom Click parameter types for input validation Quick Start \u00b6 # Export account information to CSV mt5cli -o account.csv account-info # Export EURUSD H1 rates to Parquet mt5cli -o rates.parquet rates-from --symbol EURUSD --timeframe H1 \\ --date-from 2024 -01-01 --count 1000 # Export ticks to JSON mt5cli -o ticks.json ticks-from --symbol EURUSD \\ --date-from 2024 -01-01 --count 500 --flags ALL # Export to SQLite3 with custom table name mt5cli -o data.db --table symbols symbols --group \"*USD*\" Python API \u00b6 from mt5cli import detect_format , export_dataframe import pandas as pd # Detect output format from file extension fmt = detect_format ( Path ( \"output.parquet\" )) # Returns \"parquet\" # Export a DataFrame df = pd . DataFrame ({ \"symbol\" : [ \"EURUSD\" ], \"bid\" : [ 1.1234 ]}) export_dataframe ( df , Path ( \"output.csv\" ), \"csv\" ) Examples \u00b6 See individual module pages for detailed usage examples and code samples.","title":"Overview"},{"location":"api/#api-reference","text":"This section contains the complete API documentation for mt5cli.","title":"API Reference"},{"location":"api/#modules","text":"The mt5cli package consists of the following modules:","title":"Modules"},{"location":"api/#cli","text":"Command-line interface module providing typer-based commands for exporting MetaTrader 5 data to CSV, JSON, Parquet, and SQLite3 formats.","title":"CLI"},{"location":"api/#architecture-overview","text":"The package follows a simple architecture built on top of pdmt5: CLI Layer ( cli.py ): Typer application with subcommands for each data type, custom Click parameter types for datetime/timeframe/tick flags parsing, and format detection/export utilities. Data Layer (via pdmt5 ): Uses Mt5DataClient and Mt5Config from the pdmt5 package for all MetaTrader 5 data access.","title":"Architecture Overview"},{"location":"api/#usage-guidelines","text":"All modules follow these conventions: Type Safety : All functions include comprehensive type hints Error Handling : User-friendly error messages via typer Documentation : Google-style docstrings with examples Validation : Custom Click parameter types for input validation","title":"Usage Guidelines"},{"location":"api/#quick-start","text":"# Export account information to CSV mt5cli -o account.csv account-info # Export EURUSD H1 rates to Parquet mt5cli -o rates.parquet rates-from --symbol EURUSD --timeframe H1 \\ --date-from 2024 -01-01 --count 1000 # Export ticks to JSON mt5cli -o ticks.json ticks-from --symbol EURUSD \\ --date-from 2024 -01-01 --count 500 --flags ALL # Export to SQLite3 with custom table name mt5cli -o data.db --table symbols symbols --group \"*USD*\"","title":"Quick Start"},{"location":"api/#python-api","text":"from mt5cli import detect_format , export_dataframe import pandas as pd # Detect output format from file extension fmt = detect_format ( Path ( \"output.parquet\" )) # Returns \"parquet\" # Export a DataFrame df = pd . DataFrame ({ \"symbol\" : [ \"EURUSD\" ], \"bid\" : [ 1.1234 ]}) export_dataframe ( df , Path ( \"output.csv\" ), \"csv\" )","title":"Python API"},{"location":"api/#examples","text":"See individual module pages for detailed usage examples and code samples.","title":"Examples"},{"location":"api/cli/","text":"CLI Module \u00b6 mt5cli.cli \u00b6 Command-line interface for MetaTrader 5 data export. DATETIME_TYPE module-attribute \u00b6 DATETIME_TYPE = _DateTimeType () REQUEST_TYPE module-attribute \u00b6 REQUEST_TYPE = _RequestType () TICK_FLAGS_TYPE module-attribute \u00b6 TICK_FLAGS_TYPE = _TickFlagsType () TICK_FLAG_MAP module-attribute \u00b6 TICK_FLAG_MAP : dict [ str , int ] = { \"ALL\" : 1 , \"INFO\" : 2 , \"TRADE\" : 4 , } TIMEFRAME_MAP module-attribute \u00b6 TIMEFRAME_MAP : dict [ str , int ] = { \"M1\" : 1 , \"M2\" : 2 , \"M3\" : 3 , \"M4\" : 4 , \"M5\" : 5 , \"M6\" : 6 , \"M10\" : 10 , \"M12\" : 12 , \"M15\" : 15 , \"M20\" : 20 , \"M30\" : 30 , \"H1\" : 16385 , \"H2\" : 16386 , \"H3\" : 16387 , \"H4\" : 16388 , \"H6\" : 16390 , \"H8\" : 16392 , \"H12\" : 16396 , \"D1\" : 16408 , \"W1\" : 32769 , \"MN1\" : 49153 , } TIMEFRAME_TYPE module-attribute \u00b6 TIMEFRAME_TYPE = _TimeframeType () app module-attribute \u00b6 app = Typer ( name = \"mt5cli\" , help = \"Export MetaTrader5 data to CSV, JSON, Parquet, or SQLite3.\" , ) logger module-attribute \u00b6 logger = getLogger ( __name__ ) Dataset \u00b6 Bases: StrEnum Datasets supported by the collect-history command. history_deals class-attribute instance-attribute \u00b6 history_deals = 'history-deals' history_orders class-attribute instance-attribute \u00b6 history_orders = 'history-orders' rates class-attribute instance-attribute \u00b6 rates = 'rates' ticks class-attribute instance-attribute \u00b6 ticks = 'ticks' IfExists \u00b6 Bases: StrEnum SQLite table conflict behavior for the collect-history command. APPEND class-attribute instance-attribute \u00b6 APPEND = 'append' FAIL class-attribute instance-attribute \u00b6 FAIL = 'fail' REPLACE class-attribute instance-attribute \u00b6 REPLACE = 'replace' LogLevel \u00b6 Bases: StrEnum Logging verbosity levels. DEBUG class-attribute instance-attribute \u00b6 DEBUG = 'DEBUG' ERROR class-attribute instance-attribute \u00b6 ERROR = 'ERROR' INFO class-attribute instance-attribute \u00b6 INFO = 'INFO' WARNING class-attribute instance-attribute \u00b6 WARNING = 'WARNING' OutputFormat \u00b6 Bases: StrEnum Supported output file formats. csv class-attribute instance-attribute \u00b6 csv = 'csv' json class-attribute instance-attribute \u00b6 json = 'json' parquet class-attribute instance-attribute \u00b6 parquet = 'parquet' sqlite3 class-attribute instance-attribute \u00b6 sqlite3 = 'sqlite3' account_info \u00b6 account_info ( ctx : Context ) -> None Export account information. Source code in mt5cli/cli.py 723 724 725 726 @app . command () def account_info ( ctx : typer . Context ) -> None : \"\"\"Export account information.\"\"\" _execute_export ( ctx , lambda c : c . account_info_as_df ()) collect_history \u00b6 collect_history ( ctx : Context , symbol : Annotated [ list [ str ], Option ( \"--symbol\" , \"-s\" , help = \"Symbol to collect (repeat for multiple symbols).\" , ), ], date_from : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], date_to : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ], dataset : Annotated [ list [ Dataset ] | None , Option ( \"--dataset\" , help = \"Dataset to include (repeat for multiple). Defaults to all: rates, ticks, history-orders, history-deals.\" , ), ] = None , timeframe : Annotated [ int , Option ( click_type = TIMEFRAME_TYPE , help = \"Rates timeframe (e.g., M1, H1, D1).\" , ), ] = 1 , flags : Annotated [ int , Option ( click_type = TICK_FLAGS_TYPE , help = \"Tick copy flags (ALL, INFO, TRADE, or integer).\" , ), ] = 1 , if_exists : Annotated [ IfExists , Option ( \"--if-exists\" , help = \"Behavior when a target table already exists.\" , ), ] = FAIL , with_views : Annotated [ bool , Option ( \"--with-views\" , help = \"Add cash_events and positions_reconstructed SQLite views derived from history_deals.\" , ), ] = False , ) -> None Collect historical datasets into a single SQLite database. Tables written depend on --dataset : rates , ticks , history_orders , history_deals . History datasets are fetched per symbol and concatenated. Rates rows carry the requested timeframe so appended runs at different timeframes remain distinguishable. With --with-views (requires the history-deals dataset), optional views cash_events and positions_reconstructed are derived from history_deals when the required columns are present. Raises: Type Description BadParameter If the output format is not SQLite3. Source code in mt5cli/cli.py 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 @app . command () def collect_history ( ctx : typer . Context , symbol : Annotated [ list [ str ], typer . Option ( \"--symbol\" , \"-s\" , help = \"Symbol to collect (repeat for multiple symbols).\" , ), ], date_from : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], date_to : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ], dataset : Annotated [ list [ Dataset ] | None , typer . Option ( \"--dataset\" , help = ( \"Dataset to include (repeat for multiple).\" \" Defaults to all: rates, ticks, history-orders, history-deals.\" ), ), ] = None , timeframe : Annotated [ int , typer . Option ( click_type = TIMEFRAME_TYPE , help = \"Rates timeframe (e.g., M1, H1, D1).\" , ), ] = 1 , flags : Annotated [ int , typer . Option ( click_type = TICK_FLAGS_TYPE , help = \"Tick copy flags (ALL, INFO, TRADE, or integer).\" , ), ] = 1 , if_exists : Annotated [ IfExists , typer . Option ( \"--if-exists\" , help = \"Behavior when a target table already exists.\" , ), ] = IfExists . FAIL , with_views : Annotated [ bool , typer . Option ( \"--with-views\" , help = ( \"Add cash_events and positions_reconstructed SQLite views\" \" derived from history_deals.\" ), ), ] = False , ) -> None : \"\"\"Collect historical datasets into a single SQLite database. Tables written depend on ``--dataset``: ``rates``, ``ticks``, ``history_orders``, ``history_deals``. History datasets are fetched per symbol and concatenated. Rates rows carry the requested ``timeframe`` so appended runs at different timeframes remain distinguishable. With ``--with-views`` (requires the ``history-deals`` dataset), optional views ``cash_events`` and ``positions_reconstructed`` are derived from ``history_deals`` when the required columns are present. Raises: typer.BadParameter: If the output format is not SQLite3. \"\"\" export_ctx = _get_export_context ( ctx ) if export_ctx . output_format != \"sqlite3\" : msg = ( \"collect-history requires SQLite3 output.\" \" Use a .db/.sqlite/.sqlite3 extension or --format sqlite3.\" ) raise typer . BadParameter ( msg ) datasets = set ( dataset ) if dataset else set ( Dataset ) client = Mt5DataClient ( config = export_ctx . config ) client . initialize_and_login_mt5 () try : with sqlite3 . connect ( export_ctx . output ) as conn : conn . execute ( \"PRAGMA journal_mode=WAL\" ) conn . execute ( \"PRAGMA synchronous=NORMAL\" ) written_tables , written_columns = _write_collected_datasets ( conn , client , symbol , datasets , timeframe , flags , date_from , date_to , if_exists , ) _create_collect_history_indexes ( conn , written_columns ) if with_views and Dataset . history_deals in written_tables : _create_cash_events_view ( conn , written_columns [ Dataset . history_deals ]) _create_positions_reconstructed_view ( conn , written_columns [ Dataset . history_deals ], ) elif with_views : logger . warning ( \"--with-views ignored: history_deals table was not written\" ) logger . info ( \"Collected %s for %d symbol(s) into %s \" , \", \" . join ( sorted ( ds . value for ds in datasets )), len ( symbol ), export_ctx . output , ) finally : client . shutdown () detect_format \u00b6 detect_format ( output_path : Path , explicit_format : str | None = None ) -> str Detect the output format from a file extension or explicit format string. Parameters: Name Type Description Default output_path Path Path to the output file. required explicit_format str | None Explicitly specified format, if any. None Returns: Type Description str The detected format string. Raises: Type Description ValueError If the format cannot be determined. Source code in mt5cli/cli.py 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 def detect_format ( output_path : Path , explicit_format : str | None = None , ) -> str : \"\"\"Detect the output format from a file extension or explicit format string. Args: output_path: Path to the output file. explicit_format: Explicitly specified format, if any. Returns: The detected format string. Raises: ValueError: If the format cannot be determined. \"\"\" if explicit_format is not None : return explicit_format suffix = output_path . suffix . lower () if suffix in _FORMAT_EXTENSIONS : return _FORMAT_EXTENSIONS [ suffix ] msg = ( f \"Cannot detect format from extension ' { suffix } '.\" \" Use --format to specify the output format.\" ) raise ValueError ( msg ) export_dataframe \u00b6 export_dataframe ( df : DataFrame , output_path : Path , output_format : str , table_name : str = \"data\" , ) -> None Export a pandas DataFrame to the specified file format. Parameters: Name Type Description Default df DataFrame DataFrame to export. required output_path Path Path to the output file. required output_format str Output format (csv, json, parquet, or sqlite3). required table_name str Table name for SQLite3 output. 'data' Raises: Type Description ValueError If the output format is not supported. Source code in mt5cli/cli.py 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 def export_dataframe ( df : pd . DataFrame , output_path : Path , output_format : str , table_name : str = \"data\" , ) -> None : \"\"\"Export a pandas DataFrame to the specified file format. Args: df: DataFrame to export. output_path: Path to the output file. output_format: Output format (csv, json, parquet, or sqlite3). table_name: Table name for SQLite3 output. Raises: ValueError: If the output format is not supported. \"\"\" if output_format == \"csv\" : df . to_csv ( output_path , index = False ) elif output_format == \"json\" : df . to_json ( output_path , orient = \"records\" , date_format = \"iso\" , indent = 2 , ) elif output_format == \"parquet\" : df . to_parquet ( output_path , index = False ) elif output_format == \"sqlite3\" : with sqlite3 . connect ( output_path ) as conn : df . to_sql ( # type: ignore[reportUnknownMemberType] table_name , conn , if_exists = \"replace\" , index = False , ) else : msg = f \"Unsupported output format: { output_format } \" raise ValueError ( msg ) history_deals \u00b6 history_deals ( ctx : Context , date_from : Annotated [ datetime | None , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ] = None , date_to : Annotated [ datetime | None , Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ] = None , group : Annotated [ str | None , Option ( help = \"Group filter.\" ) ] = None , symbol : Annotated [ str | None , Option ( help = \"Symbol filter.\" ) ] = None , ticket : Annotated [ int | None , Option ( help = \"Order ticket.\" ) ] = None , position : Annotated [ int | None , Option ( help = \"Position ticket.\" ) ] = None , ) -> None Export historical deals. Source code in mt5cli/cli.py 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 @app . command () def history_deals ( ctx : typer . Context , date_from : Annotated [ datetime | None , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ] = None , date_to : Annotated [ datetime | None , typer . Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ] = None , group : Annotated [ str | None , typer . Option ( help = \"Group filter.\" )] = None , symbol : Annotated [ str | None , typer . Option ( help = \"Symbol filter.\" )] = None , ticket : Annotated [ int | None , typer . Option ( help = \"Order ticket.\" )] = None , position : Annotated [ int | None , typer . Option ( help = \"Position ticket.\" )] = None , ) -> None : \"\"\"Export historical deals.\"\"\" _execute_export ( ctx , lambda c : c . history_deals_get_as_df ( date_from = date_from , date_to = date_to , group = group , symbol = symbol , ticket = ticket , position = position , ), ) history_orders \u00b6 history_orders ( ctx : Context , date_from : Annotated [ datetime | None , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ] = None , date_to : Annotated [ datetime | None , Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ] = None , group : Annotated [ str | None , Option ( help = \"Group filter.\" ) ] = None , symbol : Annotated [ str | None , Option ( help = \"Symbol filter.\" ) ] = None , ticket : Annotated [ int | None , Option ( help = \"Order ticket.\" ) ] = None , position : Annotated [ int | None , Option ( help = \"Position ticket.\" ) ] = None , ) -> None Export historical orders. Source code in mt5cli/cli.py 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 @app . command () def history_orders ( ctx : typer . Context , date_from : Annotated [ datetime | None , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ] = None , date_to : Annotated [ datetime | None , typer . Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ] = None , group : Annotated [ str | None , typer . Option ( help = \"Group filter.\" )] = None , symbol : Annotated [ str | None , typer . Option ( help = \"Symbol filter.\" )] = None , ticket : Annotated [ int | None , typer . Option ( help = \"Order ticket.\" )] = None , position : Annotated [ int | None , typer . Option ( help = \"Position ticket.\" )] = None , ) -> None : \"\"\"Export historical orders.\"\"\" _execute_export ( ctx , lambda c : c . history_orders_get_as_df ( date_from = date_from , date_to = date_to , group = group , symbol = symbol , ticket = ticket , position = position , ), ) last_error \u00b6 last_error ( ctx : Context ) -> None Export the last error information. Source code in mt5cli/cli.py 864 865 866 867 @app . command () def last_error ( ctx : typer . Context ) -> None : \"\"\"Export the last error information.\"\"\" _execute_export ( ctx , lambda c : c . last_error_as_df ()) main \u00b6 main () -> None Run the mt5cli CLI. Source code in mt5cli/cli.py 1450 1451 1452 def main () -> None : \"\"\"Run the mt5cli CLI.\"\"\" app () market_book \u00b6 market_book ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], ) -> None Export market depth (order book) for a symbol. Source code in mt5cli/cli.py 882 883 884 885 886 887 888 889 890 891 @app . command () def market_book ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], ) -> None : \"\"\"Export market depth (order book) for a symbol.\"\"\" _execute_export ( ctx , lambda c : c . market_book_get_as_df ( symbol = symbol ), ) order_check \u00b6 order_check ( ctx : Context , request : Annotated [ dict [ str , Any ], Option ( click_type = REQUEST_TYPE , help = _REQUEST_OPTION_HELP , ), ], ) -> None Check funds sufficiency for a trading operation. Source code in mt5cli/cli.py 894 895 896 897 898 899 900 901 902 903 904 905 906 @app . command () def order_check ( ctx : typer . Context , request : Annotated [ dict [ str , Any ], typer . Option ( click_type = REQUEST_TYPE , help = _REQUEST_OPTION_HELP ), ], ) -> None : \"\"\"Check funds sufficiency for a trading operation.\"\"\" _execute_export ( ctx , lambda c : c . order_check_as_df ( request = request ), ) order_send \u00b6 order_send ( ctx : Context , request : Annotated [ dict [ str , Any ], Option ( click_type = REQUEST_TYPE , help = _REQUEST_OPTION_HELP , ), ], yes : Annotated [ bool , Option ( \"--yes\" , help = \"Confirm the live trade request.\" ), ] = False , ) -> None Send a trading operation request to the trade server. Raises: Type Description BadParameter If --yes is not provided. Source code in mt5cli/cli.py 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 @app . command () def order_send ( ctx : typer . Context , request : Annotated [ dict [ str , Any ], typer . Option ( click_type = REQUEST_TYPE , help = _REQUEST_OPTION_HELP ), ], yes : Annotated [ bool , typer . Option ( \"--yes\" , help = \"Confirm the live trade request.\" ), ] = False , ) -> None : \"\"\"Send a trading operation request to the trade server. Raises: typer.BadParameter: If --yes is not provided. \"\"\" if not yes : msg = \"Pass --yes to send a live trade request.\" raise typer . BadParameter ( msg , param_hint = \"--yes\" ) _execute_export ( ctx , lambda c : c . order_send_as_df ( request = request ), ) orders \u00b6 orders ( ctx : Context , symbol : Annotated [ str | None , Option ( help = \"Symbol filter.\" ) ] = None , group : Annotated [ str | None , Option ( help = \"Group filter.\" ) ] = None , ticket : Annotated [ int | None , Option ( help = \"Ticket filter.\" ) ] = None , ) -> None Export active orders. Source code in mt5cli/cli.py 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 @app . command () def orders ( ctx : typer . Context , symbol : Annotated [ str | None , typer . Option ( help = \"Symbol filter.\" )] = None , group : Annotated [ str | None , typer . Option ( help = \"Group filter.\" )] = None , ticket : Annotated [ int | None , typer . Option ( help = \"Ticket filter.\" )] = None , ) -> None : \"\"\"Export active orders.\"\"\" _execute_export ( ctx , lambda c : c . orders_get_as_df ( symbol = symbol , group = group , ticket = ticket , ), ) parse_datetime \u00b6 parse_datetime ( value : str ) -> datetime Parse an ISO 8601 datetime string to a timezone-aware datetime. Parameters: Name Type Description Default value str ISO 8601 datetime string (e.g., '2024-01-01' or '2024-01-01T12:00:00+00:00'). required Returns: Type Description datetime Parsed datetime with UTC timezone if no timezone is specified. Raises: Type Description ValueError If the string cannot be parsed. Source code in mt5cli/cli.py 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 def parse_datetime ( value : str ) -> datetime : \"\"\"Parse an ISO 8601 datetime string to a timezone-aware datetime. Args: value: ISO 8601 datetime string (e.g., '2024-01-01' or '2024-01-01T12:00:00+00:00'). Returns: Parsed datetime with UTC timezone if no timezone is specified. Raises: ValueError: If the string cannot be parsed. \"\"\" try : dt = datetime . fromisoformat ( value ) except ValueError : msg = f \"Invalid datetime format: ' { value } '. Use ISO 8601 format.\" raise ValueError ( msg ) from None if dt . tzinfo is None : dt = dt . replace ( tzinfo = UTC ) return dt parse_request \u00b6 parse_request ( value : str ) -> dict [ str , Any ] Parse a JSON-formatted order request string or file reference. Parameters: Name Type Description Default value str JSON object string, or '@path' to read JSON from a file. required Returns: Type Description dict [ str , Any ] Parsed request dictionary. Raises: Type Description ValueError If the request file cannot be read or the value is not a JSON object. Source code in mt5cli/cli.py 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 def parse_request ( value : str ) -> dict [ str , Any ]: \"\"\"Parse a JSON-formatted order request string or file reference. Args: value: JSON object string, or '@path' to read JSON from a file. Returns: Parsed request dictionary. Raises: ValueError: If the request file cannot be read or the value is not a JSON object. \"\"\" if value . startswith ( \"@\" ): path = Path ( value [ 1 :]) try : text = path . read_text ( encoding = \"utf-8\" ) except ( OSError , UnicodeDecodeError ) as exc : msg = f \"Failed to read JSON request file ' { path } ': { exc } \" raise ValueError ( msg ) from exc else : text = value try : parsed : object = json . loads ( text ) except json . JSONDecodeError as exc : msg = f \"Invalid JSON request: { exc } \" raise ValueError ( msg ) from exc if not _is_request_dict ( parsed ): msg = \"Order request must be a JSON object.\" raise ValueError ( msg ) return parsed parse_tick_flags \u00b6 parse_tick_flags ( value : str ) -> int Parse tick flags string or integer value. Parameters: Name Type Description Default value str Tick flag name (ALL, INFO, TRADE) or integer value. required Returns: Type Description int Integer tick flag value. Raises: Type Description ValueError If the flag is invalid. Source code in mt5cli/cli.py 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 def parse_tick_flags ( value : str ) -> int : \"\"\"Parse tick flags string or integer value. Args: value: Tick flag name (ALL, INFO, TRADE) or integer value. Returns: Integer tick flag value. Raises: ValueError: If the flag is invalid. \"\"\" upper = value . upper () if upper in TICK_FLAG_MAP : return TICK_FLAG_MAP [ upper ] try : return int ( value ) except ValueError : valid = \", \" . join ( TICK_FLAG_MAP ) msg = f \"Invalid tick flags: ' { value } '. Use one of: { valid } , or an integer.\" raise ValueError ( msg ) from None parse_timeframe \u00b6 parse_timeframe ( value : str ) -> int Parse a timeframe string or integer value. Parameters: Name Type Description Default value str Timeframe name (e.g., 'M1', 'H1', 'D1') or integer value. required Returns: Type Description int Integer timeframe value. Raises: Type Description ValueError If the timeframe is invalid. Source code in mt5cli/cli.py 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 def parse_timeframe ( value : str ) -> int : \"\"\"Parse a timeframe string or integer value. Args: value: Timeframe name (e.g., 'M1', 'H1', 'D1') or integer value. Returns: Integer timeframe value. Raises: ValueError: If the timeframe is invalid. \"\"\" upper = value . upper () if upper in TIMEFRAME_MAP : return TIMEFRAME_MAP [ upper ] try : return int ( value ) except ValueError : valid = \", \" . join ( TIMEFRAME_MAP ) msg = f \"Invalid timeframe: ' { value } '. Use one of: { valid } , or an integer.\" raise ValueError ( msg ) from None positions \u00b6 positions ( ctx : Context , symbol : Annotated [ str | None , Option ( help = \"Symbol filter.\" ) ] = None , group : Annotated [ str | None , Option ( help = \"Group filter.\" ) ] = None , ticket : Annotated [ int | None , Option ( help = \"Ticket filter.\" ) ] = None , ) -> None Export open positions. Source code in mt5cli/cli.py 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 @app . command () def positions ( ctx : typer . Context , symbol : Annotated [ str | None , typer . Option ( help = \"Symbol filter.\" )] = None , group : Annotated [ str | None , typer . Option ( help = \"Group filter.\" )] = None , ticket : Annotated [ int | None , typer . Option ( help = \"Ticket filter.\" )] = None , ) -> None : \"\"\"Export open positions.\"\"\" _execute_export ( ctx , lambda c : c . positions_get_as_df ( symbol = symbol , group = group , ticket = ticket , ), ) rates_from \u00b6 rates_from ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe (e.g., M1, H1, D1, or integer).\" , ), ], date_from : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"Start date in ISO 8601 format.\" , ), ], count : Annotated [ int , Option ( help = \"Number of records.\" ) ], ) -> None Export rates from a start date. Source code in mt5cli/cli.py 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 @app . command () def rates_from ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , typer . Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe (e.g., M1, H1, D1, or integer).\" , ), ], date_from : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date in ISO 8601 format.\" , ), ], count : Annotated [ int , typer . Option ( help = \"Number of records.\" )], ) -> None : \"\"\"Export rates from a start date.\"\"\" _execute_export ( ctx , lambda c : c . copy_rates_from_as_df ( symbol = symbol , timeframe = timeframe , date_from = date_from , count = count , ), ) rates_from_pos \u00b6 rates_from_pos ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe.\" ), ], start_pos : Annotated [ int , Option ( help = \"Start position (0 = current bar).\" ), ], count : Annotated [ int , Option ( help = \"Number of records.\" ) ], ) -> None Export rates from a start position. Source code in mt5cli/cli.py 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 @app . command () def rates_from_pos ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , typer . Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe.\" , ), ], start_pos : Annotated [ int , typer . Option ( help = \"Start position (0 = current bar).\" )], count : Annotated [ int , typer . Option ( help = \"Number of records.\" )], ) -> None : \"\"\"Export rates from a start position.\"\"\" _execute_export ( ctx , lambda c : c . copy_rates_from_pos_as_df ( symbol = symbol , timeframe = timeframe , start_pos = start_pos , count = count , ), ) rates_range \u00b6 rates_range ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe.\" ), ], date_from : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], date_to : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ], ) -> None Export rates for a date range. Source code in mt5cli/cli.py 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 @app . command () def rates_range ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , typer . Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe.\" , ), ], date_from : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], date_to : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ], ) -> None : \"\"\"Export rates for a date range.\"\"\" _execute_export ( ctx , lambda c : c . copy_rates_range_as_df ( symbol = symbol , timeframe = timeframe , date_from = date_from , date_to = date_to , ), ) symbol_info \u00b6 symbol_info ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], ) -> None Export symbol details. Source code in mt5cli/cli.py 750 751 752 753 754 755 756 757 758 759 @app . command () def symbol_info ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], ) -> None : \"\"\"Export symbol details.\"\"\" _execute_export ( ctx , lambda c : c . symbol_info_as_df ( symbol = symbol ), ) symbol_info_tick \u00b6 symbol_info_tick ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], ) -> None Export the last tick for a symbol. Source code in mt5cli/cli.py 870 871 872 873 874 875 876 877 878 879 @app . command () def symbol_info_tick ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], ) -> None : \"\"\"Export the last tick for a symbol.\"\"\" _execute_export ( ctx , lambda c : c . symbol_info_tick_as_df ( symbol = symbol ), ) symbols \u00b6 symbols ( ctx : Context , group : Annotated [ str | None , Option ( help = \"Symbol group filter (e.g., *USD*).\" ), ] = None , ) -> None Export symbol list. Source code in mt5cli/cli.py 735 736 737 738 739 740 741 742 743 744 745 746 747 @app . command () def symbols ( ctx : typer . Context , group : Annotated [ str | None , typer . Option ( help = \"Symbol group filter (e.g., *USD*).\" ), ] = None , ) -> None : \"\"\"Export symbol list.\"\"\" _execute_export ( ctx , lambda c : c . symbols_get_as_df ( group = group ), ) terminal_info \u00b6 terminal_info ( ctx : Context ) -> None Export terminal information. Source code in mt5cli/cli.py 729 730 731 732 @app . command () def terminal_info ( ctx : typer . Context ) -> None : \"\"\"Export terminal information.\"\"\" _execute_export ( ctx , lambda c : c . terminal_info_as_df ()) ticks_from \u00b6 ticks_from ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], date_from : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], count : Annotated [ int , Option ( help = \"Number of ticks.\" )], flags : Annotated [ int , Option ( click_type = TICK_FLAGS_TYPE , help = \"Tick flags (ALL, INFO, TRADE, or integer).\" , ), ], ) -> None Export ticks from a start date. Source code in mt5cli/cli.py 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 @app . command () def ticks_from ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], date_from : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], count : Annotated [ int , typer . Option ( help = \"Number of ticks.\" )], flags : Annotated [ int , typer . Option ( click_type = TICK_FLAGS_TYPE , help = \"Tick flags (ALL, INFO, TRADE, or integer).\" , ), ], ) -> None : \"\"\"Export ticks from a start date.\"\"\" _execute_export ( ctx , lambda c : c . copy_ticks_from_as_df ( symbol = symbol , date_from = date_from , count = count , flags = flags , ), ) ticks_range \u00b6 ticks_range ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], date_from : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], date_to : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ], flags : Annotated [ int , Option ( click_type = TICK_FLAGS_TYPE , help = \"Tick flags.\" ), ], ) -> None Export ticks for a date range. Source code in mt5cli/cli.py 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 @app . command () def ticks_range ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], date_from : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], date_to : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ], flags : Annotated [ int , typer . Option ( click_type = TICK_FLAGS_TYPE , help = \"Tick flags.\" ), ], ) -> None : \"\"\"Export ticks for a date range.\"\"\" _execute_export ( ctx , lambda c : c . copy_ticks_range_as_df ( symbol = symbol , date_from = date_from , date_to = date_to , flags = flags , ), ) version \u00b6 version ( ctx : Context ) -> None Export MetaTrader5 version information. Source code in mt5cli/cli.py 858 859 860 861 @app . command () def version ( ctx : typer . Context ) -> None : \"\"\"Export MetaTrader5 version information.\"\"\" _execute_export ( ctx , lambda c : c . version_as_df ())","title":"CLI"},{"location":"api/cli/#cli-module","text":"","title":"CLI Module"},{"location":"api/cli/#mt5cli.cli","text":"Command-line interface for MetaTrader 5 data export.","title":"cli"},{"location":"api/cli/#mt5cli.cli.DATETIME_TYPE","text":"DATETIME_TYPE = _DateTimeType ()","title":"DATETIME_TYPE"},{"location":"api/cli/#mt5cli.cli.REQUEST_TYPE","text":"REQUEST_TYPE = _RequestType ()","title":"REQUEST_TYPE"},{"location":"api/cli/#mt5cli.cli.TICK_FLAGS_TYPE","text":"TICK_FLAGS_TYPE = _TickFlagsType ()","title":"TICK_FLAGS_TYPE"},{"location":"api/cli/#mt5cli.cli.TICK_FLAG_MAP","text":"TICK_FLAG_MAP : dict [ str , int ] = { \"ALL\" : 1 , \"INFO\" : 2 , \"TRADE\" : 4 , }","title":"TICK_FLAG_MAP"},{"location":"api/cli/#mt5cli.cli.TIMEFRAME_MAP","text":"TIMEFRAME_MAP : dict [ str , int ] = { \"M1\" : 1 , \"M2\" : 2 , \"M3\" : 3 , \"M4\" : 4 , \"M5\" : 5 , \"M6\" : 6 , \"M10\" : 10 , \"M12\" : 12 , \"M15\" : 15 , \"M20\" : 20 , \"M30\" : 30 , \"H1\" : 16385 , \"H2\" : 16386 , \"H3\" : 16387 , \"H4\" : 16388 , \"H6\" : 16390 , \"H8\" : 16392 , \"H12\" : 16396 , \"D1\" : 16408 , \"W1\" : 32769 , \"MN1\" : 49153 , }","title":"TIMEFRAME_MAP"},{"location":"api/cli/#mt5cli.cli.TIMEFRAME_TYPE","text":"TIMEFRAME_TYPE = _TimeframeType ()","title":"TIMEFRAME_TYPE"},{"location":"api/cli/#mt5cli.cli.app","text":"app = Typer ( name = \"mt5cli\" , help = \"Export MetaTrader5 data to CSV, JSON, Parquet, or SQLite3.\" , )","title":"app"},{"location":"api/cli/#mt5cli.cli.logger","text":"logger = getLogger ( __name__ )","title":"logger"},{"location":"api/cli/#mt5cli.cli.Dataset","text":"Bases: StrEnum Datasets supported by the collect-history command.","title":"Dataset"},{"location":"api/cli/#mt5cli.cli.Dataset.history_deals","text":"history_deals = 'history-deals'","title":"history_deals"},{"location":"api/cli/#mt5cli.cli.Dataset.history_orders","text":"history_orders = 'history-orders'","title":"history_orders"},{"location":"api/cli/#mt5cli.cli.Dataset.rates","text":"rates = 'rates'","title":"rates"},{"location":"api/cli/#mt5cli.cli.Dataset.ticks","text":"ticks = 'ticks'","title":"ticks"},{"location":"api/cli/#mt5cli.cli.IfExists","text":"Bases: StrEnum SQLite table conflict behavior for the collect-history command.","title":"IfExists"},{"location":"api/cli/#mt5cli.cli.IfExists.APPEND","text":"APPEND = 'append'","title":"APPEND"},{"location":"api/cli/#mt5cli.cli.IfExists.FAIL","text":"FAIL = 'fail'","title":"FAIL"},{"location":"api/cli/#mt5cli.cli.IfExists.REPLACE","text":"REPLACE = 'replace'","title":"REPLACE"},{"location":"api/cli/#mt5cli.cli.LogLevel","text":"Bases: StrEnum Logging verbosity levels.","title":"LogLevel"},{"location":"api/cli/#mt5cli.cli.LogLevel.DEBUG","text":"DEBUG = 'DEBUG'","title":"DEBUG"},{"location":"api/cli/#mt5cli.cli.LogLevel.ERROR","text":"ERROR = 'ERROR'","title":"ERROR"},{"location":"api/cli/#mt5cli.cli.LogLevel.INFO","text":"INFO = 'INFO'","title":"INFO"},{"location":"api/cli/#mt5cli.cli.LogLevel.WARNING","text":"WARNING = 'WARNING'","title":"WARNING"},{"location":"api/cli/#mt5cli.cli.OutputFormat","text":"Bases: StrEnum Supported output file formats.","title":"OutputFormat"},{"location":"api/cli/#mt5cli.cli.OutputFormat.csv","text":"csv = 'csv'","title":"csv"},{"location":"api/cli/#mt5cli.cli.OutputFormat.json","text":"json = 'json'","title":"json"},{"location":"api/cli/#mt5cli.cli.OutputFormat.parquet","text":"parquet = 'parquet'","title":"parquet"},{"location":"api/cli/#mt5cli.cli.OutputFormat.sqlite3","text":"sqlite3 = 'sqlite3'","title":"sqlite3"},{"location":"api/cli/#mt5cli.cli.account_info","text":"account_info ( ctx : Context ) -> None Export account information. Source code in mt5cli/cli.py 723 724 725 726 @app . command () def account_info ( ctx : typer . Context ) -> None : \"\"\"Export account information.\"\"\" _execute_export ( ctx , lambda c : c . account_info_as_df ())","title":"account_info"},{"location":"api/cli/#mt5cli.cli.collect_history","text":"collect_history ( ctx : Context , symbol : Annotated [ list [ str ], Option ( \"--symbol\" , \"-s\" , help = \"Symbol to collect (repeat for multiple symbols).\" , ), ], date_from : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], date_to : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ], dataset : Annotated [ list [ Dataset ] | None , Option ( \"--dataset\" , help = \"Dataset to include (repeat for multiple). Defaults to all: rates, ticks, history-orders, history-deals.\" , ), ] = None , timeframe : Annotated [ int , Option ( click_type = TIMEFRAME_TYPE , help = \"Rates timeframe (e.g., M1, H1, D1).\" , ), ] = 1 , flags : Annotated [ int , Option ( click_type = TICK_FLAGS_TYPE , help = \"Tick copy flags (ALL, INFO, TRADE, or integer).\" , ), ] = 1 , if_exists : Annotated [ IfExists , Option ( \"--if-exists\" , help = \"Behavior when a target table already exists.\" , ), ] = FAIL , with_views : Annotated [ bool , Option ( \"--with-views\" , help = \"Add cash_events and positions_reconstructed SQLite views derived from history_deals.\" , ), ] = False , ) -> None Collect historical datasets into a single SQLite database. Tables written depend on --dataset : rates , ticks , history_orders , history_deals . History datasets are fetched per symbol and concatenated. Rates rows carry the requested timeframe so appended runs at different timeframes remain distinguishable. With --with-views (requires the history-deals dataset), optional views cash_events and positions_reconstructed are derived from history_deals when the required columns are present. Raises: Type Description BadParameter If the output format is not SQLite3. Source code in mt5cli/cli.py 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 @app . command () def collect_history ( ctx : typer . Context , symbol : Annotated [ list [ str ], typer . Option ( \"--symbol\" , \"-s\" , help = \"Symbol to collect (repeat for multiple symbols).\" , ), ], date_from : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], date_to : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ], dataset : Annotated [ list [ Dataset ] | None , typer . Option ( \"--dataset\" , help = ( \"Dataset to include (repeat for multiple).\" \" Defaults to all: rates, ticks, history-orders, history-deals.\" ), ), ] = None , timeframe : Annotated [ int , typer . Option ( click_type = TIMEFRAME_TYPE , help = \"Rates timeframe (e.g., M1, H1, D1).\" , ), ] = 1 , flags : Annotated [ int , typer . Option ( click_type = TICK_FLAGS_TYPE , help = \"Tick copy flags (ALL, INFO, TRADE, or integer).\" , ), ] = 1 , if_exists : Annotated [ IfExists , typer . Option ( \"--if-exists\" , help = \"Behavior when a target table already exists.\" , ), ] = IfExists . FAIL , with_views : Annotated [ bool , typer . Option ( \"--with-views\" , help = ( \"Add cash_events and positions_reconstructed SQLite views\" \" derived from history_deals.\" ), ), ] = False , ) -> None : \"\"\"Collect historical datasets into a single SQLite database. Tables written depend on ``--dataset``: ``rates``, ``ticks``, ``history_orders``, ``history_deals``. History datasets are fetched per symbol and concatenated. Rates rows carry the requested ``timeframe`` so appended runs at different timeframes remain distinguishable. With ``--with-views`` (requires the ``history-deals`` dataset), optional views ``cash_events`` and ``positions_reconstructed`` are derived from ``history_deals`` when the required columns are present. Raises: typer.BadParameter: If the output format is not SQLite3. \"\"\" export_ctx = _get_export_context ( ctx ) if export_ctx . output_format != \"sqlite3\" : msg = ( \"collect-history requires SQLite3 output.\" \" Use a .db/.sqlite/.sqlite3 extension or --format sqlite3.\" ) raise typer . BadParameter ( msg ) datasets = set ( dataset ) if dataset else set ( Dataset ) client = Mt5DataClient ( config = export_ctx . config ) client . initialize_and_login_mt5 () try : with sqlite3 . connect ( export_ctx . output ) as conn : conn . execute ( \"PRAGMA journal_mode=WAL\" ) conn . execute ( \"PRAGMA synchronous=NORMAL\" ) written_tables , written_columns = _write_collected_datasets ( conn , client , symbol , datasets , timeframe , flags , date_from , date_to , if_exists , ) _create_collect_history_indexes ( conn , written_columns ) if with_views and Dataset . history_deals in written_tables : _create_cash_events_view ( conn , written_columns [ Dataset . history_deals ]) _create_positions_reconstructed_view ( conn , written_columns [ Dataset . history_deals ], ) elif with_views : logger . warning ( \"--with-views ignored: history_deals table was not written\" ) logger . info ( \"Collected %s for %d symbol(s) into %s \" , \", \" . join ( sorted ( ds . value for ds in datasets )), len ( symbol ), export_ctx . output , ) finally : client . shutdown ()","title":"collect_history"},{"location":"api/cli/#mt5cli.cli.detect_format","text":"detect_format ( output_path : Path , explicit_format : str | None = None ) -> str Detect the output format from a file extension or explicit format string. Parameters: Name Type Description Default output_path Path Path to the output file. required explicit_format str | None Explicitly specified format, if any. None Returns: Type Description str The detected format string. Raises: Type Description ValueError If the format cannot be determined. Source code in mt5cli/cli.py 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 def detect_format ( output_path : Path , explicit_format : str | None = None , ) -> str : \"\"\"Detect the output format from a file extension or explicit format string. Args: output_path: Path to the output file. explicit_format: Explicitly specified format, if any. Returns: The detected format string. Raises: ValueError: If the format cannot be determined. \"\"\" if explicit_format is not None : return explicit_format suffix = output_path . suffix . lower () if suffix in _FORMAT_EXTENSIONS : return _FORMAT_EXTENSIONS [ suffix ] msg = ( f \"Cannot detect format from extension ' { suffix } '.\" \" Use --format to specify the output format.\" ) raise ValueError ( msg )","title":"detect_format"},{"location":"api/cli/#mt5cli.cli.export_dataframe","text":"export_dataframe ( df : DataFrame , output_path : Path , output_format : str , table_name : str = \"data\" , ) -> None Export a pandas DataFrame to the specified file format. Parameters: Name Type Description Default df DataFrame DataFrame to export. required output_path Path Path to the output file. required output_format str Output format (csv, json, parquet, or sqlite3). required table_name str Table name for SQLite3 output. 'data' Raises: Type Description ValueError If the output format is not supported. Source code in mt5cli/cli.py 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 def export_dataframe ( df : pd . DataFrame , output_path : Path , output_format : str , table_name : str = \"data\" , ) -> None : \"\"\"Export a pandas DataFrame to the specified file format. Args: df: DataFrame to export. output_path: Path to the output file. output_format: Output format (csv, json, parquet, or sqlite3). table_name: Table name for SQLite3 output. Raises: ValueError: If the output format is not supported. \"\"\" if output_format == \"csv\" : df . to_csv ( output_path , index = False ) elif output_format == \"json\" : df . to_json ( output_path , orient = \"records\" , date_format = \"iso\" , indent = 2 , ) elif output_format == \"parquet\" : df . to_parquet ( output_path , index = False ) elif output_format == \"sqlite3\" : with sqlite3 . connect ( output_path ) as conn : df . to_sql ( # type: ignore[reportUnknownMemberType] table_name , conn , if_exists = \"replace\" , index = False , ) else : msg = f \"Unsupported output format: { output_format } \" raise ValueError ( msg )","title":"export_dataframe"},{"location":"api/cli/#mt5cli.cli.history_deals","text":"history_deals ( ctx : Context , date_from : Annotated [ datetime | None , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ] = None , date_to : Annotated [ datetime | None , Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ] = None , group : Annotated [ str | None , Option ( help = \"Group filter.\" ) ] = None , symbol : Annotated [ str | None , Option ( help = \"Symbol filter.\" ) ] = None , ticket : Annotated [ int | None , Option ( help = \"Order ticket.\" ) ] = None , position : Annotated [ int | None , Option ( help = \"Position ticket.\" ) ] = None , ) -> None Export historical deals. Source code in mt5cli/cli.py 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 @app . command () def history_deals ( ctx : typer . Context , date_from : Annotated [ datetime | None , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ] = None , date_to : Annotated [ datetime | None , typer . Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ] = None , group : Annotated [ str | None , typer . Option ( help = \"Group filter.\" )] = None , symbol : Annotated [ str | None , typer . Option ( help = \"Symbol filter.\" )] = None , ticket : Annotated [ int | None , typer . Option ( help = \"Order ticket.\" )] = None , position : Annotated [ int | None , typer . Option ( help = \"Position ticket.\" )] = None , ) -> None : \"\"\"Export historical deals.\"\"\" _execute_export ( ctx , lambda c : c . history_deals_get_as_df ( date_from = date_from , date_to = date_to , group = group , symbol = symbol , ticket = ticket , position = position , ), )","title":"history_deals"},{"location":"api/cli/#mt5cli.cli.history_orders","text":"history_orders ( ctx : Context , date_from : Annotated [ datetime | None , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ] = None , date_to : Annotated [ datetime | None , Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ] = None , group : Annotated [ str | None , Option ( help = \"Group filter.\" ) ] = None , symbol : Annotated [ str | None , Option ( help = \"Symbol filter.\" ) ] = None , ticket : Annotated [ int | None , Option ( help = \"Order ticket.\" ) ] = None , position : Annotated [ int | None , Option ( help = \"Position ticket.\" ) ] = None , ) -> None Export historical orders. Source code in mt5cli/cli.py 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 @app . command () def history_orders ( ctx : typer . Context , date_from : Annotated [ datetime | None , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ] = None , date_to : Annotated [ datetime | None , typer . Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ] = None , group : Annotated [ str | None , typer . Option ( help = \"Group filter.\" )] = None , symbol : Annotated [ str | None , typer . Option ( help = \"Symbol filter.\" )] = None , ticket : Annotated [ int | None , typer . Option ( help = \"Order ticket.\" )] = None , position : Annotated [ int | None , typer . Option ( help = \"Position ticket.\" )] = None , ) -> None : \"\"\"Export historical orders.\"\"\" _execute_export ( ctx , lambda c : c . history_orders_get_as_df ( date_from = date_from , date_to = date_to , group = group , symbol = symbol , ticket = ticket , position = position , ), )","title":"history_orders"},{"location":"api/cli/#mt5cli.cli.last_error","text":"last_error ( ctx : Context ) -> None Export the last error information. Source code in mt5cli/cli.py 864 865 866 867 @app . command () def last_error ( ctx : typer . Context ) -> None : \"\"\"Export the last error information.\"\"\" _execute_export ( ctx , lambda c : c . last_error_as_df ())","title":"last_error"},{"location":"api/cli/#mt5cli.cli.main","text":"main () -> None Run the mt5cli CLI. Source code in mt5cli/cli.py 1450 1451 1452 def main () -> None : \"\"\"Run the mt5cli CLI.\"\"\" app ()","title":"main"},{"location":"api/cli/#mt5cli.cli.market_book","text":"market_book ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], ) -> None Export market depth (order book) for a symbol. Source code in mt5cli/cli.py 882 883 884 885 886 887 888 889 890 891 @app . command () def market_book ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], ) -> None : \"\"\"Export market depth (order book) for a symbol.\"\"\" _execute_export ( ctx , lambda c : c . market_book_get_as_df ( symbol = symbol ), )","title":"market_book"},{"location":"api/cli/#mt5cli.cli.order_check","text":"order_check ( ctx : Context , request : Annotated [ dict [ str , Any ], Option ( click_type = REQUEST_TYPE , help = _REQUEST_OPTION_HELP , ), ], ) -> None Check funds sufficiency for a trading operation. Source code in mt5cli/cli.py 894 895 896 897 898 899 900 901 902 903 904 905 906 @app . command () def order_check ( ctx : typer . Context , request : Annotated [ dict [ str , Any ], typer . Option ( click_type = REQUEST_TYPE , help = _REQUEST_OPTION_HELP ), ], ) -> None : \"\"\"Check funds sufficiency for a trading operation.\"\"\" _execute_export ( ctx , lambda c : c . order_check_as_df ( request = request ), )","title":"order_check"},{"location":"api/cli/#mt5cli.cli.order_send","text":"order_send ( ctx : Context , request : Annotated [ dict [ str , Any ], Option ( click_type = REQUEST_TYPE , help = _REQUEST_OPTION_HELP , ), ], yes : Annotated [ bool , Option ( \"--yes\" , help = \"Confirm the live trade request.\" ), ] = False , ) -> None Send a trading operation request to the trade server. Raises: Type Description BadParameter If --yes is not provided. Source code in mt5cli/cli.py 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 @app . command () def order_send ( ctx : typer . Context , request : Annotated [ dict [ str , Any ], typer . Option ( click_type = REQUEST_TYPE , help = _REQUEST_OPTION_HELP ), ], yes : Annotated [ bool , typer . Option ( \"--yes\" , help = \"Confirm the live trade request.\" ), ] = False , ) -> None : \"\"\"Send a trading operation request to the trade server. Raises: typer.BadParameter: If --yes is not provided. \"\"\" if not yes : msg = \"Pass --yes to send a live trade request.\" raise typer . BadParameter ( msg , param_hint = \"--yes\" ) _execute_export ( ctx , lambda c : c . order_send_as_df ( request = request ), )","title":"order_send"},{"location":"api/cli/#mt5cli.cli.orders","text":"orders ( ctx : Context , symbol : Annotated [ str | None , Option ( help = \"Symbol filter.\" ) ] = None , group : Annotated [ str | None , Option ( help = \"Group filter.\" ) ] = None , ticket : Annotated [ int | None , Option ( help = \"Ticket filter.\" ) ] = None , ) -> None Export active orders. Source code in mt5cli/cli.py 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 @app . command () def orders ( ctx : typer . Context , symbol : Annotated [ str | None , typer . Option ( help = \"Symbol filter.\" )] = None , group : Annotated [ str | None , typer . Option ( help = \"Group filter.\" )] = None , ticket : Annotated [ int | None , typer . Option ( help = \"Ticket filter.\" )] = None , ) -> None : \"\"\"Export active orders.\"\"\" _execute_export ( ctx , lambda c : c . orders_get_as_df ( symbol = symbol , group = group , ticket = ticket , ), )","title":"orders"},{"location":"api/cli/#mt5cli.cli.parse_datetime","text":"parse_datetime ( value : str ) -> datetime Parse an ISO 8601 datetime string to a timezone-aware datetime. Parameters: Name Type Description Default value str ISO 8601 datetime string (e.g., '2024-01-01' or '2024-01-01T12:00:00+00:00'). required Returns: Type Description datetime Parsed datetime with UTC timezone if no timezone is specified. Raises: Type Description ValueError If the string cannot be parsed. Source code in mt5cli/cli.py 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 def parse_datetime ( value : str ) -> datetime : \"\"\"Parse an ISO 8601 datetime string to a timezone-aware datetime. Args: value: ISO 8601 datetime string (e.g., '2024-01-01' or '2024-01-01T12:00:00+00:00'). Returns: Parsed datetime with UTC timezone if no timezone is specified. Raises: ValueError: If the string cannot be parsed. \"\"\" try : dt = datetime . fromisoformat ( value ) except ValueError : msg = f \"Invalid datetime format: ' { value } '. Use ISO 8601 format.\" raise ValueError ( msg ) from None if dt . tzinfo is None : dt = dt . replace ( tzinfo = UTC ) return dt","title":"parse_datetime"},{"location":"api/cli/#mt5cli.cli.parse_request","text":"parse_request ( value : str ) -> dict [ str , Any ] Parse a JSON-formatted order request string or file reference. Parameters: Name Type Description Default value str JSON object string, or '@path' to read JSON from a file. required Returns: Type Description dict [ str , Any ] Parsed request dictionary. Raises: Type Description ValueError If the request file cannot be read or the value is not a JSON object. Source code in mt5cli/cli.py 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 def parse_request ( value : str ) -> dict [ str , Any ]: \"\"\"Parse a JSON-formatted order request string or file reference. Args: value: JSON object string, or '@path' to read JSON from a file. Returns: Parsed request dictionary. Raises: ValueError: If the request file cannot be read or the value is not a JSON object. \"\"\" if value . startswith ( \"@\" ): path = Path ( value [ 1 :]) try : text = path . read_text ( encoding = \"utf-8\" ) except ( OSError , UnicodeDecodeError ) as exc : msg = f \"Failed to read JSON request file ' { path } ': { exc } \" raise ValueError ( msg ) from exc else : text = value try : parsed : object = json . loads ( text ) except json . JSONDecodeError as exc : msg = f \"Invalid JSON request: { exc } \" raise ValueError ( msg ) from exc if not _is_request_dict ( parsed ): msg = \"Order request must be a JSON object.\" raise ValueError ( msg ) return parsed","title":"parse_request"},{"location":"api/cli/#mt5cli.cli.parse_tick_flags","text":"parse_tick_flags ( value : str ) -> int Parse tick flags string or integer value. Parameters: Name Type Description Default value str Tick flag name (ALL, INFO, TRADE) or integer value. required Returns: Type Description int Integer tick flag value. Raises: Type Description ValueError If the flag is invalid. Source code in mt5cli/cli.py 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 def parse_tick_flags ( value : str ) -> int : \"\"\"Parse tick flags string or integer value. Args: value: Tick flag name (ALL, INFO, TRADE) or integer value. Returns: Integer tick flag value. Raises: ValueError: If the flag is invalid. \"\"\" upper = value . upper () if upper in TICK_FLAG_MAP : return TICK_FLAG_MAP [ upper ] try : return int ( value ) except ValueError : valid = \", \" . join ( TICK_FLAG_MAP ) msg = f \"Invalid tick flags: ' { value } '. Use one of: { valid } , or an integer.\" raise ValueError ( msg ) from None","title":"parse_tick_flags"},{"location":"api/cli/#mt5cli.cli.parse_timeframe","text":"parse_timeframe ( value : str ) -> int Parse a timeframe string or integer value. Parameters: Name Type Description Default value str Timeframe name (e.g., 'M1', 'H1', 'D1') or integer value. required Returns: Type Description int Integer timeframe value. Raises: Type Description ValueError If the timeframe is invalid. Source code in mt5cli/cli.py 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 def parse_timeframe ( value : str ) -> int : \"\"\"Parse a timeframe string or integer value. Args: value: Timeframe name (e.g., 'M1', 'H1', 'D1') or integer value. Returns: Integer timeframe value. Raises: ValueError: If the timeframe is invalid. \"\"\" upper = value . upper () if upper in TIMEFRAME_MAP : return TIMEFRAME_MAP [ upper ] try : return int ( value ) except ValueError : valid = \", \" . join ( TIMEFRAME_MAP ) msg = f \"Invalid timeframe: ' { value } '. Use one of: { valid } , or an integer.\" raise ValueError ( msg ) from None","title":"parse_timeframe"},{"location":"api/cli/#mt5cli.cli.positions","text":"positions ( ctx : Context , symbol : Annotated [ str | None , Option ( help = \"Symbol filter.\" ) ] = None , group : Annotated [ str | None , Option ( help = \"Group filter.\" ) ] = None , ticket : Annotated [ int | None , Option ( help = \"Ticket filter.\" ) ] = None , ) -> None Export open positions. Source code in mt5cli/cli.py 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 @app . command () def positions ( ctx : typer . Context , symbol : Annotated [ str | None , typer . Option ( help = \"Symbol filter.\" )] = None , group : Annotated [ str | None , typer . Option ( help = \"Group filter.\" )] = None , ticket : Annotated [ int | None , typer . Option ( help = \"Ticket filter.\" )] = None , ) -> None : \"\"\"Export open positions.\"\"\" _execute_export ( ctx , lambda c : c . positions_get_as_df ( symbol = symbol , group = group , ticket = ticket , ), )","title":"positions"},{"location":"api/cli/#mt5cli.cli.rates_from","text":"rates_from ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe (e.g., M1, H1, D1, or integer).\" , ), ], date_from : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"Start date in ISO 8601 format.\" , ), ], count : Annotated [ int , Option ( help = \"Number of records.\" ) ], ) -> None Export rates from a start date. Source code in mt5cli/cli.py 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 @app . command () def rates_from ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , typer . Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe (e.g., M1, H1, D1, or integer).\" , ), ], date_from : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date in ISO 8601 format.\" , ), ], count : Annotated [ int , typer . Option ( help = \"Number of records.\" )], ) -> None : \"\"\"Export rates from a start date.\"\"\" _execute_export ( ctx , lambda c : c . copy_rates_from_as_df ( symbol = symbol , timeframe = timeframe , date_from = date_from , count = count , ), )","title":"rates_from"},{"location":"api/cli/#mt5cli.cli.rates_from_pos","text":"rates_from_pos ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe.\" ), ], start_pos : Annotated [ int , Option ( help = \"Start position (0 = current bar).\" ), ], count : Annotated [ int , Option ( help = \"Number of records.\" ) ], ) -> None Export rates from a start position. Source code in mt5cli/cli.py 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 @app . command () def rates_from_pos ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , typer . Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe.\" , ), ], start_pos : Annotated [ int , typer . Option ( help = \"Start position (0 = current bar).\" )], count : Annotated [ int , typer . Option ( help = \"Number of records.\" )], ) -> None : \"\"\"Export rates from a start position.\"\"\" _execute_export ( ctx , lambda c : c . copy_rates_from_pos_as_df ( symbol = symbol , timeframe = timeframe , start_pos = start_pos , count = count , ), )","title":"rates_from_pos"},{"location":"api/cli/#mt5cli.cli.rates_range","text":"rates_range ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe.\" ), ], date_from : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], date_to : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ], ) -> None Export rates for a date range. Source code in mt5cli/cli.py 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 @app . command () def rates_range ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], timeframe : Annotated [ int , typer . Option ( click_type = TIMEFRAME_TYPE , help = \"Timeframe.\" , ), ], date_from : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], date_to : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ], ) -> None : \"\"\"Export rates for a date range.\"\"\" _execute_export ( ctx , lambda c : c . copy_rates_range_as_df ( symbol = symbol , timeframe = timeframe , date_from = date_from , date_to = date_to , ), )","title":"rates_range"},{"location":"api/cli/#mt5cli.cli.symbol_info","text":"symbol_info ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], ) -> None Export symbol details. Source code in mt5cli/cli.py 750 751 752 753 754 755 756 757 758 759 @app . command () def symbol_info ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], ) -> None : \"\"\"Export symbol details.\"\"\" _execute_export ( ctx , lambda c : c . symbol_info_as_df ( symbol = symbol ), )","title":"symbol_info"},{"location":"api/cli/#mt5cli.cli.symbol_info_tick","text":"symbol_info_tick ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], ) -> None Export the last tick for a symbol. Source code in mt5cli/cli.py 870 871 872 873 874 875 876 877 878 879 @app . command () def symbol_info_tick ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], ) -> None : \"\"\"Export the last tick for a symbol.\"\"\" _execute_export ( ctx , lambda c : c . symbol_info_tick_as_df ( symbol = symbol ), )","title":"symbol_info_tick"},{"location":"api/cli/#mt5cli.cli.symbols","text":"symbols ( ctx : Context , group : Annotated [ str | None , Option ( help = \"Symbol group filter (e.g., *USD*).\" ), ] = None , ) -> None Export symbol list. Source code in mt5cli/cli.py 735 736 737 738 739 740 741 742 743 744 745 746 747 @app . command () def symbols ( ctx : typer . Context , group : Annotated [ str | None , typer . Option ( help = \"Symbol group filter (e.g., *USD*).\" ), ] = None , ) -> None : \"\"\"Export symbol list.\"\"\" _execute_export ( ctx , lambda c : c . symbols_get_as_df ( group = group ), )","title":"symbols"},{"location":"api/cli/#mt5cli.cli.terminal_info","text":"terminal_info ( ctx : Context ) -> None Export terminal information. Source code in mt5cli/cli.py 729 730 731 732 @app . command () def terminal_info ( ctx : typer . Context ) -> None : \"\"\"Export terminal information.\"\"\" _execute_export ( ctx , lambda c : c . terminal_info_as_df ())","title":"terminal_info"},{"location":"api/cli/#mt5cli.cli.ticks_from","text":"ticks_from ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], date_from : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], count : Annotated [ int , Option ( help = \"Number of ticks.\" )], flags : Annotated [ int , Option ( click_type = TICK_FLAGS_TYPE , help = \"Tick flags (ALL, INFO, TRADE, or integer).\" , ), ], ) -> None Export ticks from a start date. Source code in mt5cli/cli.py 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 @app . command () def ticks_from ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], date_from : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], count : Annotated [ int , typer . Option ( help = \"Number of ticks.\" )], flags : Annotated [ int , typer . Option ( click_type = TICK_FLAGS_TYPE , help = \"Tick flags (ALL, INFO, TRADE, or integer).\" , ), ], ) -> None : \"\"\"Export ticks from a start date.\"\"\" _execute_export ( ctx , lambda c : c . copy_ticks_from_as_df ( symbol = symbol , date_from = date_from , count = count , flags = flags , ), )","title":"ticks_from"},{"location":"api/cli/#mt5cli.cli.ticks_range","text":"ticks_range ( ctx : Context , symbol : Annotated [ str , Option ( help = \"Symbol name.\" )], date_from : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], date_to : Annotated [ datetime , Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ], flags : Annotated [ int , Option ( click_type = TICK_FLAGS_TYPE , help = \"Tick flags.\" ), ], ) -> None Export ticks for a date range. Source code in mt5cli/cli.py 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 @app . command () def ticks_range ( ctx : typer . Context , symbol : Annotated [ str , typer . Option ( help = \"Symbol name.\" )], date_from : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"Start date.\" ), ], date_to : Annotated [ datetime , typer . Option ( click_type = DATETIME_TYPE , help = \"End date.\" ), ], flags : Annotated [ int , typer . Option ( click_type = TICK_FLAGS_TYPE , help = \"Tick flags.\" ), ], ) -> None : \"\"\"Export ticks for a date range.\"\"\" _execute_export ( ctx , lambda c : c . copy_ticks_range_as_df ( symbol = symbol , date_from = date_from , date_to = date_to , flags = flags , ), )","title":"ticks_range"},{"location":"api/cli/#mt5cli.cli.version","text":"version ( ctx : Context ) -> None Export MetaTrader5 version information. Source code in mt5cli/cli.py 858 859 860 861 @app . command () def version ( ctx : typer . Context ) -> None : \"\"\"Export MetaTrader5 version information.\"\"\" _execute_export ( ctx , lambda c : c . version_as_df ())","title":"version"}]} \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index 2e1428f..31ec9d1 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,14 +2,14 @@ https://github.com/dceoy/mt5cli/ - 2026-05-24 + 2026-05-28 https://github.com/dceoy/mt5cli/api/ - 2026-05-24 + 2026-05-28 https://github.com/dceoy/mt5cli/api/cli/ - 2026-05-24 + 2026-05-28 \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz index b7d90f06836e0e35e586267e5e784209125bb1a8..e73b2a1e0fc1bf6e07ff26c93da172a6ec963c9e 100644 GIT binary patch literal 204 zcmV;-05ks|iwFpSg%@f9|8r?{Wo=<_E_iKh0L4+u4uUWcy!#bR?{q5(1`U*(U!Wg= zrGX}W5VnZ^z2y<(Sr5)-cPFzm*=$igtRZ(bp!Tk$d&VhIPWnc>wxrj~Imu}ycEvat zRDndX!;*F(^e2F6ni%S!Y~3UCLklRoI3R2!aCW3(MDr~l=ZF`uRZBI@ G0RR9HkzFnT literal 204 zcmV;-05ks|iwFpSKN4yJ|8r?{Wo=<_E_iKh0L4+u4uUWcy!#bR?{txfQB%szFVGLb z(m<0w2wOz|-tvg?tOw_^yOY_OY?hY~Ysg*osJ$!bmZg*^Cw;A5Q_$<>oE&H=Hhky} zsz9RHVL{svx)Z=Sjtq5Bw(5}iz5$eN91vC#Qg)4mT#f zg<2~A1RHW`G;o+ypGy@6>uZsv**;10B-=&F$}K7Ij`=3A>i!h^)3tMn&k-+CZ_kg+ G0RRAEbzy1%