POST

Consolidate unspents (advanced)

Build a transaction to consolidate unspents in a wallet. Once built, you must sign and sent the transaction. Consolidating unspents is only for UTXO-based assets.

Path Params

coin string required

A cryptocurrency or token ticker symbol.
walletId string required

The wallet ID.

matches ^[0-9a-f]{32}$

Body Params

object

feeRate string or integer

Custom fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte.

If the feeRate is less than the minimum required network fee, then the minimum fee applies. For example, 1000 sat/kvByte, a flat 1000 microAlgos, or a flat 10 drops of xrp. For XRP, the actual fee is usually 4.5 times the open ledger fee.

Note: The feeRate overrides the maxFeeRate and minFeeRate.
maxFeeRate string or integer

(BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The maxFeeRate limits the fee rate generated by both feeMultiplier and numBlocks.

Note: The feeRate overrides the maxFeeRate.
maxFeePercentage integer

Maximum relative portion that can be spent towards fees
feeTxConfirmTarget integer

Block target for fee estimation
bulk boolean

Build multiple transactions at the same time. This enables you to increase the maximum number of unspents on the limit parameter up to 2,000. If true, you must pass the txFormat as psbt and you can't pass the targetAddress or numUnspentsToMake parameters.
minValue string or integer

Minimum value of unspents to use in base units (e.g. satoshis). Can be used to skip very small unspents when consolidating at higher fee rates. For doge, only string is allowed.
maxValue string or integer

Maximum value of unspents to use in base units (e.g. satoshis). Should be used to prevent larger unspents from being consolidated needlessly, and that some funds remain available for spending while the consolidation transactions are in flight. For doge, only string is allowed.
minHeight integer

Minimum height of unspents on the block chain to use
minConfirms integer

Minimum confirmation threshold for external inputs
enforceMinConfirmsForChange boolean

Flag for enforcing minConfirms for change inputs
limit integer

Maximum number of unspents to use in the transaction
numUnspentsToMake integer

Number of new unspents to make
targetAddress string

address to use for generated outputs. Must be wallet address.
txFormat string enum

[UTXO only] Format of the returned transaction hex serialization. legacy for serialized transaction in custom bitcoinjs-lib format. psbt for BIP174 serialized transaction

Defaults to legacy

legacypsbtpsbt-lite

Responses

200

Response Body

object

txHex string
txInfo object

txInfo (UTXO)
txInfo object
- changeAddresses array of strings
- nOutputs integer
  
  Number of outputs
- nP2SHInputs integer
- nSegwitInputs integer
- unspents array of objects
  unspents object
  - id string
    
    The id of the unspent in the form :<tx_index>
  - address string
    
    The address of this unspent
  - value integer
  - valueString string
    
    matches ^-?\d+$
  - blockHeight integer
    
    The block this Unspent was created in
  - date string date-time
    
    The date this unspent was created
  - coinbase boolean
    
    True if this unspent came from the coinbase transaction
  - wallet string
    
    matches ^[0-9a-f]{32}$
  - fromWallet string
    
    matches ^[0-9a-f]{32}$
  - chain integer
    
    The type of this unspent's address (P2SH, P2WSH, etc...)
  - index integer
    
    A monotonic counter used when creating new addresses
  - redeemScript string
    
    The Script program used to cryptographically verify spending this unspent
  - witnessScript string
    
    The segwit Script program used to cryptographically verify spending this unspent
  - isSegwit boolean
- walletAddressDetails object
  walletAddressDetails object
  - id string
    
    platform public id for an address
  - address string
    
    up to 500 characters
  - chain integer enum
    
    011011202130314041
  - index integer
  - coin string
  - lastNonce integer
    
    Defaults to -1
  - wallet string
    
    The wallet which contains this address
  - coinSpecific object
    
    Properties which are specific to certain coin types
    
    coinSpecific object
    
    xlm object
    
    xlm object
    
    memoId string
    
    Latest memo id generated for the wallet
    
    rootAddress string
    
    Root address of the wallet
    
    txlm object
    
    txlm object
    
    Same shape as AddressCoinSpecificXlm.
  - balance object
    
    Balance of the address. In case of Eth and Celo, if returnBalancesForToken is passed with includeBalances, then it will return token balance in the address object. This field will be present only when includeBalances query param is passed as true.
    
    balance object
    
    updated string date-time
    
    The last time a transaction affected the balance of this address
    
    balance integer
    
    The cleared balance of the address
    
    balanceString string
    
    String representation of balance. Guaranteed to not lose precision.
    
    totalReceived integer
    
    The total amount received on this address (in the chain's base unit)
    
    totalSent integer
    
    The total amount send from this address (in the chain's base unit)
    
    confirmedBalanceString string
    
    The total balance of confirmed transactions for the address (in the chain's base unit). Guaranteed to not lose precision.
    
    spendableBalanceString string
    
    The total balance of the address (in the chain's base unit) which may be used as inputs for creating new transactions in string representation. Guaranteed to not lose precision.
  - label string nullable
    
    A human-readable label for the address.
    
    up to 250 characters
  - addressType string enum
    
    p2shp2shP2wshp2wshp2trp2trMusig2
feeInfo object

feeInfo (UTXO)
feeInfo object
- size integer
  
  Estimated size of the transaction in bytes
- fee integer
  
  Estimated fee in base unit for the transaction
- feeRate string or integer
  
  Custom minimum fee rate in a coin's base unit per kilobyte (or virtual kilobyte)--for example, satoshis per kvByte or microAlgos per kByte. If the applied feeRate does not meet a coin's required minimum transaction fee amount, the minimum is still applied (for example, 1000 sat/kvByte or a flat 1000 microAlgos).
- payGoFee integer
  
  BitGo fee of the transaction (in base units)
- payGoFeeString integer
  
  BitGo fee of the transaction (in base units) represented as a String

400

Bad Request

Response Body

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

error string required

Human-readable error message
requestId string required

Client request id
context object required
context object
- id string
  
  matches ^[0-9a-f]{32}$
name string enum required

Error code

InvalidWalletId

curl --request POST \ --url 'https://app.bitgo-test.com/api/v2/coin/wallet/walletId/consolidateUnspents' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{,"feeRate":10000,"maxFeeRate":20000,"maxFeePercentage":0,"feeTxConfirmTarget":0,"bulk":true,"minValue":"2000000","maxValue":"2000000","minHeight":0,"minConfirms":0,"enforceMinConfirmsForChange":true,"limit":0,"numUnspentsToMake":0,"targetAddress":"string","txFormat":"psbt"}'

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/v2/coin/wallet/walletId/consolidateUnspents") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["content-type"] = 'application/json' request.body = '{,"feeRate":10000,"maxFeeRate":20000,"maxFeePercentage":0,"feeTxConfirmTarget":0,"bulk":true,"minValue":"2000000","maxValue":"2000000","minHeight":0,"minConfirms":0,"enforceMinConfirmsForChange":true,"limit":0,"numUnspentsToMake":0,"targetAddress":"string","txFormat":"psbt"}' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('POST', 'https://app.bitgo-test.com/api/v2/coin/wallet/walletId/consolidateUnspents', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'content-type' => 'application/json', ], 'body' => '{,"feeRate":10000,"maxFeeRate":20000,"maxFeePercentage":0,"feeTxConfirmTarget":0,"bulk":true,"minValue":"2000000","maxValue":"2000000","minHeight":0,"minConfirms":0,"enforceMinConfirmsForChange":true,"limit":0,"numUnspentsToMake":0,"targetAddress":"string","txFormat":"psbt"}', ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/v2/coin/wallet/walletId/consolidateUnspents" payload = {,"feeRate":10000,"maxFeeRate":20000,"maxFeePercentage":0,"feeTxConfirmTarget":0,"bulk":true,"minValue":"2000000","maxValue":"2000000","minHeight":0,"minConfirms":0,"enforceMinConfirmsForChange":true,"limit":0,"numUnspentsToMake":0,"targetAddress":"string","txFormat":"psbt"} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "content-type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.text)

{ "txHex": "01000000000101d58f82d996dd872012675adadf4606734906b25a413f6e2ee535c0c10aef96020000000000ffffffff028de888000000000017a914c91aa24f65827eecec775037d886f2952b73cbe48740420f000000000017a9149304d18497b9bfe9532778a0f06d9fff3b3befaf870500473044022023d7210ba6d8bbd7a28b8af226f40f7235caab79156f93f9c9969fc459ea7f73022050fbdca788fba3de686b66b3501853695ff9d6f375867470207d233b099576e001000069522103d4788cda52f91c1f6c82eb91491ca76108c9c5f0839bc4f02eccc55fedb3311c210391bcef9dcc89570a79ba3c7514e65cd48e766a8868eca2769fa9242fdcc796662102ef3c5ebac4b54df70dea1bb2655126368be10ca0462382fcb730e55cddd2dd6a53aec8b11400", "txInfo": { "changeAddresses": [ "2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS" ], "nOutputs": 2, "nP2SHInputs": 0, "nSegwitInputs": 1, "unspents": [ { "id": "003f688cc349f1fca8ac5ffa21671ca911b6ef351085c60733ed8c2ebf162cb8:2", "address": "2MsKxhhkDo5WaLaYRGA9Cr3iSQPyXsu6Fi2", "value": 0, "valueString": "2000000", "blockHeight": 0, "date": "2017-03-25T23:01:40.248Z", "coinbase": true, "wallet": "59cd72485007a239fb00282ed480da1f", "fromWallet": "59cd72485007a239fb00282ed480da1f", "chain": 0, "index": 0, "redeemScript": "522102f1e990044d2a8be43d5b500bbdcb36277b97a4b07e01c5101ae8ec1568bfd6532103dab7dc82f2fc8c28200c1bdeca9c4cf181e0ca257395829cbd599395048afb57210205422e711827d8356f2fb75334d863941dd7eb45bd5788fa231dc5fa755135b653ae", "witnessScript": "52210351311cd81144e6cbdba561d24dfc22644cb02d053339d4beace03231b3be4f372103a8d0c1a375b9ee1a2411f9f8e18373be7f228b18260f63bbfca48809170ed08b2103c3bd8bd074657bbe9ee6714b31a4a54b6fd5b5cda0e1030122f9bf46b5034f6b53ae", "isSegwit": true } ], "walletAddressDetails": { "id": "59cd72485007a239fb00282ed480da1f", "address": "2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS", "chain": 1, "index": 0, "coin": "string", "lastNonce": -1, "wallet": "59cd72485007a239fb00282ed480da1f", "coinSpecific": { "xlm": { "memoId": "2000000", "rootAddress": "GCTTCPH4IIDK7P72FFAEJ3ZFN6WDHJH6GGMRPHPM56ZWGIQ7B3XTIJAM" }, "txlm": { "memoId": "2000000", "rootAddress": "GCTTCPH4IIDK7P72FFAEJ3ZFN6WDHJH6GGMRPHPM56ZWGIQ7B3XTIJAM" } }, "balance": { "updated": "string", "balance": 50000, "balanceString": "50000", "totalReceived": 0, "totalSent": 0, "confirmedBalanceString": "40000", "spendableBalanceString": "40000" }, "label": "Bob's Hot Wallet Address", "addressType": "p2sh" } }, "feeInfo": { "size": 776, "fee": 38800, "feeRate": 10000, "payGoFee": 0, "payGoFeeString": "0" } }