1 line
33 KiB
JSON
1 line
33 KiB
JSON
|
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"],"fields":{"title":{"boost":1000.0},"text":{"boost":1.0},"tags":{"boost":1000000.0}}},"docs":[{"location":"","title":"mt5cli","text":"<p>Command-line tool for MetaTrader 5 data export.</p>"},{"location":"#overview","title":"Overview","text":"<p>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.</p>"},{"location":"#features","title":"Features","text":"<ul> <li>Multi-format export: CSV, JSON, Parquet, and SQLite3 output formats</li> <li>Auto-detection: Format detection from file extensions</li> <li>Comprehensive data access: Rates, ticks, account info, symbols, orders, positions, and trading history</li> <li>Flexible timeframes: Named timeframes (M1, H1, D1, etc.) and numeric values</li> <li>Connection management: Optional credentials, server, and timeout configuration</li> </ul>"},{"location":"#installation","title":"Installation","text":"<pre><code>pip install mt5cli\n</code></pre>"},{"location":"#quick-start","title":"Quick Start","text":"<pre><code># Export account information to CSV\nmt5cli -o account.csv account-info\n\n# Export EURUSD M1 rates to Parquet\nmt5cli -o rates.parquet rates-from --symbol EURUSD --timeframe M1 \\\n --date-from 2024-01-01 --count 1000\n\n# Export ticks to JSON\nmt5cli -o ticks.json ticks-from --symbol EURUSD \\\n --date-from 2024-01-01 --count 500 --flags ALL\n\n# Export symbols to SQLite3 with custom table name\nmt5cli -o data.db --table symbols symbols --group \"*USD*\"\n\n# Export with connection credentials\nmt5cli --login 12345 --password mypass --server MyBroker-Demo \\\n -o positions.csv positions\n</code></pre>"},{"location":"#commands","title":"Commands","text":""},{"location":"#rates","title":"Rates","text":"Command Description <code>rates-from</code> Export rates from a start date <code>rates-from-pos</code> Export rates from a start position <code>rates-range</code> Export rates for a date range"},{"location":"#ticks","title":"Ticks","text":"Command Description <code>ticks-from</code> Export ticks from a start date <code>ticks-range</code> Export ticks for a date range"},{"location":"#information","title":"Information","text":"Command Description <code>account-info</code> Export account information <code>terminal-info</code> Export terminal information <code>symbols</code> Export symbol list <code>symbol-info</code> Export symbol details"},{"location":"#trading","title":"Trading","text":"Command Description <code>orders</code> Export active orders <code>positions</code> Export open positions <code>history-orders</code> Export historical orders <code>history-deals</code> Export historical deals"},{"location":"#global-options","title":"Global Options","text":"Option Description <code>-o, --output</code> Output file path (required) <code>-f, --format</code> Output format (auto-detected from extension if omitted) <code>--table</code> Table name for SQLite3 output (default: \"data\") <code>--login</code> Trading account login <code>--password</code> Trading account password <code>--server</code> Trading server name <code>--path</code> Path to MetaTrader5 terminal EXE file <code>--timeout</code> Connection timeout in milliseconds <code>--log-level</code> Logging level (DEBUG, INFO, WARNING, ERROR)"},{"location":"#requirements","title":"Requirements","text":"<ul> <li>Python 3.11+</li> <li>Windows OS (MetaTrader 5 requirement)</li> <li>MetaTrader 5 platform</li> </ul>"},{"location":"#api-reference","title":"API Reference","text":"<p>Browse the API documentation for detailed module information:</p> <ul> <li>CLI Module - CLI application with export commands and utility functions</li> </ul>"},{"location":"#development","title":"Development","text":"<p>This project follows strict code quality standards:</p> <ul> <li>Type hints required (strict mode)</li> <li>Comprehensive linting with Ruff</li> <li>Test coverage tracking</li> <li>Google-style docstrings</li> </ul>"},{"location":"#license","title
|