Edit DCA Bot

PATCH

/ver1/bots/:bot_id/update

Permission: BOTS_WRITE

Security: SIGNED

Edits an existing DCA Bot using its ID.

---

Path Parameter

bot_idintegerrequired

Unique 3Commas ID for this DCA Bot entity.

Body Parameters

namestringrequired

DCA Bot name specified by the user.

pairsstringrequired

Trading pair(s) in 3Commas format. Use endpoint All market pairs to get value for parameter.

take_profitnumberrequired

Percentage value for the bot’s Take Profit.

If multiple steps are specified in take_profit_steps settings, this parameter should be set to 0.

More attributes

max_active_dealsboolean

base_order_volume_typenumber

base_order_volumenumberrequired

take_profit_stepsarray[object]

safety_order_volumenumberrequired

safety_order_volume_typestring

martingale_volume_coefficientnumberrequired

martingale_step_coefficientnumberrequired

max_safety_ordersintegerrequired

active_safety_orders_countintegerrequired

stop_loss_percentagenumber

sl_to_breakeven_enabledboolean

sl_to_breakeven_datajson

cooldownnumber

trailing_enabledboolean

trailing_deviationnumberrequired

safety_order_step_percentagenumberrequired

take_profit_typestringrequired

strategy_listarray[json]required

leverage_typestring

leverage_custom_valuenumber

stop_loss_timeout_enabledboolean

stop_loss_timeout_in_secondsinteger

tsl_enabledboolean

min_volume_btc_24hnumber

deal_start_delay_secondsinteger

profit_currencystring

start_order_typestring

stop_loss_typestring

disable_after_deals_countinteger

allowed_deals_on_same_pairinteger

min_profit_percentagenumber

min_profit_typestring

close_strategy_listarray[json]

risk_reduction_percentagenumber

reinvesting_percentagenumber

min_price_percentagenumber

max_price_percentagenumber

close_deals_timeoutinteger

Additional Information

leverage_custom_value

Use endpoints Currency rates and limits with leverage data to check available value for this parameter.

---

take_profit_steps

When using multiple steps for Take Profit, each step should be represented as an object with the following properties:

• amount_percentage
• profit_percentage

Keep in mind, you can create a maximum of 4 targets, allocating 100% of your position volume is allocated across them

---

{
  "take_profit_steps": [
    {
      "amount_percentage": 50,
      "profit_percentage": 10
    },
    {
      "amount_percentage": 50,
      "profit_percentage": 20
    }
  ] 
}

---

strategy list, close_strategy_list, safety_strategy_list

The data strategies are used to populate the strategy_list and close_strategy_list parameters. You can retrieve the full list of strategies available for this DCA Bot through the Available strategy list for bot endpoint.

Below are several examples demonstrating how to fill these parameters with strategy data:

Manual signals

[
  {
    "strategy": "manual"
  }
]

or

[]

Non-stop

[
  {
    "strategy": "nonstop"
  },
  {
    "options": {}
  }
]

It's using only for 1 pair bot.

TradingView

[
  {
    "options": {
      "time": "5m",
      "type": "buy_or_strong_buy"
    },
    "strategy": "trading_view"
  }
]

RSI

[
  {
    "options": {
      "time": "5m",
      "points": 30,
      "trigger_condition": "less",
      "time_period": 7
    },
    "strategy": "rsi"
  }
] 

Example Request

PATCH

/ver1/bots/12345678/update

{
  "account_id": 32199203,
  "name": "name DCA Bot",
  "pairs": "USDT_ETH",
  "strategy_list": [
    {
      "options": {},
      "strategy": "nonstop"
    }
  ],
  "base_order_volume": "100.0",
  "take_profit_type": "total",
  "take_profit": null,
  "take_profit_steps": [
    {
      "amount_percentage": 50,
      "profit_percentage": 10
    },
    {
      "amount_percentage": 50,
      "profit_percentage": 20
    }
  ],
  "stop_loss_percentage": "8",
  "close_deals_timeout": "100",
  "max_safety_orders": 3,
  "active_safety_orders_count": 3,
  "safety_order_volume": "20.0",
  "safety_order_step_percentage": "1.0",
  "min_profit_type": null,
  "martingale_volume_coefficient": "2",
  "martingale_step_coefficient": "2"
}

Response Parameters

If successful, the response includes a copy of DCA Bot entity.

Example Responses

200 OK

{
  "id": 15656489,
  "account_id": 32199203,
  "is_enabled": false,
  "max_safety_orders": 3,
  "active_safety_orders_count": 3,
  "pairs": [
    "USDT_ETH"
  ],
  "strategy_list": [
    {
      "options": {},
      "strategy": "nonstop"
    }
  ],
  "close_strategy_list": [],
  "safety_strategy_list": [],
  "max_active_deals": 1,
  "active_deals_count": 0,
  "deletable?": true,
  "created_at": "2024-11-19T21:04:11.299Z",
  "updated_at": "2024-11-21T15:22:24.557Z",
  "trailing_enabled": null,
  "tsl_enabled": false,
  "deal_start_delay_seconds": null,
  "stop_loss_timeout_enabled": false,
  "stop_loss_timeout_in_seconds": 0,
  "disable_after_deals_count": null,
  "deals_counter": null,
  "allowed_deals_on_same_pair": null,
  "easy_form_supported": false,
  "close_deals_timeout": 100,
  "url_secret": "...",
  "take_profit_steps": [
    {
      "amount_percentage": 50,
      "profit_percentage": 10,
      "id": 0
    },
    {
      "amount_percentage": 50,
      "profit_percentage": 20,
      "id": 1
    }
  ],
  "name": "name DCA Bot",
  "take_profit": null,
  "min_profit_percentage": null,
  "base_order_volume": "100.0",
  "safety_order_volume": "20.0",
  "safety_order_step_percentage": "1.0",
  "take_profit_type": "total",
  "min_profit_type": null,
  "type": "Bot::SingleBot",
  "martingale_volume_coefficient": "2.0",
  "martingale_step_coefficient": "2.0",
  "stop_loss_percentage": "8.0",
  "cooldown": "0",
  "btc_price_limit": "0.0",
  "strategy": "long",
  "min_volume_btc_24h": "0.0",
  "profit_currency": "quote_currency",
  "min_price": null,
  "max_price": null,
  "stop_loss_type": "stop_loss",
  "safety_order_volume_type": "quote_currency",
  "base_order_volume_type": "quote_currency",
  "account_name": "Paper Account 1251857",
  "trailing_deviation": "0.2",
  "finished_deals_profit_usd": "0.0",
  "finished_deals_count": "0",
  "leverage_type": "not_specified",
  "leverage_custom_value": null,
  "start_order_type": "limit",
  "active_deals_usd_profit": "0.0",
  "reinvesting_percentage": null,
  "risk_reduction_percentage": null,
  "reinvested_volume_usd": null,
  "min_price_percentage": null,
  "max_price_percentage": null
}

400 Bad Request

{
  "error": "record_invalid",
  "error_description": "Invalid parameters",
  "error_attributes": {
    "stop_loss_percentage": [
      "Stop Loss should be below the last safety order (7.0)"
    ]
  }
}