Ctrl+K

Get maximum spendable

get/api/v2/{coin}/wallet/{walletId}/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.

Path Parameters

  • coinstringRequired
    A cryptocurrency or token ticker symbol.
    Example: btc
  • walletIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

Query Parameters

  • enforceMinConfirmsForChangeboolean
    Enforces `minConfirms` on change inputs
  • feeRateinteger
    Minimum: >= 0
  • limitintegerDefault: 25
    Maximum number of results to return. If the result set is truncated, use the `nextBatchPrevId` value to get the next batch.
    Minimum: >= 1
    Maximum: <= 500
  • maxFeeRateinteger
    Minimum: >= 0
  • maxValuestring or integer
    Maximum value of each unspent in base units (e.g. satoshis). For doge, only string is allowed.
  • minConfirmsinteger
    Minimum number of confirmations for the collected inputs. Only applies to external unspents. Use `enforceMinConfirmsForChange` to filter change as well.
    Minimum: >= 0
  • minHeightnumber
    Minimum block height of the unspents
    Minimum: >= 0
  • minValuestring or integer
    Minimum value of each unspent in base units (e.g. satoshis). For doge, only string is allowed.
  • numBlocksintegerDefault: 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`.
    Minimum: >= 1
    Maximum: <= 1000
  • unspentIdsarray[string]
    Example: 003f688cc349f1fca8ac5ffa21671ca911b6ef351085c60733ed8c2ebf162cb8:2

200 Response

coin string
A cryptocurrency or token ticker symbol.
Example: btc
maximumSpendable string
Example: 19948310

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

404 Response

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