Skip to content

useUTXOs

Retrieves UTXOs for the specified address.

Import

ts
import { useUTXOs } from '@midl/react';

Example

tsx
function MyComponent() {
    const { utxos } = useUTXOs('bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq');

    return (
        <div>
            {utxos?.map(utxo => (
                <div key={utxo.txid}>
                    <p>TXID: {utxo.txid}</p>
                    <p>Vout: {utxo.vout}</p>
                    <p>Amount: {utxo.value}</p>
                </div>
            ))}
        </div>
    );
}

Parameters

NameTypeDescription
addressstringThe Bitcoin address for which to retrieve UTXOs.
configConfig(optional) Custom config to override the default from context.
queryQueryOptions(optional) Query options for react-query.

Returns

NameTypeDescription
utxosUTXO[]The list of UTXOs for the specified address.
...restobjectAdditional query state (e.g. isLoading, error, etc.).