Get wallet status
GET {{baseUrl}}/protocols/btc/wallets/:wallet
Returns relevant wallet metrics for the Bitcoin blockchain (i.a. BTC balance, wallet address). WaaS Bitcoin wallets use native SegWit addresses (e.g. bc1qqpjecr2zuvjgupsdufzgk3r7lxhp5nwm8sxvyf) for sending and receiving BTC.
The current wallet balance is based on the Bitcoin mining status of the unspent transaction outputs (UTXO
) and might differ based on the current tangany-tx-confirmations setting. The sum of all detected UTXO values represents the total BTC balance of any Bitcoin wallet. To include the return change of pending transactions in the total balance calculation set tangany-bitcoin-tx-confirmations: 0.
Wallets containing more than 100 utxo underly some restrictions. Refer to POST /protocols/btc/transactions/estimate for more information about utxo limits.
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
tangany-version | number | (Required) Default header that directs the request towards desired Tangany Custody Api version (e.g 2 directs to Tangany Custody APi v2). |
Supports only major versions. |
| tangany-network | string | | (Optional header) Defines the network to operate in - in the Bitcoin context.
Accepts supported network enums. Defaults to mainnet when omitted from the call.
Supported networks: mainnet, testnet3.
Example: testnet3 |
| tangany-utxo-confirmations | number | | (Optional header) Defines a secure amount of block confirmations required for Bitcoin balance outputs ("UTXO", "coins") to consider the input as valid and consequently to be included in the total wallet balance calculation or a new transaction.
Accepts positive integers. Defaults to 1.
The inclusion of unconfirmed outputs via 0 bears the risk of the posthumous invalidation of own wallet transactions by the parent utxo sending party. They can e.g. be used for retrieving total BTC wallet balances including the pending UTXO.
Example: 12 |
| Accept | string | | |
| tangany-tx-confirmations | number | | |
RESPONSES
status: OK
{"address":"bc1qc7psdze9j0r38rv8gj2kl8gysqevtqyq6v506a","balance":"1.13166061","currency":"tBTC","utxo":43}