Vaults

Get max spendable amount in a transaction

UTXO assets only.

Retrieve the maximum amount of the specified asset that can be spent in a single transaction from the specified vault account.

Endpoint Permissions: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

get/vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amount

Request

Path parameters

vaultAccountIdstring numeric required

The ID of the vault account

assetIdstring required

The ID of the asset

Query parameters

manualSigngingboolean

False by default. The maximum number of inputs depends if the transaction will be signed by an automated co-signer server or on a mobile device.

includeAllLabelsstring[]

Only include UTXOs that have ALL of these labels (AND logic). Requires the UTXO Manager.

includeAnyLabelsstring[]

Only include UTXOs that have ANY of these labels (OR logic). Requires the UTXO Manager.

excludeAnyLabelsstring[]

Exclude UTXOs that have ANY of these labels. Requires the UTXO Manager.

addressstring

Only include UTXOs from this specific address. Requires the UTXO Manager.

minAmountstring

Minimum UTXO amount in the asset's base unit. Requires the UTXO Manager.

maxAmountstring

Maximum UTXO amount in the asset's base unit. Requires the UTXO Manager.

Response

OK

maxSpendableAmountstring

The maximum amount that can be spent from the vault account

Changes

No recorded changes to this operation across all 1 revision of this API.