Skip to content

TotalDepositsBalanceSheet

QuantConnect.Data.Fundamental.TotalDepositsBalanceSheet 

TotalDepositsBalanceSheet()

TotalDepositsBalanceSheet(
    time_provider: ITimeProvider,
    security_identifier: SecurityIdentifier,
)

Bases: MultiPeriodField

A liability account which represents the total amount of funds deposited.

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 Property is protected.

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 Property is protected.

security_identifier 

security_identifier: SecurityIdentifier

The target security identifier

This Property 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() -> Dict[str, float]

Gets a dictionary of period names and values for the field

Returns:

Type Description
Dict[str, float]

The dictionary of period names and values.

__add__ 

__add__(right: MultiPeriodField) -> float

__add__(right: MultiPeriodFieldLong) -> float

__add__(right: MultiPeriodField) -> float

Signature descriptions:

  • Adds the default values of a double and a long backed field

  • Adds the default values of a long and a double backed field

__iadd__ 

__iadd__(right: MultiPeriodField) -> float

__iadd__(right: MultiPeriodFieldLong) -> float

__iadd__(right: MultiPeriodField) -> float

Signature descriptions:

  • Adds the default values of a double and a long backed field

  • Adds the default values of a long and a double backed field

__imod__ 

__imod__(right: MultiPeriodField) -> float

__imod__(right: MultiPeriodFieldLong) -> float

__imod__(right: MultiPeriodField) -> float

Computes the remainder of dividing the left field's default value by the right field's default value

__imul__ 

__imul__(right: MultiPeriodField) -> float

__imul__(right: MultiPeriodFieldLong) -> float

__imul__(right: MultiPeriodField) -> float

Signature descriptions:

  • Multiplies the default values of two fields

  • Multiplies the default values of a double and a long backed field

  • Multiplies the default values of a long and a double backed field

__isub__ 

__isub__(right: MultiPeriodField) -> float

__isub__(right: MultiPeriodFieldLong) -> float

__isub__(right: MultiPeriodField) -> float

Subtracts the right field's default value from the left field's default value

__itruediv__ 

__itruediv__(right: MultiPeriodField) -> float

__itruediv__(right: MultiPeriodFieldLong) -> float

__itruediv__(right: MultiPeriodField) -> float

Divides the left field's default value by the right field's default value

__mod__ 

__mod__(right: MultiPeriodField) -> float

__mod__(right: MultiPeriodFieldLong) -> float

__mod__(right: MultiPeriodField) -> float

Computes the remainder of dividing the left field's default value by the right field's default value

__mul__ 

__mul__(right: MultiPeriodField) -> float

__mul__(right: MultiPeriodFieldLong) -> float

__mul__(right: MultiPeriodField) -> float

Signature descriptions:

  • Multiplies the default values of two fields

  • Multiplies the default values of a double and a long backed field

  • Multiplies the default values of a long and a double backed field

__sub__ 

__sub__(right: MultiPeriodField) -> float

__sub__(right: MultiPeriodFieldLong) -> float

__sub__(right: MultiPeriodField) -> float

Subtracts the right field's default value from the left field's default value

__truediv__ 

__truediv__(right: MultiPeriodField) -> float

__truediv__(right: MultiPeriodFieldLong) -> float

__truediv__(right: MultiPeriodField) -> float

Divides the left field's default value by the right field's default value

convert_period 

convert_period(period: str) -> str

Returns a string that represents the current object.

This Class is protected.

get_period_names 

get_period_names() -> Sequence[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.