TAtatum
Wallet API

Get unspent UTXOs for an address

Changed on

/v4/data/utxos

100 credits per API call

> 📘 **Note for v3 API users:** > > As part of our documentation consolidation, we removed the dedicated page for GET /v3/data/utxos. Users can refer to GET /v4/data/utxos for the latest documentation, as both endpoints function the same—simply replace v4 with v3 in the API URL if using the v3 version.

Get unspent UTXOs for a specific address up to a specific total amount. If you want to prepare a transaction on UTXO-based chains like Bitcoin, you need to enter unspent UTXOs to be able to perform a transaction. By providing ```totalValue``` as a total, our API will return a list of UTXOs that will be enough to cover the transaction.

Our API lets you get the unpenst UTXOs for a specific address on:

  • Bitcoin - bitcoin / bitcoin-testnet
  • Litecoin - litecoin / litecoin-testnet
  • Dogecoin - doge / doge-testnet
  • Cardano - cardano / cardano-preprod

To get started:

  • Provide a chain and address you want to list unspent UTXOs for. If available, our API will return information about the unspent UTXOs for a specific address.
  • Note: Bitcoin mainnet, Bitcoin testnet, Litecoin mainnet, Litecoin testnet, Dogecoin mainnet, Dogecoin testnet are now supported for any amount of utxo's on address with our latest update. This functionality will be extended to other chains soon.
get/v4/data/utxos

Request

  • Base URL
    https://api.tatum.io
  • URL
    https://api.tatum.io/v4/data/utxos
  • Auth
    API key in header x-api-key

Query parameters

chain'bitcoin' | 'bitcoin-mainnet' | 'bitcoin-testnet' | 'litecoin' | 'litecoin-mainnet' | 'litecoin-testnet' | 'doge' | 'doge-mainnet' | 'doge-testnet' | 'cardano' | 'cardano-mainnet' | 'cardano-preprod' required

The blockchain to work with.

Example:bitcoin
addressstring required
Example:bc1qmfp2r68cde646jv5ns7x2qvah8v5qtfw8gznj2

The blockchain address.

totalValuenumber required
Example:0.0001

The total amount of transaction you want to send. Only UTXOs up to this amount will be returned, so you will not spend more than you need.

Response

OK

chain'bitcoin' | 'bitcoin-mainnet' | 'bitcoin-testnet' | 'litecoin' | 'litecoin-mainnet' | 'litecoin-testnet' | 'doge' | 'doge-mainnet' | 'doge-testnet' | 'cardano' | 'cardano-mainnet' | 'cardano-preprod' required

The blockchain to work with.

addressstring required

Address of the UTXO

txHashstring required

Hash of the transaction this UTXO is present in

indexnumber required

Index of the UTXO in the transaction

valuenumber required

Value of the UTXO, in BTC, LTC or DOGE.

valueAsStringstring required

String representation of the value of the UTXO, in BTC, LTC or DOGE.

Example response

[
  {
    "chain": "bitcoin",
    "address": "bc1qmfp2r68cde646jv5ns7x2qvah8v5qtfw8gznj2",
    "txHash": "0x1b5b3e8a671434bf5d0d38e3e52dcafac484441a48bfae4a3f71e5b0b3093d8e",
    "value": 0.0001,
    "valueAsString": "0.0001"
  }
]

Changes