GET

/api/v1/bots/grid/:id/required_balances

Permission: BOTS_READSecurity: SIGNED

Returns the amount of funds required to launch the Grid Bot and details about the current balance state. This endpoint works only for spot exchanges.

Note: This endpoint is applicable exclusively to Spot exchange accounts.

Path Parameters

idinteger required

Unique Quentrade ID for this Grid Bot entity. Example: 12345678

Response Parameters

missing_balanceobject

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

baseobject

Details of the missing amount in the base currency [quantity: string, currency: string].

quoteobject

Details of the missing amount in the quote currency [quantity: string, currency: string].

required_balanceobject

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

baseobject

Details of the required amount in the base currency [quantity: string, currency: string].

quoteobject

Details of the required amount in the quote currency [quantity: string, currency: string].

need_balancingboolean

Indicates whether additional funds or order rebalancing are required to launch the Grid Bot (true or false).

balancing_availableboolean

Indicates whether the bot can be automatically balanced with the current available funds on the exchange (true or false).

necessary_quantitiesobject

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

quantitystring

The specific amount of currency needed to balance the bot.

currencystring

The symbol of the currency required for balancing (e.g. USDT).

Example Request

GETGET /api/v1/bots/grid/12345678/required_balances

Example Responses

If successful, returns HTTP 200 with the required balance calculations.

required_balances_for_launch_200.json

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"
  }
}

PREVIOUS Set a note to Grid Bot NEXTGrid Bot events