Skip to main content
POST
Kill trading for a scope within the caller's hierarchy

Body

application/json
api_key
string | null

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.

firm_id
string | null

Id of the firm whose trading to stop, as a canonical decimal string. Must be your own firm, or a firm under your FCM.

Example:

"298471892342"

fcm_id
string | null

Id of your own FCM, as a canonical decimal string. Only FCM-level API keys may use this scope.

cancel_only
boolean | null

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.

Example:

false

Response

Kill switch applied

cancel_only
boolean
required

Echo of cancel_only from the request. Always false for an unlock.

Example:

false

locked
boolean
required

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.

Example:

true

num_orders_canceled
integer<int32>
required

Number of active orders canceled. Always 0 for an unlock.

Example:

1

scope
string

Scope the request applied to: API_KEY, FIRM, or FCM.

Example:

"FIRM"

scope_id
string

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.

Example:

"298471892342"