Required balances for launch

GET

/ver1/grid_bots/:id/required_balances

Permission: BOTS_READ

Security: SIGNED

Returns the amount of funds required to launch the Grid Bot and details about the current balance state.

This endpoint works only for the spot exchange.

---

Path Parameter

idintegerrequired

Unique 3Commas ID for this Grid Bot entity.

Example Request

GET

/ver1/grid_bots/12345678/required_balances

Response Parameters

missing_balanceobject

The amount of funds missing in the base and quote currencies for the Grid Bot to operate as intended.

Hide child parametersShow child parameters

baseobject

Details of the missing amount in the base currency.

Hide child parametersShow child parameters

quantitystring

The amount of the base currency that is missing

currencystring

The name or symbol of the base currency.

quoteobject

Details of the missing amount in the quote currency.

Hide child parametersShow child parameters

quantitystring

The amount of the quote currency that is missing.

currencystring

The name or symbol of the quote currency.

required_balanceobject

The total amount of funds required in base and quote currencies to launch the Grid Bot.

Hide child parametersShow child parameters

baseobject

Details of the required amount in the base currency.

Hide child parametersShow child parameters

quantitystring

The total amount of the base currency required.

currencystring

The name or symbol of the base currency.

quoteobject

Details of the required amount in the quote currency.

Hide child parametersShow child parameters

quantitystring

The total amount of the quote currency required.

currencystring

The name or symbol of the quote currency.

need_balancingboolean

Indicates whether additional funds are required to balance the Grid Bot true or not false.

balancing_availableboolean

Indicates whether the bot can be balanced with the current available funds true or not false.

necessary_quantitiesobject

Details of the exact amount and currency required to balance the Grid Bot.

Hide child parametersShow child parameters

quantitystring

The specific amount of the required currency needed to balance the bot.

currencystring

The symbol of the currency required for balancing.

Example Responses

200 OK

{
  "missing_balance": {
    "base": {
      "quantity": "0.0",
      "currency": "BTC"
    },
    "quote": {
      "quantity": "8500.0",
      "currency": "USDT"
    }
  },
  "required_balance": {
    "base": {
      "quantity": "2.0",
      "currency": "BTC"
    },
    "quote": {
      "quantity": "18500.0",
      "currency": "USDT"
    }
  },
  "need_balancing": true,
  "balancing_available": true,
  "necessary_quantities": {
    "quantity": "8500.0",
    "currency": "USDT"
  }
}

404 Not Found

{
  "error": "not_found",
  "error_description": "Not Found"
}

500 Internal Server Error

{
  "error": "grid_lines_not_marked",
  "error_description": "Grid lines empty or not marked"
}