mt5-grpc-server


Namemt5-grpc-server JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/Starmel/Metatrader5-gRPC-server
SummaryMetaTrader 5 gRPC Server for remote trading operations
upload_time2024-12-25 21:48:51
maintainerNone
docs_urlNone
authorstarmel
requires_python>=3.8
licenseNone
keywords metatrader mt5 trading grpc server api
VCS
bugtrack_url
requirements grpcio grpcio-tools protobuf pytz mt5-grpc-proto
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # MT5 gRPC Server

A high-performance gRPC server implementation for MetaTrader 5, enabling remote trading operations and market data access.

## Overview
This module provides a gRPC server that interfaces with MetaTrader 5 terminal, allowing remote access to trading operations, market data, and account management through a standardized gRPC API.

## Installation

```bash
pip install mt5-grpc-server
```

## Features

- **Account Operations**
  - Account info retrieval
  - Balance and equity monitoring
  - Trading history access

- **Trading Operations**
  - Order placement and modification
  - Position management
  - Order validation and calculations

- **Market Data**
  - Real-time price data
  - Symbol information
  - Market depth (DOM)


## Usage

### Starting the Server

Example with secure connection:
```bash
mt5-grpc-server --host 127.0.0.1 --port 50052 --secure --cert-file server.crt --private-key-file server.key
```

Or without secure connection:
```bash
# Default port is 50051 and host is 0.0.0.0
mt5-grpc-server 
```


### Command-line Options

The server supports the following command-line options:

- `--host HOST`: Host address to bind the server to (default: "0.0.0.0")
- `--port PORT`: Port number to listen on (default: 50051)
- `--secure`: Enable secure connection with SSL/TLS
- `--cert-file FILE`: Path to the SSL certificate file (required if --secure is used)
- `--private-key-file FILE`: Path to the private key file (required if --secure is used)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Starmel/Metatrader5-gRPC-server",
    "name": "mt5-grpc-server",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "metatrader, mt5, trading, grpc, server, api",
    "author": "starmel",
    "author_email": "slava.kornienko16@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/97/1e/a87b6e0db7994af986f22ba9c20cbf9988a0a6d0d0201c24f2dc3ae0f0fd/mt5_grpc_server-0.1.0.tar.gz",
    "platform": null,
    "description": "# MT5 gRPC Server\n\nA high-performance gRPC server implementation for MetaTrader 5, enabling remote trading operations and market data access.\n\n## Overview\nThis module provides a gRPC server that interfaces with MetaTrader 5 terminal, allowing remote access to trading operations, market data, and account management through a standardized gRPC API.\n\n## Installation\n\n```bash\npip install mt5-grpc-server\n```\n\n## Features\n\n- **Account Operations**\n  - Account info retrieval\n  - Balance and equity monitoring\n  - Trading history access\n\n- **Trading Operations**\n  - Order placement and modification\n  - Position management\n  - Order validation and calculations\n\n- **Market Data**\n  - Real-time price data\n  - Symbol information\n  - Market depth (DOM)\n\n\n## Usage\n\n### Starting the Server\n\nExample with secure connection:\n```bash\nmt5-grpc-server --host 127.0.0.1 --port 50052 --secure --cert-file server.crt --private-key-file server.key\n```\n\nOr without secure connection:\n```bash\n# Default port is 50051 and host is 0.0.0.0\nmt5-grpc-server \n```\n\n\n### Command-line Options\n\nThe server supports the following command-line options:\n\n- `--host HOST`: Host address to bind the server to (default: \"0.0.0.0\")\n- `--port PORT`: Port number to listen on (default: 50051)\n- `--secure`: Enable secure connection with SSL/TLS\n- `--cert-file FILE`: Path to the SSL certificate file (required if --secure is used)\n- `--private-key-file FILE`: Path to the private key file (required if --secure is used)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "MetaTrader 5 gRPC Server for remote trading operations",
    "version": "0.1.0",
    "project_urls": {
        "Documentation": "https://github.com/Starmel/Metatrader5-gRPC-server/tree/main/docs",
        "Homepage": "https://github.com/Starmel/Metatrader5-gRPC-server",
        "Source": "https://github.com/Starmel/Metatrader5-gRPC-server",
        "Tracker": "https://github.com/Starmel/Metatrader5-gRPC-server/issues"
    },
    "split_keywords": [
        "metatrader",
        " mt5",
        " trading",
        " grpc",
        " server",
        " api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ec239834ccb25f6008692e2137d835fdc94999d845b6c85295260aae9a9d25ad",
                "md5": "f6a920e64dad4158162ff74b36c5ed4b",
                "sha256": "fc1812fc21384c510eeaeee8d0cdfa62bab9bd60b7b596992d4b39913fae8864"
            },
            "downloads": -1,
            "filename": "mt5_grpc_server-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f6a920e64dad4158162ff74b36c5ed4b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 21556,
            "upload_time": "2024-12-25T21:48:49",
            "upload_time_iso_8601": "2024-12-25T21:48:49.036111Z",
            "url": "https://files.pythonhosted.org/packages/ec/23/9834ccb25f6008692e2137d835fdc94999d845b6c85295260aae9a9d25ad/mt5_grpc_server-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "971ea87b6e0db7994af986f22ba9c20cbf9988a0a6d0d0201c24f2dc3ae0f0fd",
                "md5": "d59243f71926e51de79572f286859520",
                "sha256": "e8fd3349f524f55408df690f9dfdc8619838638953ed225f8fe56ebf5470a66a"
            },
            "downloads": -1,
            "filename": "mt5_grpc_server-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d59243f71926e51de79572f286859520",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 13990,
            "upload_time": "2024-12-25T21:48:51",
            "upload_time_iso_8601": "2024-12-25T21:48:51.493503Z",
            "url": "https://files.pythonhosted.org/packages/97/1e/a87b6e0db7994af986f22ba9c20cbf9988a0a6d0d0201c24f2dc3ae0f0fd/mt5_grpc_server-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-25 21:48:51",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Starmel",
    "github_project": "Metatrader5-gRPC-server",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "grpcio",
            "specs": [
                [
                    "==",
                    "1.68.1"
                ]
            ]
        },
        {
            "name": "grpcio-tools",
            "specs": [
                [
                    "==",
                    "1.68.1"
                ]
            ]
        },
        {
            "name": "protobuf",
            "specs": [
                [
                    "==",
                    "5.29.2"
                ]
            ]
        },
        {
            "name": "pytz",
            "specs": [
                [
                    "~=",
                    "2024.2"
                ]
            ]
        },
        {
            "name": "mt5-grpc-proto",
            "specs": [
                [
                    "==",
                    "0.1.0"
                ]
            ]
        }
    ],
    "lcname": "mt5-grpc-server"
}
        
Elapsed time: 0.41716s