Skip to content

trading_agent.terminal.widgets.funds_card

The side panel's Funds card: the balance and the margin in use, with a meter.

Typical usage example:

card = FundsCard() card.show(account, None)

FundsCard 

FundsCard(collapsed=False)

Bases: SideCard

The Funds card.

Creates the card.

Parameters:

Name Type Description Default
collapsed bool

Whether it starts folded.

 False
Source code in src/trading_agent/terminal/widgets/funds_card.py 
22
23
24
25
26
27
28
29
def __init__(self, collapsed: bool = False):
    """Creates the card.

    Args:
        collapsed (bool): Whether it starts folded.
    """
    super().__init__('funds', 'Funds', collapsed=collapsed)
    self._formatter = formatter.Formatter()

show 

show(account, error)

Shows the account's funds.

Parameters:

Name Type Description Default
account dict[str, Any] | None

The account, or None when it could not be read.

 required
error str | None

Why it could not be read, or None while loading.

 required
Source code in src/trading_agent/terminal/widgets/funds_card.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
def show(self, account: dict[str, Any] | None, error: str | None) -> None:
    """Shows the account's funds.

    Args:
        account (dict[str, Any] | None): The account, or None when it could not be read.
        error (str | None): Why it could not be read, or None while loading.
    """
    if account is None:
        self.show_body(self.note(error or 'Loading…'))
        return
    balance = float(account.get('total_balance') or 0)
    margin = float(account.get('margin_utilized') or 0)
    share = 0.0
    if balance > 0:
        share = min(1.0, margin / balance)
    cells = round(_METER_WIDTH * share)
    meter = Content.assemble(
        ('█' * cells, '$accent'),
        ('░' * (_METER_WIDTH - cells), 'dim'),
    )
    self.show_body(
        Content('\n').join(
            [
                self.rows(
                    [
                        (
                            'Balance',
                            self._formatter.money(balance),
                        ),
                        (
                            'Margin in use',
                            self._formatter.money(margin),
                        ),
                    ]
                ),
                meter,
                self.note(
                    f'{self._formatter.share(margin, balance)} of the balance is in use as margin.'
                ),
            ]
        )
    )