On this page

latest contributor to this doc

Last Edit:

@smk762

Get Claimable Lightning Balances

API-v2lightning::channels::get_claimable_balances

Returns a list of claimable balances for a coin.

ParameterTypeRequiredDefaultDescription
coinstring-The ticker of the coin you would like to view claimable balances for.
include_open_channels_balancesbooleanfalseIf true, includes balances from open channels.

ParameterTypeDescription
resultarrayList of claimable balances.
idintRequest identifier.

lightning::channels::get_claimable_balances

POST
lightning::channels::get_claimable_balances
{
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "method": "lightning::channels::get_claimable_balances",
  "params": {
    "coin": "tBTC-lightning",
    "include_open_channels_balances": true
  },
  "id": 762
}