Skip to main content

Controls fields

Returned by GET Controls. W means you can change it with PATCH Controls; R means read-only.

FieldTypeAccessConstraintsDescription
killSwitchbooleanRChange it with PUT Kill SwitchWhen true, every incoming webhook signal is rejected, closing signals included
closingOnlybooleanWWhen true, opening signals are blocked. Signals that flatten first are turned into closes
tradingWindowobjectWDays and hours when webhook signals are accepted
tradingWindow.daysarray of sun mon tue wed thu fri satWUnique. Returned in week orderDays signals are accepted. An empty array turns the window off
tradingWindow.startstring HH:MM or nullWA 5-minute mark. Required when days is not emptyWindow start, New York time
tradingWindow.endstring HH:MM or nullWA 5-minute mark, different from start. Required when days is not empty. Earlier than start means the window runs past midnightWindow end, New York time
tradingWindow.closingOnlyAfterstring HH:MM or nullWA 5-minute mark strictly inside the window (between start and end, across midnight when end is earlier); null turns it offFrom this time until end, opening signals are blocked
monitorLockbooleanWMonitor Lock. While on, a monitor that reached a limit today cannot be edited, restarted or deleted until the 5:00 to 6:00 PM ET window. You can turn it off at any time
enhancedClosingOnlybooleanWNinjaTrader onlyThe add-on enforces each monitor's Closing Only itself, including orders placed by hand

The checks that end differs from start and that closingOnlyAfter falls inside the window apply even while days is empty, because saved times take effect as soon as you add a day. A PATCH may include killSwitch only with its saved value (it is ignored); a different value returns 422 use_kill_switch_endpoint.