v1

latestOpenAPI 3.0.02026-07-2442242189.1 KB

Balances

QueryWalletUTXOs

Retrieve a list of all UTXOs in a wallet.

post/v2/vaults/{vault_id}/wallets/{wallet_id}:queryUTXOs

Path parameters

vault_idstring required

wallet_idstring required

Request body

networkstring required

The resource name of the network whose UTXOs are to be listed.

Format: networks/{network_id}.

filterstring

Filter results using EBNF syntax.

Supported fields:

txHash (example: txHash = "60887d40d469af2b52cf7dc35e6c33241610aa22ca0c8d0d5e4d9027e91c2946")
address (example: address = "bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4")
state (example: state = AVAILABLE OR state = FROZEN)

orderBystring

SQL-like ordering specifications. Supports the fields create_time, value.

pageSizeinteger

The maximum number of items to return. The service may return fewer than this value.

If unspecified, at most 50 will be returned. The maximum value is 100; values above 100 will be coerced to 100.

pageTokenstring

A page token, received from the previous list call as nextPageToken. Provide this to retrieve the subsequent page.

When paginating, all other parameters must match the call that provided the page token.

skipinteger

How many results to skip.

Note: may be used alongside token-based pagination (see pageToken), although this won't be needed for most use cases.

includeReferencedResourcesboolean

Include referenced resources in the response.

Response

A successful response.

nextPageTokenstring

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

totalSizeinteger

Total number of items in the response, regardless of pagination.

referencedResourcesobject

A mapping of the referenced resources in the message. The key is the resource name and the value is the corresponding resource.

This field is only populated if the includeReferencedResources field is set to true.

Example response

{
  "utxos": [
    {
      "network": "networks/bitcoin-mainnet",
      "txHash": "4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b",
      "vout": 1,
      "walletAddress": "vaults/1b25635a5b3f/wallets/67af44031584/addresses/519c67ddae33",
      "scriptType": "P2WPKH",
      "confirmations": 6,
      "value": "2.1"
    }
  ]
}