LiveDividendEventProvider

QuantConnect.Lean.Engine.DataFeeds.Enumerators.LiveDividendEventProvider

Bases: DividendEventProvider

Event provider who will emit SymbolChangedEvent events

factor_file

factor_file: CorporateFactorProvider

The current instance being used

This codeEntityType is protected.

config

config: SubscriptionDataConfig

The associated configuration

This codeEntityType is protected.

get_events

get_events(
    event_args: NewTradableDateEventArgs,
) -> Iterable[BaseData]

Check for dividends and returns them

Parameters:

Name	Type	Description	Default
event_args	NewTradableDateEventArgs	The new tradable day event arguments	required

Returns:

Type	Description
Iterable[BaseData]	New Dividend event if any.

initialize

initialize(
    config: SubscriptionDataConfig,
    factor_file_provider: IFactorFileProvider,
    map_file_provider: IMapFileProvider,
    start_time: Union[datetime, date],
) -> None

Initializes this instance

Parameters:

Name	Type	Description	Default
config	SubscriptionDataConfig	The SubscriptionDataConfig	required
factor_file_provider	IFactorFileProvider	The factor file provider to use	required
map_file_provider	IMapFileProvider	The Data.Auxiliary.MapFile provider to use	required
start_time	Union[datetime, date]	Start date for the data request	required

initialize_factor_file

initialize_factor_file() -> None

Initializes the factor file to use

This codeEntityType is protected.