mql5_zmq_backtrader/README.rst

.. figure:: docs/images/puente-leonardo.jpg
   :align: center
   :scale: 100%
   :alt: Puente de Leonardo.



===================
mql5_zmq_backtrader
===================


.. image:: https://img.shields.io/pypi/v/mql5_zmq_backtrader.svg
        :target: https://pypi.python.org/pypi/mql5_zmq_backtrader

.. image:: https://img.shields.io/travis/parrondo/mql5_zmq_backtrader.svg
        :target: https://travis-ci.com/parrondo/mql5_zmq_backtrader

.. image:: https://readthedocs.org/projects/mql5-zmq-backtrader/badge/?version=latest
        :target: https://mql5-zmq-backtrader.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status




Project developed to work as a server for Python trading community. It is based on ZeroMQ sockets and uses JSON format to communicate messages. It is a python library for the ZeroMQ API within backtrader framework. It allows rapid trading algo development. For details of API behavior, please see the online API document.


* Free software: MIT license
* Documentation: https://mql5-zmq-backtrader.readthedocs.io.


Features
--------

* TODO

Example
--------
In order to call mql5_zmq_backtrader API, you need to sign up for a Metatrader broker account and obtain account keys. Replace trading accounts in the expert parameter setting with what you get from your broker.


Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage