.. _get_stared_ibkr:

Get Started with IBKR
---------------------

To use the IBKR interface, you need to have an Interactive Brokers account. If you don't have one, you can create one by following the steps below:

1. Go to the Interactive Brokers website.
2. Click on the "Open Account" button.
3. Fill out the required information.

Once you have an account, you can start using the IBKR interface to access market data and execute trades.
You'll need to install the `IB Gateway <https://interactivebrokers.github.io/>`_ software and
the `IBKR Python API <https://www.interactivebrokers.com/campus/ibkr-api-page/twsapi-doc/#find-the-api>`_ for your
Operating System to use the `dxlib` IBKR interface.

To easilyi install the `IBKR Python API`, run:

.. code-block:: bash

    pip install ibapi


.. warning::

    You need to install BOTH the `IB Gateway` and the `IBKR Python API` to use the `dxlib` IBKR interface.
    Follow the instructions on the `IB Gateway <https://interactivebrokers.github.io/>`_ website to
    setup the Gateway to work with your account.