.. _brokers:

Brokers
=======

boatwright endeavors to generalize automated trading strategies, without limiting users, which includes the type of orders and how order are managed with a broker.
However, brokers do differ in the available orders types, order managament, backend logic for order placement on exchanges, and of course in their API call format.
This is to say that the backtest broker will not exactly replicate any live broker, inheriently introducing error to backtests.
Further, it makes it difficult to generalize what a broker is and can do. 

The compromise implemented here is that the parent broker class imposes the most common order types / managment and the BacktestBroker contains models for these.
Users seeking to implement more complex order flows offered by their broker can write their own instances of 'backtest' and 'live' broker API interfaces.

.. toctree::
    :maxdepth: 5

    backtest
    coinbase
    alpaca

.. _Broker:

Broker
~~~~~~

.. automodule:: src.boatwright.Brokers.Broker

.. autoclass:: Broker
    :members: