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

Populate the CoinsResult struct with vectors of available COutputs, organized by OutputType.

== Synopsis

Declared in `<wallet/spend.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[requires_capability(0x7f2e1e652a00)]]
xref:wallet/CoinsResult.adoc[CoinsResult]
AvailableCoins(
    xref:wallet/CWallet.adoc[CWallet] const& wallet,
    xref:wallet/CCoinControl.adoc[CCoinControl] const* coinControl = nullptr,
    std::optional<CFeeRate> feerate = std::nullopt,
    xref:wallet/CoinFilterParams.adoc[CoinFilterParams] const& params = {});
----

== Return Value

The available outputs organized by OutputType.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *wallet*
| The wallet whose outputs are examined.
| *coinControl*
| Optional coin control settings restricting which outputs are considered.
| *feerate*
| Optional fee rate used to compute each output's effective value.
| *params*
| Filter parameters constraining which outputs are returned.
|===


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