Skip to content

IFluentSchedulingRunnable

QuantConnect.Scheduling.IFluentSchedulingRunnable

Bases: IFluentSchedulingTimeSpecifier

Specifies the callback component of a scheduled event, as well as final filters

run

run(callback: Callable[[], Any]) -> ScheduledEvent
run(callback: Callable[[datetime], Any]) -> ScheduledEvent
run(
    callback: Callable[[str, datetime], Any],
) -> ScheduledEvent

Register the defined event with the callback

during_market_hours

during_market_hours(
    symbol: Union[Symbol, str, BaseContract],
    extended_market: bool = False,
) -> IFluentSchedulingRunnable

Filters the event times to only include times where the symbol's market is considered open

at

at(
    hour: int, minute: int, time_zone: Any
) -> IFluentSchedulingRunnable
at(
    hour: int, minute: int, second: int, time_zone: Any
) -> IFluentSchedulingRunnable
at(
    time_of_day: timedelta, time_zone: Any
) -> IFluentSchedulingRunnable
at(
    hour: int, minute: int, second: int = 0
) -> IFluentSchedulingRunnable
at(time_of_day: timedelta) -> IFluentSchedulingRunnable

Signature descriptions:

  • Creates events that fire at the specified time of day in the specified time zone

  • Creates events that fire at the specific time of day in the algorithm's time zone

after_market_open

after_market_open(
    symbol: Union[Symbol, str, BaseContract],
    minutes_after_open: float = 0,
    extended_market_open: bool = False,
) -> IFluentSchedulingRunnable

Creates events that fire a specified number of minutes after market open

before_market_close

before_market_close(
    symbol: Union[Symbol, str, BaseContract],
    minute_before_close: float = 0,
    extended_market_close: bool = False,
) -> IFluentSchedulingRunnable

Creates events that fire a specified numer of minutes before market close

every

every(interval: timedelta) -> IFluentSchedulingRunnable

Creates events that fire on a period define by the specified interval

where

where(
    predicate: Callable[[datetime], bool],
) -> IFluentSchedulingTimeSpecifier

Filters the event times using the predicate