POST

Advanced Wallets - Consolidate Account

Build, sign, and send a consolidation transaction, all in one call. For account-based assets, consolidating the balances in the receive addresses to the base address maximizes the spendable balance of a wallet.

Retrieves the private key from KMS using the provided public key or common keychain, then signs and broadcasts the transaction.

Use this endpoint only with advanced wallets. For other wallet types, use Consolidate account (simple).

Path Params

walletId string required
coin string required

Body Params

object

source string enum required

The key to use for signing the transaction

userbackup
pubkey string

Public key of the key used for signing multisig transactions
consolidateAddresses array of strings
commonKeychain string

For TSS wallets, this is the common keychain of the wallet
apiVersion string enum

The Trasaction Request API version to use for MPC EdDSA Hot Wallets. Defaults based on the wallet type and asset curve.

fulllite

Responses

200

No response body

400

Bad Request

Response Body

object

error string required

The error name
details string required

Error details

404

Not Found

Response Body

object

error string required

The error name
details string required

Error details

409

Conflict

Response Body

object

error string required

The error name
details string required

Error details

422

Unprocessable Entity

Response Body

object

error string required

The error name
details string required

Error details

500

Internal Server Error

Response Body

object

error string required

The error name
details string required

Error details

501

Not Implemented

Response Body

object

error string required

The error name
details string required

Error details

curl --request POST \ --url 'http://localhost:3080/api/v1/coin/advancedwallet/walletId/consolidate' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{,"source":"user","pubkey":"string","consolidateAddresses":["string"],"commonKeychain":"string","apiVersion":"full"}'

const url = 'http://localhost:3080/api/v1/coin/advancedwallet/walletId/consolidate'; const options = { method: 'POST', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'content-type': 'application/json'}, body: JSON.stringify({,"source":"user","pubkey":"string","consolidateAddresses":["string"],"commonKeychain":"string","apiVersion":"full"}) }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("http://localhost:3080/api/v1/coin/advancedwallet/walletId/consolidate") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["content-type"] = 'application/json' request.body = '{,"source":"user","pubkey":"string","consolidateAddresses":["string"],"commonKeychain":"string","apiVersion":"full"}' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('POST', 'http://localhost:3080/api/v1/coin/advancedwallet/walletId/consolidate', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'content-type' => 'application/json', ], 'body' => '{,"source":"user","pubkey":"string","consolidateAddresses":["string"],"commonKeychain":"string","apiVersion":"full"}', ]); echo $response->getBody();

import requests url = "http://localhost:3080/api/v1/coin/advancedwallet/walletId/consolidate" payload = {,"source":"user","pubkey":"string","consolidateAddresses":["string"],"commonKeychain":"string","apiVersion":"full"} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "content-type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.text)