Grid Bot

Grid Bot entities are designed to automate trading strategies by executing a series of buy and sell orders within predefined price ranges. They allow users to take advantage of market fluctuations while minimizing manual intervention.

Grid Bot entities hold information such as:

• Configuration details for the bot, including the trading pair, strategy type, and grid settings;

• Performance metrics like current profit, total profits, and investment amounts in base and quote currencies;

• Status indicators, such as whether the bot is enabled or disabled and whether stop-loss actions are set.

  3Commas offers a range of tools to create new Grid Bots, manage their settings, and analyze their performance effectively.

  Attributes

  id integer Unique 3Commas ID for this Grid Bot entity

  account_id integer Unique 3Commas ID of this exchange account entity where this Grid Bot was created

  account_name string The name for the exchange account defined by the user

  is_enabled boolean Indicates if the Grid Bot is enabled

  grids_quantity string Number of grid lines set in the bot configuration

  created_at string ISO 8601 datetime string of when this Grid Bot was created

  updated_at string ISO 8601 datetime string of when this Grid Bot was last updated

  strategy_type string Strategy type for the bot (e.g., manual)

  upper_stop_loss_enabled boolean Shows if the upper stop-loss is enabled

  lower_stop_loss_enabled boolean Shows if the lower stop-loss is enabled

  note string Optional user-defined note about the Grid Bot

  editable boolean Indicates if the bot configuration can be edited

  lower_price string Lower price limit for the Grid Bot

  lower_stop_loss_price string Lower stop-loss price, if set

  lower_stop_loss_action string Action to take if the lower stop-loss is triggered (e.g., stop_bot)

  upper_price string Upper price limit for the Grid Bot

  upper_stop_loss_price string Upper stop-loss price, if set

  upper_stop_loss_action string Action to take if the upper stop-loss is triggered (e.g., stop_bot)

  quantity_per_grid string Quantity of the asset per grid line

  leverage_type string Shows the leverage type that was set when creating a Grid Bot (e.g., cross)

  leverage_custom_value string Custom leverage value set for the Grid Bot

  name string Name of the Grid Bot

  pair string Trading pair in 3Commas format for the bot

  start_price string Starting price of the asset when the bot was created

  grid_price_step string Price step value between each grid line

  current_profit string Current profit in base currency

  current_profit_usd string Current profit in USD

  total_profits_count string Total number of profitable transactions

  profit_percentage string Percentage profit relative to the starting investment

  current_price string Current price of the trading pair

  max_active_buy_lines string Maximum number of active buy orders allowed

  max_active_sell_lines string Maximum number of active sell orders allowed

  order_currency_type string Currency type used for orders (e.g., quote)

  profit_currency_type string Currency type used for profit calculation (e.g., quote)

  trailing_up_enabled boolean Shows if the trailing-up feature is enabled

  grid_type string Type of grid used (e.g., `geometric`)

  investment_base_currency string Investment amount in the base currency

  investment_quote_currency string Investment amount in the quote currency

  unrealized_profit_loss string Unrealized profit or loss in base currency

  current_profit_loss string Current profit or loss in base currency

  current_profit_loss_percent string Percentage of current profit or loss

  orderbook_price_currency string Currency used for the order book price

  expansion_down_enabled boolean Shows if the grid expansion downwards is enabled

  expansion_down_stop_price string Stop price for downward expansion, if set

  grid_lines object An array of grid line orders associated with this Grid Bot

  id integer ID of the Grid Line entity

  price string Price value of this grid line

  side string The order side for this grid line (e.g., `buy` or `sell`)

  order_placed boolean Indicates if the order for this grid line has been placed