Positions

Flatten account: close positions and cancel orders

The full “panic button”: closes all open positions AND cancels all pending orders for the specified account(s).

Modes:

Single account: { "account_ids": ["uuid"] }
Multiple accounts: { "account_ids": ["uuid1", "uuid2"] }
All accounts: {} (empty body flattens everything)
Symbol-filtered: add "symbols": ["ESH6"] to only flatten specific contracts

If flattening causes the profit target to be met on any account, those accounts are marked as passed.

Returns a command acceptance. Requires x-idempotency-key header.

POST

trade

flatten

// Flatten everything for a specific account
const response = await fetch('/trade/flatten', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    account_ids: ['550e8400-e29b-41d4-a716-446655440000']
  })
});
const { data } = await response.json();
console.log(`Flattened: ${data.positions_closed} positions, ${data.orders_cancelled} orders`);

{
  "code": null,
  "data": {
    "accepted": true,
    "command_id": "0d9f3c1e-7c2a-4b53-9d21-8f6a2e4b7c90",
    "command_type": "Flatten",
    "status": "queued"
  },
  "error": null,
  "success": true
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

{
  "code": "LOCKOUT_ACTIVE",
  "data": null,
  "error": "Account is locked out until 2026-03-12T16:00:00Z (mode: timed, 45 minutes remaining)",
  "success": false
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

{
  "code": "RATE_LIMITED",
  "data": null,
  "error": "Rate limit exceeded for order submissions. Max 10 requests per second per account. Retry after 0.1 seconds.",
  "rate_limit": {
    "limit": 10,
    "remaining": 0,
    "reset": 1711800125,
    "retry_after": 0.1
  },
  "success": false
}

Body

application/json

Request to flatten account(s)

account_ids

string<uuid>[] | null

Optional: List of account UUIDs to flatten. If omitted, flattens ALL accounts. Can be a single account or multiple accounts.

Example:

["550e8400-e29b-41d4-a716-446655440000"]

reason

string | null

write-only

Internal: overrides the audit reason stamped on the flatten orders. Set by engine-initiated flattens (e.g. account lockout) that ride the same command path; clients should omit it.

symbols

string[] | null

Optional: List of contract symbols to flatten. If omitted, flattens ALL symbols. Examples: ["ESH6"], ["ESH6", "NQH6"], or omit for all symbols.

Example:

["ESH6", "NQH6"]

Response

Flatten command accepted

accepted

boolean

required

command_id

string<uuid>

required

command_type

string

required

status

string

required

⌘I

// Flatten everything for a specific account
const response = await fetch('/trade/flatten', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    account_ids: ['550e8400-e29b-41d4-a716-446655440000']
  })
});
const { data } = await response.json();
console.log(`Flattened: ${data.positions_closed} positions, ${data.orders_cancelled} orders`);

{
  "code": null,
  "data": {
    "accepted": true,
    "command_id": "0d9f3c1e-7c2a-4b53-9d21-8f6a2e4b7c90",
    "command_type": "Flatten",
    "status": "queued"
  },
  "error": null,
  "success": true
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

{
  "code": "LOCKOUT_ACTIVE",
  "data": null,
  "error": "Account is locked out until 2026-03-12T16:00:00Z (mode: timed, 45 minutes remaining)",
  "success": false
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

{
  "code": "RATE_LIMITED",
  "data": null,
  "error": "Rate limit exceeded for order submissions. Max 10 requests per second per account. Retry after 0.1 seconds.",
  "rate_limit": {
    "limit": 10,
    "remaining": 0,
    "reset": 1711800125,
    "retry_after": 0.1
  },
  "success": false
}

Platform API

Trade API

Market Data API

Flatten account: close positions and cancel orders

Body

Response