GET

Get maximum spendable

Returns the maximum amount that can be spent with a single transaction on the wallet.

The maximum spendable amount can differ from a wallet’s total balance. A transaction can only use up to 200 unspents. Wallets that have more than 200 unspents cannot spend the full balance in one transaction. Additionally, the value returned for the maximum spendable amount accounts for the current fee level by deducting the estimated fees. The amount will only be calculated based on the unspents that fit the parameters passed.

Path Params

coin string required

A cryptocurrency or token ticker symbol.
walletId string required

The wallet ID.

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

Query Params

enforceMinConfirmsForChange boolean

Enforces minConfirms on change inputs
feeRate integer

>= 0
limit integer

Maximum number of results to return. If the result set is truncated, use the nextBatchPrevId value to get the next batch.

>= 1 · <= 500

Defaults to 25
maxFeeRate integer

>= 0
maxValue string or integer

Maximum value of each unspent in base units (e.g. satoshis). For doge, only string is allowed.
minConfirms integer

Minimum number of confirmations for the collected inputs. Only applies to external unspents. Use enforceMinConfirmsForChange to filter change as well.

>= 0
minHeight number

Minimum block height of the unspents

>= 0
minValue string or integer

Minimum value of each unspent in base units (e.g. satoshis). For doge, only string is allowed.
numBlocks integer

(BTC only) The number of blocks required to confirm a transaction. You can use numBlocks to estimate the fee rate by targeting confirmation within a given number of blocks. If both feeRate and numBlocks are absent, the transaction defaults to 2 blocks for confirmation.

Note: The maxFeeRate limits the fee rate generated by numBlocks.

>= 1 · <= 1000

Defaults to 2
unspentIds array of strings

at least 1 items

Responses

200

Response Body

object

coin string

A cryptocurrency or token ticker symbol.
maximumSpendable 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

404

Not Found

Response Body

object

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

curl --request GET \ --url 'https://app.bitgo-test.com/api/v2/coin/wallet/walletId/maximumSpendable&enforceMinConfirmsForChange=true&feeRate=0?limit=25&maxFeeRate=0&maxValue=2000000&minConfirms=0&minHeight=0&minValue=2000000&numBlocks=2&unspentIds=' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

const url = 'https://app.bitgo-test.com/api/v2/coin/wallet/walletId/maximumSpendable&enforceMinConfirmsForChange=true&feeRate=0?limit=25&maxFeeRate=0&maxValue=2000000&minConfirms=0&minHeight=0&minValue=2000000&numBlocks=2&unspentIds='; const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/v2/coin/wallet/walletId/maximumSpendable&enforceMinConfirmsForChange=true&feeRate=0?limit=25&maxFeeRate=0&maxValue=2000000&minConfirms=0&minHeight=0&minValue=2000000&numBlocks=2&unspentIds=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://app.bitgo-test.com/api/v2/coin/wallet/walletId/maximumSpendable&enforceMinConfirmsForChange=true&feeRate=0?limit=25&maxFeeRate=0&maxValue=2000000&minConfirms=0&minHeight=0&minValue=2000000&numBlocks=2&unspentIds=', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/v2/coin/wallet/walletId/maximumSpendable&enforceMinConfirmsForChange=true&feeRate=0?limit=25&maxFeeRate=0&maxValue=2000000&minConfirms=0&minHeight=0&minValue=2000000&numBlocks=2&unspentIds=" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.get(url, headers=headers) print(response.text)