Get required balances to start bot

Description: 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.

Permission: BOTS_READ Security: SIGNED

GET

/ver1/grid_bots/{id}/required_balances

Path Parameters

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

Parameters response

missing_balance object [TBD]

base object Details of the missing amount in the base currency

quantity string The amount of the base currency that is missing

currency string The name or symbol of the base currency

quote object Details of the missing amount in the quote currency

quantity string The amount of the quote currency that is missing

currency string The name or symbol of the quote currency

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

base object Details of the required amount in the base currency

quantity string The total amount of the base currency required

currency string The name or symbol of the base currency

quote object Details of the required amount in the quote currency

quantity string The total amount of the quote currency required

currency string The name or symbol of the quote currency

need_balancing boolean Indicates whether additional funds are required to balance the Grid Bot (true) or not (false)

balancing_available boolean Indicates whether the bot can be balanced with the current available funds (true) or not (false)

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

quantity string The specific amount of the required currency needed to balance the bot

currency string The symbol of the currency required for balancing

Example Request

GET /ver1/grid_bots/12345678/required_balances

Example Response and errors

Status: 200 OK

```json { "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" } } ```

Status: 404 Not Found

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

Status: 500 Internal Server Error

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