API References

Get maximum spendable

get
https://app.bitgo-test.com/api/v2//wallet//maximumSpendable

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

A cryptocurrency or token ticker symbol.

string
required

The wallet ID.

Query Params
boolean

Enforces minConfirms on change inputs

integer
≥ 0
integer
1 to 500
Defaults to 25

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

integer
≥ 0

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

integer
≥ 0

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

number
≥ 0

Minimum block height of the unspents

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

integer
1 to 1000
Defaults to 2

(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.

unspentIds
array of objects
length ≥ 1
unspentIds

The id of the unspent in the form :<tx_index>

Responses

Updated 4 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago