trade_config
============

.. py:module:: trade_config


Classes
-------

.. autoapisummary::

   trade_config.BrokerType
   trade_config.AssetExchange
   trade_config.RRTradeConfig


Module Contents
---------------

.. py:class:: BrokerType

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Enum for broker types.


   .. py:attribute:: ALPACA
      :value: 'ALPACA'



   .. py:attribute:: LOCAL
      :value: 'LOCAL'



   .. py:attribute:: REMOTE
      :value: 'REMOTE'



.. py:class:: AssetExchange

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Represents the current exchanges Alpaca supports.


   .. py:attribute:: AMEX
      :value: 'AMEX'



   .. py:attribute:: ARCA
      :value: 'ARCA'



   .. py:attribute:: BATS
      :value: 'BATS'



   .. py:attribute:: NYSE
      :value: 'NYSE'



   .. py:attribute:: NASDAQ
      :value: 'NASDAQ'



   .. py:attribute:: NYSEARCA
      :value: 'NYSEARCA'



   .. py:attribute:: FTXU
      :value: 'FTXU'



   .. py:attribute:: CBSE
      :value: 'CBSE'



   .. py:attribute:: GNSS
      :value: 'GNSS'



   .. py:attribute:: ERSX
      :value: 'ERSX'



   .. py:attribute:: OTC
      :value: 'OTC'



   .. py:attribute:: CRYPTO
      :value: 'CRYPTO'



   .. py:attribute:: EMPTY
      :value: ''



.. py:class:: RRTradeConfig(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`


   Trading Configuration
   .. todo::

      - notifications
      - require trade approval


   .. py:attribute:: id
      :type:  uuid.UUID | None
      :value: None



   .. py:attribute:: account_number
      :type:  str
      :value: None



   .. py:attribute:: model_path
      :type:  trading.cli.alg.config.ProjectPath
      :value: None



   .. py:attribute:: broker
      :type:  BrokerType
      :value: None



   .. py:attribute:: broker_kwargs
      :type:  dict
      :value: None



   .. py:attribute:: bucket_name
      :type:  str | None
      :value: None



   .. py:attribute:: positions_path
      :type:  trading.cli.alg.config.ProjectPath | None
      :value: None



   .. py:attribute:: closed_positions_path
      :type:  trading.cli.alg.config.ProjectPath | None
      :value: None



   .. py:attribute:: account_value_series_path
      :type:  trading.cli.alg.config.ProjectPath | None
      :value: None



   .. py:attribute:: account_path
      :type:  trading.cli.alg.config.ProjectPath | None
      :value: None



   .. py:attribute:: meta_data_path
      :type:  trading.cli.alg.config.ProjectPath | None
      :value: None



   .. py:attribute:: backtest_path
      :type:  trading.cli.alg.config.ProjectPath | None
      :value: None



   .. py:attribute:: active
      :type:  bool
      :value: None



   .. py:attribute:: out_dir
      :type:  trading.cli.alg.config.ProjectPath
      :value: None



   .. py:attribute:: portfolio_config
      :type:  trading.cli.alg.config.PortfolioConfig | None
      :value: None



   .. py:attribute:: defer_trade_execution
      :type:  bool
      :value: None



   .. py:attribute:: asset_exchanges
      :type:  list[AssetExchange]
      :value: None



   .. py:method:: ensure_id(values)