Metadata-Version: 1.2
Name: ib-insync
Version: 0.9.50
Summary: Python sync/async framework for Interactive Brokers API
Home-page: https://github.com/erdewit/ib_insync
Author: Ewald R. de Wit
Author-email: ewald.de.wit@gmail.com
License: BSD
Description: |Group| |PyVersion| |Status| |PyPiVersion| |License| |Docs| |Downloads|
        
        Introduction
        ============
        
        The goal of the IB-insync library is to make working with the
        `Trader Workstation API <http://interactivebrokers.github.io/tws-api/>`_
        from Interactive Brokers as easy as possible.
        
        The main features are:
        
        * An easy to use linear style of programming;
        * An `IB component <https://ib-insync.readthedocs.io/api.html#module-ib_insync.ib>`_
          that automatically keeps in sync with the TWS or IB Gateway application;
        * A fully asynchonous framework based on
          `asyncio <https://docs.python.org/3/library/asyncio.html>`_
          and
          `eventkit <https://github.com/erdewit/eventkit>`_
          for advanced users;
        * Interactive operation with live data in Jupyter notebooks.
        
        Be sure to take a look at the
        `notebooks <https://ib-insync.readthedocs.io/notebooks.html>`_,
        the `recipes <https://ib-insync.readthedocs.io/recipes.html>`_
        and the `API docs <https://ib-insync.readthedocs.io/api.html>`_.
        
        
        Installation
        ------------
        
        ::
        
            pip3 install -U ib_insync
        
        On some systems ``pip`` should be used instead of ``pip3``.
        
        To install for a single user, add ``--user`` to the command.
        
        Requirements:
        
        * Python 3.6 or higher;
        * A running TWS or IB Gateway application (version 973 or higher).
          Make sure the
          `API port is enabled <https://interactivebrokers.github.io/tws-api/initial_setup.html>`_
          and 'Download open orders on connection' is checked.
        
        The ibapi package from IB is not needed.
        
        Example
        -------
        
        This is a complete script to download historical data:
        
        .. code-block:: python
        
            from ib_insync import *
            # util.startLoop()  # uncomment this line when in a notebook
        
            ib = IB()
            ib.connect('127.0.0.1', 7497, clientId=1)
        
            contract = Forex('EURUSD')
            bars = ib.reqHistoricalData(contract, endDateTime='', durationStr='30 D',
                    barSizeSetting='1 hour', whatToShow='MIDPOINT', useRTH=True)
        
            # convert to pandas dataframe:
            df = util.df(bars)
            print(df[['date', 'open', 'high', 'low', 'close']])
        
        Output::
        
                               date      open      high       low     close
            0   2017-08-13 23:15:00  1.182850  1.183100  1.182100  1.182400
            1   2017-08-14 00:00:00  1.182400  1.182450  1.181875  1.182175
            2   2017-08-14 01:00:00  1.182175  1.182675  1.181900  1.182525
            ...
            719 2017-09-22 22:00:00  1.194425  1.195425  1.194225  1.195050
        
        Documentation
        -------------
        
        The complete `API documentation <https://ib-insync.readthedocs.io/api.html>`_.
        
        `Changelog <https://ib-insync.readthedocs.io/changelog.html>`_.
        
        Discussion
        ----------
        
        The `insync user group <https://groups.io/g/insync>`_ is the place to discuss
        IB-insync and anything related to it.
        
        Disclaimer
        ----------
        
        The software is provided on the conditions of the simplified BSD license.
        
        This project is not affiliated with Interactive Brokers Group, Inc.'s.
        
        
        Good luck and enjoy,
        
        :author: Ewald de Wit <ewald.de.wit@gmail.com>
        
        .. _`Interactive Brokers Python API`: http://interactivebrokers.github.io
        
        .. |Group| image:: https://img.shields.io/badge/groups.io-insync-green.svg
           :alt: Join the user group
           :target: https://groups.io/g/insync
        
        .. |PyPiVersion| image:: https://img.shields.io/pypi/v/ib_insync.svg
           :alt: PyPi
           :target: https://pypi.python.org/pypi/ib_insync
        
        .. |PyVersion| image:: https://img.shields.io/badge/python-3.6+-blue.svg
           :alt:
        
        .. |Status| image:: https://img.shields.io/badge/status-beta-green.svg
           :alt:
        
        .. |License| image:: https://img.shields.io/badge/license-BSD-blue.svg
           :alt:
        
        .. |Docs| image:: https://readthedocs.org/projects/ib-insync/badge/?version=latest
           :alt: Documentation
           :target: https://ib-insync.readthedocs.io
        
        .. |Downloads| image:: https://pepy.tech/badge/ib-insync
           :alt: Number of downloads
           :target: https://pepy.tech/project/ib-insync
Keywords: ibapi tws asyncio jupyter interactive brokers async
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Office/Business :: Financial :: Investment
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.6
