tx_units Property
The quantity for security-based actions other than stock splits.
Syntax
def get_tx_units(tx_index: int) -> str: ...
Default Value
""
Remarks
The quantity for security-based actions other than stock splits. The tx_units differ for each type of security.
Depending on the type of the security, the tx_units indicates the following:
- Stocks, Mutual Funds and Other : number of shares.
- Bonds : face value. For example, a $25,000 bond trading at $88 would use 25000 as the units and 88 as the unit price.
- Options : number of contracts (not shares).
This property is always returned with the transaction information if such an information is requested to be included (include_transactions was set to True) in the investment statement download request (when calling the on_get_statement method).
The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.
This property is read-only.