Back to builder reference
Condition
calendar_scheduleentryexit
Periodic schedule (daily, weekly, monthly). Also the way to trigger once at an exact wall-clock time in a named timezone (time + tz, e.g. every='1d', time='10:30', tz='America/New_York'), including on 24/7 assets.
Category
Time & events
Discriminator
kind = "calendar_schedule"
Roles
entry, exit
Required fields
FieldTypeDescription
everyreqenum: 1d, 1w, 2w, 1m, 3mCalendar interval. '2w' fires on the target weekday of even ISO weeks (an absolute epoch, never chained off the last firing).Optional fields
FieldTypeDescription
dayanyOf (2 variants)Day of week (required for '1w' and '2w' schedules)holiday_policyenum: next_session, skip, previous_sessionWhat happens when an occurrence lands on a non-trading day (exchange holiday or weekend) for calendar-backed (equity) markets. 'next_session' (default): fire on the first bar of the next trading session. 'skip': drop that occurrence entirely. 'previous_session': fire on the last trading session before the scheduled day. Ignored for 24/7 (crypto) markets, where every day trades.kindstring-timeanyOf (2 variants)Time of day in HH:MM 24-hour format, interpreted in the exchange session timezone unless 'tz' names another one — the same rule at_time follows. Leave unset to fire at the session's own open.tzanyOf (2 variants)IANA timezone name for 'time'. Omit (the default) to use the exchange session timezone (US equities: America/New_York; crypto: UTC), which is what at_time does. Set it only to pin a time to a zone other than the one the symbol trades in.