Emergency halt

Emergency halt is the firm’s kill switch. Activating it locks down trading for the firm and optionally enqueues a sim-account liquidation job. To lock, flatten, or cancel one account without halting the firm, use Per-account trading control. Halt already calls those same lock and flatten internals across every account. All halt routes are firm-scoped via X-Firm-ID (auto-injected for firm API keys) or an optional firm_id query parameter.

Get halt state

GET /v1/firm-control/emergency-halt

operationId: getEmergencyHalt

curl -sS "$TRADARA_BASE_URL/v1/firm-control/emergency-halt" \
  -H "X-Tradara-Api-Key: $TRADARA_API_KEY"

Response — `200 OK`

{
  "item": {
    "firm_id": "8f4a1d6e-2b1c-4e9a-9d3b-5e6c7a0d1f23",
    "active": false,
    "reason": ""
  }
}

Activate halt

POST /v1/firm-control/emergency-halt

operationId: activateEmergencyHalt Activates firm-wide halt and optionally enqueues sim-account liquidation. Returns an async job envelope.

Body

Field	Required	Notes
`reason`	yes	Free-form, stored on the audit record.
`liquidate_sim_accounts`	no	When `true`, enqueues liquidation of sim/eval accounts in the same job.

curl -X POST "$TRADARA_BASE_URL/v1/firm-control/emergency-halt" \
  -H "X-Tradara-Api-Key: $TRADARA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "reason": "venue outage", "liquidate_sim_accounts": true }'

Response — `202 Accepted`

{
  "job": {
    "id": "halt_01HW...",
    "firm_id": "8f4a1d6e-2b1c-4e9a-9d3b-5e6c7a0d1f23",
    "status": "RUNNING",
    "accounts_total": 142,
    "accounts_done": 0,
    "error_summary": null
  }
}

Release halt

POST /v1/firm-control/emergency-halt/release

operationId: releaseEmergencyHalt Releases an active halt and restores normal trading for the firm.

curl -X POST "$TRADARA_BASE_URL/v1/firm-control/emergency-halt/release" \
  -H "X-Tradara-Api-Key: $TRADARA_API_KEY"

Response — `200 OK`

{
  "item": {
    "firm_id": "8f4a1d6e-2b1c-4e9a-9d3b-5e6c7a0d1f23",
    "active": false,
    "reason": ""
  }
}

Get halt job

GET /v1/firm-control/emergency-halt/jobs?job_id={uuid}

operationId: getEmergencyHaltJob Polls progress of an emergency halt background job.

curl -sS "$TRADARA_BASE_URL/v1/firm-control/emergency-halt/jobs?job_id=halt_01HW..." \
  -H "X-Tradara-Api-Key: $TRADARA_API_KEY"

Response — `200 OK`

{
  "job": {
    "id": "halt_01HW...",
    "firm_id": "8f4a1d6e-2b1c-4e9a-9d3b-5e6c7a0d1f23",
    "status": "COMPLETED",
    "accounts_total": 142,
    "accounts_done": 142,
    "error_summary": null
  }
}

Errors

HTTP	Meaning
`400`	Missing `reason` or invalid `job_id`.
`502` / `503`	Downstream halt/accounts service unavailable.

Overview

Account Provisioning

Terminal Embed

Firm & Users

Staff & RBAC

Offerings & Acceptance

API Keys

Webhooks

Realtime WebSocket

Operations

Firm Backoffice Reads

Terminal Onboarding (JWT)

Get halt state

Response — `200 OK`

Activate halt

Body

Response — `202 Accepted`

Release halt

Response — `200 OK`

Get halt job

Response — `200 OK`

Errors

​Get halt state

​Response — 200 OK

​Activate halt

​Body

​Response — 202 Accepted

​Release halt

​Response — 200 OK

​Get halt job

​Response — 200 OK

​Errors

Get halt state

Response — `200 OK`

Activate halt

Body

Response — `202 Accepted`

Release halt

Response — `200 OK`

Get halt job

Response — `200 OK`

Errors