Metadata-Version: 2.1
Name: pyOMT5
Version: 0.0.25
Summary: pyOMT5 - Python Open Metatrader 5 module
Home-page: https://github.com/paulorodriguesxv/pyomt5
Author: Paulo Rodrigues
Author-email: paulorodriguesxv@gmail.com
License: MIT
Keywords: stocks,market,finance,metatrader,quotes,shares
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Office/Business :: Financial :: Investment
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/x-rst
Requires-Dist: pyzmq
Requires-Dist: pandas
Provides-Extra: pandas
Requires-Dist: pandas ; extra == 'pandas'

==================================
pyOMT5 - Python Open MetaTrader 5
==================================

Python module to request data from MetaTrader 5

To get started:

-  install visual c++ 2010 redistributable (x86 or x64 according with
   your os)
-  install visual c++ 2015 redistributable (x86 or x64 according with
   your os)
-  create a new directory called pyOMT5 inside your MT5 Scrips folder.
   Ex:
   C:\Users\MyUser\AppData\Roaming\MetaQuotes\Terminal\83D4764E0403A8685E84D6FCAB361AAB\MQL5\Scripts\pyOMT5
-  download DLL files according your OS (32|64 Bits) from ZMQ_ to the
   new direcotry called pyOMT5
-  copy the files pyOMT5Server.mq5 and pyOMT5Server.ex5 from util
   directory called pyOMT5 to this new directory and compile it using
   MetaEditor if necessary.
-  run pyOMT5Server as a expert. Remember to have enabled auto trading
   option and allow DLLs imports when asked.

This module provides data in pandas representation because we believe
that whether in finance, scientific fields, or data science, a
familiarity with Pandas is known by everyone.

This library uses ZeroMQ and create a internal tcp server on MetaTrader,
with the purpose of exchange data with MT5.

Install
--------

To install the package use:

.. code-block::

   pip install pyOMT5

If you want to install from source, then use:

.. code-block::

   git clone https://github.com/paulorodriguesxv/pyOMT5.git
   pip install -e pyOMT5

Usage
------

.. code-block:: python


   from datetime import datetime
   from pyomt5.api import MT5TimeFrame
   from pyomt5.stock import StockPriceHistory

   c = StockPriceHistory()

   start_date = datetime(2019, 1, 1)
   end_date = datetime(2019, 5, 2)
   data = c.get_price_from(symbol='PETR4',
                           from_date=start_date,
                           to_date=end_date,
                           timeframe=MT5TimeFrame.Daily)

   print(data)

   start_date = datetime(2019, 1, 2, 10, 0)
   end_date = datetime(2019, 1, 2, 12, 0, 0)
   data = c.get_price_from(symbol='PETR4',
                           from_date=start_date,
                           to_date=end_date,
                           timeframe=MT5TimeFrame.M5)

   print(data)

Contributing
-------------

Contributing is always welcome, so, feel free to getting in touch and
contribute.

TODOs
------

-  Add test for library.
-  Create sphinx docs
-  Create travis
-  Extend Api

.. _star-if-you-like-it:

Star if you like it.
---------------------

If you like or use this project, consider showing your support by starring it.

.. _ZMQ: https://github.com/dingmaotu/mql-zmq/tree/master/Library/VC2010


