Protection and exits

set_protectionCopy Anchor Link

Set stop_loss, take_profit, breakeven, trailing and R-ratchet on a position in one call. A stop is never widened unless allow_widen:true and never removed unless allow_remove:true. The response states native vs worker protection for each leg. dry_run defaults to true: nothing is sent to the exchange until dry_run:false is passed explicitly. Responses on a simulated connection carry mode:"simulated". Requires the trade capability (Pro and above; simulated connections may trade on every tier).

Capability: trade · mutating · REST: POST /v1/tools/set_protection

Example request:

{
  "position_uid": "<position_uid>",
  "dry_run": true
}

modify_positionCopy Anchor Link

Alias of set_protection for stop_loss/take_profit only. Never widens a stop unless allow_widen:true. Accepts lease_token and expect_stop_loss/expect_take_profit/expect_amount_base (PRECONDITION_FAILED when the position changed). dry_run defaults to true: nothing is sent to the exchange until dry_run:false is passed explicitly. Requires the trade capability (Pro and above; simulated connections may trade on every tier).

Capability: trade · mutating · REST: POST /v1/tools/modify_position

Example request:

{
  "position_uid": "<position_uid>",
  "dry_run": true
}

set_breakevenCopy Anchor Link

Alias of set_protection{breakeven}: move the stop to entry (plus buffer_bps) once the position is in profit; POSITION_NOT_IN_PROFIT otherwise. Accepts lease_token and expect_stop_loss/expect_take_profit/expect_amount_base (PRECONDITION_FAILED when the position changed). dry_run defaults to true: nothing is sent to the exchange until dry_run:false is passed explicitly. Requires the trade capability (Pro and above; simulated connections may trade on every tier).

Capability: trade · mutating · REST: POST /v1/tools/set_breakeven

Example request:

{
  "position_uid": "<position_uid>",
  "dry_run": true
}

set_trailing_stopCopy Anchor Link

Alias of set_protection{trailing}. State persists across restarts (native trailing where the exchange supports it, otherwise a server-side worker). Accepts lease_token and expect_stop_loss/expect_take_profit/expect_amount_base (PRECONDITION_FAILED when the position changed). dry_run defaults to true: nothing is sent to the exchange until dry_run:false is passed explicitly. Requires the trade capability (Pro and above; simulated connections may trade on every tier).

Capability: trade · mutating · REST: POST /v1/tools/set_trailing_stop

Example request:

{
  "position_uid": "<position_uid>",
  "dry_run": true
}

get_trailing_statusCopy Anchor Link

Trailing stops on this connection (or one position_uid): configuration, mode native|worker, activation, and the current stop. order:"newest_first". Available on every tier.

Capability: read · read-only · REST: POST /v1/tools/get_trailing_status

Example request:

{}

cancel_trailing_stopCopy Anchor Link

Retire the server's trailing stop on a position; the current stop stays where it is. Alias of set_protection{trailing:{off:true}}. Accepts lease_token and expect_stop_loss/expect_take_profit/expect_amount_base (PRECONDITION_FAILED when the position changed). dry_run defaults to true: nothing is sent to the exchange until dry_run:false is passed explicitly. Requires the trade capability (Pro and above; simulated connections may trade on every tier).

Capability: trade · mutating · REST: POST /v1/tools/cancel_trailing_stop

Example request:

{
  "position_uid": "<position_uid>",
  "dry_run": true
}