Lean  $LEAN_TAG$
QuantConnect.Data.IDividendYieldModel Interface Reference

Represents a model that provides dividend yield data More...

Inheritance diagram for QuantConnect.Data.IDividendYieldModel:
[legend]

Public Member Functions

decimal GetDividendYield (DateTime date)
 Get dividend yield by a given date of a given symbol More...
 
decimal GetDividendYield (DateTime date, decimal securityPrice)
 Get dividend yield at given date and security price More...
 

Detailed Description

Represents a model that provides dividend yield data

Definition at line 23 of file IDividendYieldModel.cs.

Member Function Documentation

◆ GetDividendYield() [1/2]

decimal QuantConnect.Data.IDividendYieldModel.GetDividendYield ( DateTime  date)

Get dividend yield by a given date of a given symbol

Parameters
dateThe date
Returns
Dividend yield on the given date of the given symbol

Implemented in QuantConnect.Data.DividendYieldProvider, QuantConnect.Python.DividendYieldModelPythonWrapper, and QuantConnect.Data.ConstantDividendYieldModel.

Here is the caller graph for this function:

◆ GetDividendYield() [2/2]

decimal QuantConnect.Data.IDividendYieldModel.GetDividendYield ( DateTime  date,
decimal  securityPrice 
)

Get dividend yield at given date and security price

Parameters
dateThe date
securityPriceThe security price at the given date
Returns
Dividend yield on the given date of the given symbol

Implemented in QuantConnect.Data.DividendYieldProvider, QuantConnect.Python.DividendYieldModelPythonWrapper, and QuantConnect.Data.ConstantDividendYieldModel.


The documentation for this interface was generated from the following file: