TradingGainLossIncomeStatement
QuantConnect.Data.Fundamental.TradingGainLossIncomeStatement
TradingGainLossIncomeStatement()
TradingGainLossIncomeStatement(
time_provider: ITimeProvider,
security_identifier: SecurityIdentifier,
)
Bases: MultiPeriodField
A broker-dealer or other financial entity may buy and sell securities exclusively for its own account, sometimes referred to as proprietary trading. The profit or loss is measured by the difference between the acquisition cost and the selling price or current market or fair value. The net gain or loss, includes both realized and unrealized, from trading cash instruments, equities and derivative contracts (including commodity contracts) that has been recognized during the accounting period for the broker dealer or other financial entity's own account. This item is typically available for bank industry.
Signature descriptions:
-
Creates a new empty instance
-
Creates a new instance for the given time and security
default_period
default_period: str
The default period
This codeEntityType is protected.
one_month
one_month: float
Gets/sets the OneMonth period value for the field
three_months
three_months: float
Gets/sets the ThreeMonths period value for the field
six_months
six_months: float
Gets/sets the SixMonths period value for the field
nine_months
nine_months: float
Gets/sets the NineMonths period value for the field
twelve_months
twelve_months: float
Gets/sets the TwelveMonths period value for the field
has_value
has_value: bool
Returns true if the field contains a value for the default period
value
value: float
Returns the default value for the field
NO_VALUE
NO_VALUE: QuantConnect_Data_Fundamental_MultiPeriodField_T
No Value
time_provider
time_provider: ITimeProvider
The time provider instance to use
This codeEntityType is protected.
security_identifier
security_identifier: SecurityIdentifier
The target security identifier
This codeEntityType is protected.
get_period_value
get_period_value(period: str) -> float
Gets the value of the field for the requested period
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
period
|
str
|
The requested period |
required |
Returns:
| Type | Description |
|---|---|
float
|
The value for the period. |
get_period_values
get_period_values() -> IReadOnlyDictionary[str, float]
Gets a dictionary of period names and values for the field
Returns:
| Type | Description |
|---|---|
IReadOnlyDictionary[str, float]
|
The dictionary of period names and values. |
convert_period
convert_period(period: str) -> str
Returns a string that represents the current object.
This codeEntityType is protected.
get_period_names
get_period_names() -> Iterable[str]
Gets the list of available period names for the field
has_period_value
has_period_value(period: str) -> bool
Returns true if the field contains a value for the requested period
Returns:
| Type | Description |
|---|---|
bool
|
True if the field contains a value for the requested period. |
has_values
has_values() -> bool
Returns true if the field has at least one value for one period
to_string
to_string() -> str
Returns a string that represents the current object.