Get Claimable Lightning Balances
API-v2lightning::channels::get_claimable_balances
Returns a list of claimable balances for a coin.
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
coin | string | ✓ | - | The ticker of the coin you would like to view claimable balances for. |
include_open_channels_balances | boolean | ✗ | false | If true , includes balances from open channels. |
Parameter | Type | Description |
---|---|---|
result | array | List of claimable balances. |
id | int | Request 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
}