• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    迪恩网络公众号

khramkov/MQL5-JSON-API: Metaquotes MQL5 - JSON - API

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称:

khramkov/MQL5-JSON-API

开源软件地址:

https://github.com/khramkov/MQL5-JSON-API

开源编程语言:

MQL5 99.2%

开源软件介绍:

Metaquotes MQL5 - JSON - API

Development state: stable release version 2.0

Tested on macOS Mojave / Windows 10 in Parallels Desktop container.

Tested on Manjaro Linux / Windows 10 in VirtualBox

Working in production on Debian 10 / Wine 4.

Table of Contents

About the Project

This project was developed to work as a server for the Backtrader Python trading framework. It is based on ZeroMQ sockets and uses JSON format to communicate. But now it has grown to the independent project. You can use it with any programming language that has ZeroMQ binding.

Backtrader Python client is located here: Python Backtrader - Metaquotes MQL5

Thanks to the participation of Gunther Schulz, the project moved to a new level.

New features:

  • Support for multiple datastreams in parallel for any combination of symbols and timeframes independently of the timeframe and symbol of the attached chart
  • Support for tick data
  • Support for direct download as CSV files
  • Automatic retry binding to sockets. When running under Wine in Linux, sockets will be blocked for 60 seconds if closed uncleanly. This can happen if the client is still connected while the EA gets reloaded.
  • Skip re-initialization on chart timeframe change
  • Support for spread data (ask/bid)
  • Support for plotting to charts in MT5 by streaming values from the client
  • Support for processing client data with MT5 indicators

In development:

  • Devitation
  • Stop limit orders
  • Drawing of chart objects

Installation

  1. Install ZeroMQ for MQL5 https://github.com/dingmaotu/mql-zmq
  2. Put the following files from this repo to your MetaEditor Iinclude` directory
    • Include/Json.mqh
    • Include/controlerrors.mqh
    • Include/StringToEnumInt.mqh
  3. Put the Indicators/JsonAPIIndicator.mq5 file from this repo to your MetaEditor Indicators directory
  4. Download and compile experts/JsonAPI.mq5 script.
  5. Check if Metatrader 5 automatic trading is allowed.
  6. Attach the JsonAPI.mq5 script to a chart in Metatrader 5.
  7. Allow DLL import in dialog window.
  8. Check if the ports are free to use. (default:15555,15556, 15557,15558, 15559, 15560,15562)

Documentation

The script uses seven ZeroMQ sockets:

  1. System socket - Recives requests from client and replies 'OK'.
  2. Data socket - Pushes data to client depending on the request via System socket.
  3. Live socket - Automatically pushes last candle when it closes.
  4. Streaming socket - Automatically pushes last transaction info every time it happens.
  5. Indicator data socket - automatically pushes indicator result values to the client.
  6. Chart Data Socket - Recieves values to be plotted to a specific chart.
  7. Chart Indicator Socket - Only for internal communication. Passes values to be plotted TO the supplied JsonAPIIndicator indicator

The idea is to send requests via System socket and recieve results/errors via Data socket. Event handlers should be created for Live socket and Streaming socket because the server sends data to theese sockets automatically. See examples in Live data and streaming events section.

System socket request uses default JSON dictionary:

{
	"action": null,
	"actionType": null,
	"symbol": null,
	"chartTF": null,
	"fromDate": null,
	"toDate": null,
	"id": null,
	"magic": null,
	"volume": null,
	"price": null,
	"stoploss": null,
	"takeprofit": null,
	"expiration": null,
	"deviation": null,
	"comment": null,
    "chartId": None,
    "indicatorChartId": None,
    "chartIndicatorSubWindow": None,
    "style": None,
}

Check out the available combinations of action and actionType:

action actionType Description
CONFIG null Set script configuration
RESET null Reset subscribed symbols
ACCOUNT null Get account settings
BALANCE null Get current balance
POSITIONS null Get current open positions
ORDERS null Get current open orders
INDICATOR ATTACH Attach an indicator and return ID
INDICATOR REQUEST Get indicator data
CHART OPEN Open a new chart window
CHART ADDINDICATOR Attach JsonAPIIndicator indicator
HISTORY DATA Get data history
HISTORY TRADES Get trades history
HISTORY WRITE Download history data as CSV
TRADE ORDER_TYPE_BUY Buy market
TRADE ORDER_TYPE_SELL Sell market
TRADE ORDER_TYPE_BUY_LIMIT Buy limit
TRADE ORDER_TYPE_SELL_LIMIT Sell limit
TRADE ORDER_TYPE_BUY_STOP Buy stop
TRADE ORDER_TYPE_SELL_STOP Sell stop
TRADE POSITION_MODIFY Position modify
TRADE POSITION_PARTIAL Position close partial
TRADE POSITION_CLOSE_ID Position close by id
TRADE POSITION_CLOSE_SYMBOL Positions close by symbol
TRADE ORDER_MODIFY Order modify
TRADE ORDER_CANCEL Order cancel

Python 3 API class example:

import zmq

class MTraderAPI:
    def __init__(self, host=None):
        self.HOST = host or 'localhost'
        self.SYS_PORT = 15555       # REP/REQ port
        self.DATA_PORT = 15556      # PUSH/PULL port
        self.LIVE_PORT = 15557      # PUSH/PULL port
        self.EVENTS_PORT = 15558    # PUSH/PULL port
        self.INDICATOR_DATA_PORT = 15559  # REP/REQ port
        self.CHART_DATA_PORT = 15560  # PUSH port

        # ZeroMQ timeout in seconds
        sys_timeout = 1
        data_timeout = 10

        # initialise ZMQ context
        context = zmq.Context()

        # connect to server sockets
        try:
            self.sys_socket = context.socket(zmq.REQ)
            # set port timeout
            self.sys_socket.RCVTIMEO = sys_timeout * 1000
            self.sys_socket.connect('tcp://{}:{}'.format(self.HOST, self.SYS_PORT))

            self.data_socket = context.socket(zmq.PULL)
            # set port timeout
            self.data_socket.RCVTIMEO = data_timeout * 1000
            self.data_socket.connect('tcp://{}:{}'.format(self.HOST, self.DATA_PORT))

            self.indicator_data_socket = context.socket(zmq.PULL)
            # set port timeout
            self.indicator_data_socket.RCVTIMEO = data_timeout * 1000
            self.indicator_data_socket.connect(
                "tcp://{}:{}".format(self.HOST, self.INDICATOR_DATA_PORT)
            )
            self.chart_data_socket = context.socket(zmq.PUSH)
            # set port timeout
            # TODO check if port is listening and error handling
            self.chart_data_socket.connect(
                "tcp://{}:{}".format(self.HOST, self.CHART_DATA_PORT)
            )

        except zmq.ZMQError:
            raise zmq.ZMQBindError("Binding ports ERROR")

    def _send_request(self, data: dict) -> None:
        """Send request to server via ZeroMQ System socket"""
        try:
            self.sys_socket.send_json(data)
            msg = self.sys_socket.recv_string()
            # terminal received the request
            assert msg == 'OK', 'Something wrong on server side'
        except AssertionError as err:
            raise zmq.NotDone(err)
        except zmq.ZMQError:
            raise zmq.NotDone("Sending request ERROR")

    def _pull_reply(self):
        """Get reply from server via Data socket with timeout"""
        try:
            msg = self.data_socket.recv_json()
        except zmq.ZMQError:
            raise zmq.NotDone('Data socket timeout ERROR')
        return msg

    def _indicator_pull_reply(self):
        """Get reply from server via Data socket with timeout"""
        try:
            msg = self.indicator_data_socket.recv_json()
        except zmq.ZMQError:
            raise zmq.NotDone("Indicator Data socket timeout ERROR")
        if self.debug:
            print("ZMQ INDICATOR DATA REPLY: ", msg)
        return msg

    def live_socket(self, context=None):
        """Connect to socket in a ZMQ context"""
        try:
            context = context or zmq.Context.instance()
            socket = context.socket(zmq.PULL)
            socket.connect('tcp://{}:{}'.format(self.HOST, self.LIVE_PORT))
        except zmq.ZMQError:
            raise zmq.ZMQBindError("Live port connection ERROR")
        return socket

    def streaming_socket(self, context=None):
        """Connect to socket in a ZMQ context"""
        try:
            context = context or zmq.Context.instance()
            socket = context.socket(zmq.PULL)
            socket.connect('tcp://{}:{}'.format(self.HOST, self.EVENTS_PORT))
        except zmq.ZMQError:
            raise zmq.ZMQBindError("Data port connection ERROR")
        return socket

    def _push_chart_data(self, data: dict) -> None:
        """Send message for chart control to server via ZeroMQ chart data socket"""
        try:
            if self.debug:
                print("ZMQ PUSH CHART DATA: ", data, " -> ", data)
            self.chart_data_socket.send_json(data)
        except zmq.ZMQError:
            raise zmq.NotDone("Sending request ERROR")

    def construct_and_send(self, **kwargs) -> dict:
        """Construct a request dictionary from default and send it to server"""

        # default dictionary
        request = {
            "action": None,
            "actionType": None,
            "symbol": None,
            "chartTF": None,
            "fromDate": None,
            "toDate": None,
            "id": None,
            "magic": None,
            "volume": None,
            "price": None,
            "stoploss": None,
            "takeprofit": None,
            "expiration": None,
            "deviation": None,
            "comment": None,
            "chartId": None,
            "indicatorChartId": None,
            "chartIndicatorSubWindow": None,
            "style": None,
        }

        # update dict values if exist
        for key, value in kwargs.items():
            if key in request:
                request[key] = value
            else:
                raise KeyError('Unknown key in **kwargs ERROR')

        # send dict to server
        self._send_request(request)

        # return server reply
        return self._pull_reply()

    def indicator_construct_and_send(self, **kwargs) -> dict:
        """Construct a request dictionary from default and send it to server"""

        # default dictionary
        request = {
            "action": None,
            "actionType": None,
            "id": None,
            "symbol": None,
            "chartTF": None,
            "fromDate": None,
            "toDate": None,
            "name": None,
            "params": None,
            "linecount": None,
        }

        # update dict values if exist
        for key, value in kwargs.items():
            if key in request:
                request[key] = value
            else:
                raise KeyError("Unknown key in **kwargs ERROR")

        # send dict to server
        self._send_request(request)

        # return server reply
        return self._indicator_pull_reply()

    def chart_data_construct_and_send(self, **kwargs) -> dict:
        """Construct a request dictionary from default and send it to server"""

        # default dictionary
        message = {
            "action": None,
            "actionType": None,
            "chartId": None,
            "indicatorChartId": None,
            "data": None,
        }

        # update dict values if exist
        for key, value in kwargs.items():
            if key in message:
                message[key] = value
            else:
                raise KeyError("Unknown key in **kwargs ERROR")

        # send dict to server
        self._push_chart_data(message)

Usage

All examples will be on Python 3. Lets create an instance of MetaTrader API class:

api = MTraderAPI()

First of all we should configure the script symbol and timeframe. Live data stream will be configured to the same params. You can use any number of symbols and timeframes. The server subscribes to these sembols and will transmit them through the Live data socket

print(api.construct_and_send(action="CONFIG", symbol="EURUSD", chartTF="M5"))
print(api.construct_and_send(action="CONFIG", symbol="AUDUSD", chartTF="M1"))
...

There is also tick data. You can subscribe for tick and candle data at the same symbol.

print(api.construct_and_send(action="CONFIG", symbol="EURUSD", chartTF="TICK"))
print(api.construct_and_send(action="CONFIG", symbol="EURUSD", chartTF="M1"))

If you want to stop Live data, you should reset server subscriptions.

rep = api.construct_and_send(action="RESET")
print(rep)

Get information about the trading account.

rep = api.construct_and_send(action="ACCOUNT")
print(rep)

Get historical data. fromDate should be in timestamp format. The data will be loaded to the last candle if toDate is None. Notice, that the script sends the last unclosed candle too. You should delete it manually.

There are some issues:

  • MetaTrader keeps historical data in cache. But when you make a request for the first time, MetaTrader downloads the data from a broker. This operation can exceed Data socket timeout. It depends on your broker. Second request will be handeled quickly.
  • It takes 6-7 seconds to process 50000 M1 candles. It was tested on Windows 10 in Parallels Desktop container with 4 cores and 4GB RAM. So if you need more data there are three ways to handle it. 1) Increase Data socket timeout. 2) You can load data partially using fromDate and toDate. 3) You can use more powerfull hardware.
rep = api.construct_and_send(action="HISTORY", actionType="DATA", symbol="EURUSD", chartTF="M5", fromDate=1555555555)
print(rep)

History data reply example:

{'data': [[1560782340, 1.12271, 1.12288, 1.12269, 1.12277, 46.0],[1560782400, 1.12278, 1.12299, 1.12276, 1.12297, 43.0],[1560782460, 1.12296, 1.12302, 1.12293, 1.123, 23.0]]}

Buy market order.

rep = api.construct_and_send(action="TRADE", actionType="ORDER_TYPE_BUY", symbol="EURUSD", "volume"=0.1, "stoploss"=1.1, "takeprofit"=1.3)
print(rep)

Sell limit order. Remember to switch SL/TP depending on BUY/SELL, or you will get invalid stops error.

  • BUY: SL < price < TP
  • SELL: SL > price > TP
rep = api.construct_and_send(action="TRADE", actionType="ORDER_TYPE_SELL_LIMIT", symbol="EURUSD", "volume"=0.1, "price"=1.2, "stoploss"=1.3, "takeprofit"=1.1)
print(rep)

All pending orders are set to Good till cancel by default. If you want to set an expiration date, pass the date in timestamp format to expiration param.

rep = api.construct_and_send(action="TRADE", actionType="ORDER_TYPE_SELL_LIMIT", symbol="EURUSD", "volume"=0.1, "price"=1.2, "expiration"=1560782460)
print(rep)

Live data and streaming events

Event handler example for Live socket and Data socket.

import zmq
import threading

api = MTraderAPI()


def _t_livedata():
    socket = api.live_socket()
    while True:
        try:
            last_candle = socket.recv_json()
        except zmq.ZMQError:
            raise zmq.NotDone("Live data ERROR")
        print(last_candle)


def _t_streaming_events():
    socket = api.streaming_socket()
    while True:
        try:
            trans = socket.recv_json()
            request, reply = trans.values()
        except zmq.ZMQError:
            raise zmq.NotDone("Streaming data ERROR")
        print(request)
        print(reply)



t = threading.Thread(target=_t_livedata, daemon=True)
t.start()

t = threading.Thread(target=_t_streaming_events, daemon=True)
t.start()

while True:
    pass

There are only two variants of Live socket data. When everything is ok, the script sends subscribed data on new even. You can divide streams by symbol and timeframe names:

{"status":"CONNECTED","symbol":"EURUSD","timeframe":"TICK","data":[1581611172734,1.08515,1.08521]}
{"status":"CONNECTED","symbol":"EURUSD","timeframe":"M1","data":[1581611100,1.08525,1.08525,1.08520,1.08520,10.00000]}

If the terminal has lost connection to the market:

{"status":"DISCONNECTED"}

When the terminal reconnects to the market, it sends the last closed candle again. So you should update your historical data. Make the action="HISTORY" request with fromDate equal to your last candle timestamp before disconnect.

OnTradeTransaction function is called when a trade transaction event occurs. Streaming socket sends TRADE_TRANSACTION_REQUEST data every time it happens. Try to create and modify orders in the MQL5 terminal manually and check the expert logging tab for better understanding. Also see MQL5 docs.

TRADE_TRANSACTION_REQUEST request data:

{
	'action': 'TRADE_ACTION_DEAL',
	'order': 501700843,
	'symbol': 'EURUSD',
	'volume': 0.1,
	'price': 1.12181,
	'stoplimit': 0.0,
	'sl': 1.1,
	'tp': 1.13,
	'deviation': 10,
	'type': 'ORDER_TYPE_BUY',
	'type_filling': 'ORDER_FILLING_FOK',
	'type_time': 'ORDER_TIME_GTC',
	'expiration': 0,
	'comment': None,
	'position': 0,
	'position_by': 0
}

TRADE_TRANSACTION_REQUEST result data:

{
	'retcode': 10009,
	'result': 'TRADE_RETCODE_DONE',
	'deal': 501700843,
	'order': 501700843,
	'volume': 0.1,
	'price': 1.12181,
	'comment': None,
	'request_id': 8,
	'retcode_external': 0
}

Streaming MT5 indicator data

Open a chart window and attach a MT5 indicator.

Parameters:

  • id - a unique id string.
  • symbol - chart symbol to open and atatch the indicator to.
  • chartTF - timeframe to set the chart at.
  • name - the name of the MT5 indicator to attach.
  • params - the initialisation paramaters that the specified indicator expects.
  • linecount - the number of buffers the indicator returns. In the example below MACD is used and it return the values for "macd" and "signal".
print(api.indicator_construct_and_send(action='INDICATOR', actionType='ATTACH', id='4df306ea-e8e6-439b-8004-b86ba4bcc8c3', symbol='EURUSD', chartTF='M1', name='Examples/MACD', 'params'=['12', '26', '9', 'PRICE_CLOSE'], 'linecount'=2))

Stream the calculated result values of a previously attached indicator.

Parameters:

  • id - id string of a previously attached indicator.
  • fromDate - timestamp for which a result value is requested.
print(api.indicator_construct_and_send(action='INDICATOR', actionType='REQUEST', id='4df306ea-e8e6-439b-8004-b86ba4bcc8c3', 'fromDate'=1591993860))

Example of the result:

{'error': False, 'id': '4df306ea-e8e6-439b-8004-b86ba4bcc8c3', 'data': ['0.00008204', '0.00001132']}

The data field holds a list with results of the calculated indicator buffers.


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap