[#wallet-GetBalance]
= xref:wallet.adoc[wallet]::GetBalance
:relfileprefix: ../
:mrdocs:

Computes the wallet's balance broken down by category.

== Synopsis

Declared in `<wallet/receive.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:wallet/Balance.adoc[Balance]
GetBalance(
    xref:wallet/CWallet.adoc[CWallet] const& wallet,
    int min_depth = 0,
    bool avoid_reuse = true,
    bool include_nonmempool = false);
----

== Return Value

The computed balance breakdown.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *wallet*
| The wallet to evaluate.
| *min_depth*
| Minimum confirmation depth for coins to count as trusted.
| *avoid_reuse*
| Whether to account for the avoid‐reuse flag.
| *include_nonmempool*
| Whether to include coins spent by transactions not in the mempool.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#