Skip to content

trading_agent.tools.broker_tool

The shallow base class of the read-only trading tools.

Typical usage example:

class GetQuoteTool(BrokerTool): ...

BrokerTool 

BrokerTool(reader, formatter)

Bases: Tool

A tool that reads from UBI through tradingmachine.

Creates the tool.

Parameters:

Name Type Description Default
reader BrokerReader

The shared reader of UBI.

 required
formatter ResultFormatter

Turns tradingmachine's answers into text.

 required
Source code in src/trading_agent/tools/broker_tool.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
def __init__(
    self,
    reader: broker_reader_module.BrokerReader,
    formatter: result_formatter_module.ResultFormatter,
):
    """Creates the tool.

    Args:
        reader (broker_reader_module.BrokerReader): The shared reader of UBI.
        formatter (result_formatter_module.ResultFormatter): Turns tradingmachine's answers into text.
    """
    self._reader = reader
    self._formatter = formatter