Kill trading for a scope within the caller's hierarchy
Cancels the active orders of one scope within your own hierarchy and locks it against new orders. Requires an FCM- or FIRM-level API key with the RISK_MANAGEMENT permission.
Body
API key whose trading to stop. Send exactly one of api_key, firm_id, or fcm_id. The key must be within your own firm or FCM.
Id of the firm whose trading to stop, as a canonical decimal string. Must be your own firm, or a firm under your FCM.
"298471892342"
Id of your own FCM, as a canonical decimal string. Only FCM-level API keys may use this scope.
If true, cancel the scope's active orders without locking it, so new orders are still accepted. If false or omitted, the scope is also locked against new orders.
false
Response
Kill switch applied
Echo of cancel_only from the request. Always false for an unlock.
false
True when this request locked the scope against new orders. False for a cancel-only request and for an unlock. While a scope is locked, cancels and reads still work.
true
Number of active orders canceled. Always 0 for an unlock.
1
Scope the request applied to: API_KEY, FIRM, or FCM.
"FIRM"
Id of the target, as a canonical decimal string: the API key's user id for API_KEY scope, otherwise the firm or FCM id.
"298471892342"