HALT trading over a deployment, an account, or everything this user runs. Halting is not closing — open positions stay open (scope: trading:write)

Risk-reducing only. Nothing on the trading surface can open a position, place a resting order, or move funds. Rate-limited to 30 live-account actions per minute per user.

post/v1/trading/kill-switch

Request

  • Base URL: https://app.texttoquant.com/api
  • URL: https://app.texttoquant.com/api/v1/trading/kill-switch
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

scopeType'user' | 'deployment' | 'connection' | 'global' required

"global" is admin-only and is refused for an API key.

scopeIdstring uuid

Required for deployment and connection scope; authorized against the caller.

reasonstring

Response

Success

successtrue required
dataobject required

Changes

No recorded changes to this operation across all 1 revision of this API.