Skip to content

IDividendYieldModel

QuantConnect.Data.IDividendYieldModel

Represents a model that provides dividend yield data

get_dividend_yield 

get_dividend_yield(date: Union[datetime, date]) -> float

get_dividend_yield(
    date: Union[datetime, date], security_price: float
) -> float

Signature descriptions:

  • Get dividend yield by a given date of a given symbol

  • Get dividend yield at given date and security price

Parameters:

Name Type Description Default
date Union[datetime, date]

The date

 required
security_price Optional[float]

The security price at the given date

 None

Returns:

Type Description
float

Dividend yield on the given date of the given symbol.