Edit Grid Bot

Description: Updates an existing Grid Bot using its ID

Permission: BOTS_WRITE Security: SIGNED

PATCH

/ver1/grid_bots/{id}/manual

Path Parameter

id integer required Unique 3Commas ID for this Grid Bot entity

Body Parameters

name integer Grid Bot name specified by the user

upper_price number required The maximum price of the trading range, above which the bot will not place sell orders

lower_price number required The maximum price of the trading range, above which the bot will not place sell orders

grid_quantity integer required The number of grid levels between the upper and lower price boundaries.

This value is limited based on the exchange’s rules for rates, limits, and leverage

grid_type string Type of Grid Bot configuration: geometric or arithmetic

quantity_per_grid number required Quantity of the asset allocated per Grid Bot level order

upper_stop_loss_enabled boolean required Indicates if upper stop-loss settings are enabled. Use true to activate the settings group

upper_stop_loss_action string The action to perform if the asset price reaches or exceeds the set upper stop-loss level: stop_bot, stop_bot_and_sell, stop_bot_and_close_position

upper_stop_loss_price number The price level that triggers the upper stop-loss action

lower_stop_loss_enabled boolean Indicates if lower stop-loss settings are enabled. Use true to activate the settings group

lower_stop_loss_action string The action to perform if the asset price reaches or falls below the set lower stop-loss level: stop_bot,stop_bot_and_sell, stop_bot_and_close_position

lower_stop_loss_price number The price level that triggers the lower stop-loss action

leverage_type string Type of leverage used for the futures account: cross,isolated

leverage_custom_value number Custom leverage value set for the Grid Bot

max_active_buy_lines integer Maximum number of active buy orders that can be placed simultaneously

max_active_sell_lines integer Maximum number of active sell orders that can be placed simultaneously

trailing_up_enabled boolean Indicates if the trailing-up feature is enabled (true or not (false)

trailing_down_enabled boolean Indicates if the trailing-down feature is enabled (true or not (false)

expansion_down_enabled boolean Indicates if the grid expansion downwards is enabled (true or not (false)

expansion_down_stop_price number The price at which the downward grid expansion should stop This parameter is required when expansion_down_enabled is set to true

expansion_up_enabled boolean Indicates if the grid expansion upwards is enabled (true or not (false)

expansion_up_stop_price number The price at which the upward grid expansion should stop. This parameter is required when expansion_up_enabled is set to true.

ignore_warnings boolean Ignores warnings and forces the creation of the Grid Bot (true) or not (false)

note integer Optional user-defined note for the Grid Bot. [1 ... 300] characters

Parameters response

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

Example Request

PATCH /ver1/grid_bots/2291725/manual

{
    "name": "CHANGED USDT_BTCUSDT EXAMPLE",
    "upper_price": 70000.0,
    "lower_price": 56000.0,
    "quantity_per_grid": 150,
    "grids_quantity": 40,
    "order_currency_type": "quote",
    "profit_currency_type": "quote",
    "trailing_up_enabled": true,
    "trailing_down_enabled": false,
    "grid_type": "arithmetic",
    "expansion_down_enabled": true,
    "expansion_down_stop_price": 54000.0,
    "expansion_up_enabled": false,
    "lower_stop_loss_enabled": true,
    "lower_stop_loss_price": 50000.0,
    "lower_stop_loss_action": "stop_bot_and_close_position",
    "upper_stop_loss_enabled": true,
    "upper_stop_loss_price": 75000.0,
    "upper_stop_loss_action": "stop_bot",
    "note": "Example bot",
    "leverage_type": "cross",
    "leverage_custom_value": 10,
    "mode": "long"
}

Example response and errors

Status: 200 OK

{"id"=>2291725,
 "account_id"=>12555712,
 "account_name"=>"Binance Futures",
 "is_enabled"=>false,
 "grids_quantity"=>"40",
 "created_at"=>"2024-07-17T15:03:24.406Z",
 "updated_at"=>"2024-07-17T15:14:16.852Z",
 "strategy_type"=>"manual",
 "upper_stop_loss_enabled"=>true,
 "lower_stop_loss_enabled"=>true,
 "note"=>"Example bot",
 "editable"=>false,
 "lower_price"=>"56000.0",
 "lower_stop_loss_price"=>"50000.0",
 "lower_stop_loss_action"=>"stop_bot_and_close_position",
 "upper_price"=>"70000.0",
 "upper_stop_loss_price"=>"75000.0",
 "upper_stop_loss_action"=>"stop_bot",
 "quantity_per_grid"=>"150.0",
 "leverage_type"=>"cross",
 "leverage_custom_value"=>"10.0",
 "name"=>"CHANGED USDT_BTCUSDT EXAMPLE",
 "pair"=>"USDT_BTCUSDT",
 "start_price"=>"65030.3",
 "grid_price_step"=>"358.974358974358974358974358974358974359",
 "current_profit"=>"0.0",
 "current_profit_usd"=>"0.0",
 "total_profits_count"=>"0",
 "bought_volume"=>"0.0",
 "sold_volume"=>"0.0",
 "profit_percentage"=>"0.0",
 "current_price"=>"65030.3",
 "max_active_buy_lines"=>"50",
 "max_active_sell_lines"=>"50",
 "order_currency_type"=>"quote",
 "profit_currency_type"=>"quote",
 "trailing_up_enabled"=>"true",
 "grid_type"=>"arithmetic",
 "investment_base_currency"=>"0.0",
 "investment_quote_currency"=>"0.0",
 "unrealized_profit_loss"=>"0.0",
 "current_profit_loss"=>nil,
 "current_profit_loss_percent"=>nil,
 "orderbook_price_currency"=>"USDT",
 "expansion_down_enabled"=>"true",
 "expansion_down_stop_price"=>"54000.0",
 "grid_lines"=>
  [{"id"=>253750913, "price"=>"64974.4", "side"=>nil, "order_placed"=>false},
   {"id"=>253750927, "price"=>"70000.0", "side"=>"sell", "order_placed"=>false},
   {"id"=>253750926, "price"=>"69641.0", "side"=>"sell", "order_placed"=>false},
   {"id"=>253750925, "price"=>"69282.1", "side"=>"sell", "order_placed"=>false},
   {"id"=>253750924, "price"=>"68923.1", "side"=>"sell", "order_placed"=>false},
   {"id"=>253750923, "price"=>"68564.1", "side"=>"sell", "order_placed"=>false},
   {"id"=>253750922, "price"=>"68205.1", "side"=>"sell", "order_placed"=>false},
   {"id"=>253750921, "price"=>"67846.2", "side"=>"sell", "order_placed"=>false},
   {"id"=>253750920, "price"=>"67487.2", "side"=>"sell", "order_placed"=>false},
   {"id"=>253750919, "price"=>"67128.2", "side"=>"sell", "order_placed"=>false},
   {"id"=>253750918, "price"=>"66769.2", "side"=>"sell", "order_placed"=>false},
   {"id"=>253750917, "price"=>"66410.3", "side"=>"sell", "order_placed"=>false},
   {"id"=>253750916, "price"=>"66051.3", "side"=>"sell", "order_placed"=>false},
   {"id"=>253750915, "price"=>"65692.3", "side"=>"sell", "order_placed"=>false},
   {"id"=>253750914, "price"=>"65333.3", "side"=>"sell", "order_placed"=>false},
   {"id"=>253750888, "price"=>"56000.0", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750889, "price"=>"56359.0", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750890, "price"=>"56717.9", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750891, "price"=>"57076.9", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750892, "price"=>"57435.9", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750893, "price"=>"57794.9", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750894, "price"=>"58153.8", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750895, "price"=>"58512.8", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750896, "price"=>"58871.8", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750897, "price"=>"59230.8", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750898, "price"=>"59589.7", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750899, "price"=>"59948.7", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750900, "price"=>"60307.7", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750901, "price"=>"60666.7", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750902, "price"=>"61025.6", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750903, "price"=>"61384.6", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750904, "price"=>"61743.6", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750905, "price"=>"62102.6", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750906, "price"=>"62461.5", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750907, "price"=>"62820.5", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750908, "price"=>"63179.5", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750909, "price"=>"63538.5", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750910, "price"=>"63897.4", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750911, "price"=>"64256.4", "side"=>"buy", "order_placed"=>false},
   {"id"=>253750912, "price"=>"64615.4", "side"=>"buy", "order_placed"=>false}]}