Consolidate account (advanced)

post/api/v2/{coin}/wallet/{walletId}/consolidateAccount/build

This endpoint, builds a consolidation transaction. Once built, you must sign and send the transaction. Consolidates the receive address balances to the root address of a wallet. Consolidation is limited to account-based assets. The spendable balance of a wallet is the balance of the funds in the root address. Therefore, funds from wallets with multiple receive addresses must be consolidated before sending.

Path Parameters

  • coinstringRequired
    This route is only available for Algorand, Tezos, and Eth.
    Enum: algo talgo xtz txtz eth gteth
  • walletIdstringRequired
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$

Request Body

consolidateAddresses array[string]
Optional: restrict the consolidation to the specified receive addresses. If not provided, will consolidate the funds from all receive addresses up to 500 addresses.
javascript
1 2 3 4 5 6 7 8 9 10 let params = { consolidateAddresses: [ 'BVMEUTF37WNEQ6GYCZISRFHGLEMOKT5OCPPTTJXVED6JBSXKF6YJJRZRI4', '7ITFVRNTLUHLD4F2PIIYXXIQOAJAPRGMA7JHSN3SFH2BACLK7WM6CHT524', ], }; wallet.consolidateAccount(params).then(function (transactions) { // print generated transactions for signing console.dir(transaction); });

200 Response

keyDerivationPath string

400 Response

One of
error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code