broker_connection ===

class whispertrades.broker_connection.BaseBrokerConnection(*, name: str | None, number: str, account_number: str)[source]¶

Bases: BaseModel

account_number : str¶

name : str | None¶

number : str¶

class whispertrades.broker_connection.BrokerConnection(data: BrokerConnectionResponse, client: WTClient, auto_refresh: bool = True)[source]¶

Bases: object

account_number : str¶

account number

auto_refresh : bool¶

auto_refresh toggle inherited from WTClient

broker : str¶

broker name

client : WTClient¶

the WTClient object that created this instance

endpoint : str¶

expires_at : datetime | None¶

expiration date. Only for brokers without permanent connection. e.g. Schwab

name : str | None¶

name of the connection as set by user

net_liquidation_value : float¶

net liquidation value

number : str¶

connection number

rebalance_collateral()[source]¶

Rebalance your collateral position for a given broker connection. This requires that the collateral be configured and enabled at Whispertrades. If your current collateral balance is within the minimum and maximum target amounts, a transaction will not happen. Auth Required: Write Broker Connections

status : Literal['Active', 'Inactive']¶

connection status

class whispertrades.broker_connection.BrokerConnectionResponse(*, name: str | None, number: str, account_number: str, broker: str, status: 'Active' | 'Inactive', net_liquidation_value: float, expires_at: datetime | None)[source]¶

Bases: BaseBrokerConnection

broker : str¶

expires_at : datetime | None¶

net_liquidation_value : float¶

status : Literal['Active', 'Inactive']¶