FreeBSD Manual Pages
LIGHTNING-BKPR-CHANNELSAPY(7) LIGHTNING-BKPR-CHANNELSAPY(7) NAME lightning-bkpr-channelsapy -- Command to list stats on channel earnings SYNOPSIS bkpr-channelsapy [start_time] [end_time] DESCRIPTION The bkpr-channelsapy RPC command lists stats on routing income, leasing income, and various calculated APYs for channel routed funds. • start_time (u64, optional): UNIX timestamp (in seconds) to filter events after the provided timestamp. The default is zero. • end_time (u64, optional): UNIX timestamp (in seconds) to filter events up to and at the provided timestamp. The default is max-int. RETURN VALUE On success, an object containing channels_apy is returned. It is an ar- ray of objects, where each object contains: • account (string): The account name. If the account is a channel, the channel_id. The 'net' entry is the rollup of all channel accounts. • routed_out_msat (msat): Sats routed (outbound). • routed_in_msat (msat): Sats routed (inbound). • lease_fee_paid_msat (msat): Sats paid for leasing inbound (liquidity ads). • lease_fee_earned_msat (msat): Sats earned for leasing outbound (liq- uidity ads). • pushed_out_msat (msat): Sats pushed to peer at open. • pushed_in_msat (msat): Sats pushed in from peer at open. • our_start_balance_msat (msat): Starting balance in channel at fund- ing. Note that if our start balance is zero, any _initial field will be omitted (can't divide by zero). • channel_start_balance_msat (msat): Total starting balance at fund- ing. • fees_out_msat (msat): Fees earned on routed outbound. • utilization_out (string): Sats routed outbound / total start bal- ance. • utilization_in (string): Sats routed inbound / total start balance. • apy_out (string): Fees earned on outbound routed payments / total start balance for the length of time this channel has been open amortized to a year (APY). • apy_in (string): Fees earned on inbound routed payments / total start balance for the length of time this channel has been open amortized to a year (APY). • apy_total (string): Total fees earned on routed payments / total start balance for the length of time this channel has been open amortized to a year (APY). • fees_in_msat (msat, optional): Fees earned on routed inbound. • utilization_out_initial (string, optional): Sats routed outbound / our start balance. • utilization_in_initial (string, optional): Sats routed inbound / our start balance. • apy_out_initial (string, optional): Fees earned on outbound routed payments / our start balance for the length of time this channel has been open amortized to a year (APY). • apy_in_initial (string, optional): Fees earned on inbound routed payments / our start balance for the length of time this channel has been open amortized to a year (APY). • apy_total_initial (string, optional): Total fees earned on routed payments / our start balance for the length of time this channel has been open amortized to a year (APY). • apy_lease (string, optional): Lease fees earned over total amount leased for the lease term, amortized to a year (APY). Only appears if channel was leased out by us. AUTHOR Lisa Neigut <<niftynei@gmail.com>> is mainly responsible. SEE ALSO lightning-bkpr-listincome(7), lightning-bkpr-listfunds(7), lightning- bkpr-listaccountevents(7), lightning-bkpr-dumpincomecsv(7), lightning- listpeers(7) RESOURCES Main web site: <https://github.com/ElementsProject/lightning> EXAMPLES Example 1: Request: $ lightning-cli bkpr-channelsapy { "id": "example:bkpr-channelsapy#1", "method": "bkpr-channelsapy", "params": {} } Response: { "channels_apy": [ { "account": "channelid0120000120000120000120000120000120000120000120000120000", "routed_out_msat": 1000000, "routed_in_msat": 510091208, "lease_fee_paid_msat": 0, "lease_fee_earned_msat": 0, "pushed_out_msat": 0, "pushed_in_msat": 0, "our_start_balance_msat": 0, "channel_start_balance_msat": 1000000000, "fees_out_msat": 0, "fees_in_msat": 106, "utilization_out": "30.7060%", "utilization_in": "10.0027%", "utilization_in_initial": "50.0081%", "apy_out": "0.0080%", "apy_in": "0.0080%", "apy_in_initial": "0.0250%", "apy_total": "0.0160%" }, { "account": "channelid0230000230000230000230000230000230000230000230000230000", "routed_out_msat": 510190102, "routed_in_msat": 0, "lease_fee_paid_msat": 0, "lease_fee_earned_msat": 0, "pushed_out_msat": 0, "pushed_in_msat": 0, "our_start_balance_msat": 1000000000, "channel_start_balance_msat": 1000000000, "fees_out_msat": 106, "fees_in_msat": 0, "utilization_out": "31.7060%", "utilization_out_initial": "51.5591%", "utilization_in": "11.0027%", "apy_out": "0.0081%", "apy_out_initial": "0.0121%", "apy_in": "0.0081%", "apy_total": "0.0161%", "apy_total_initial": "0.0161%" }, { "account": "channelid0250000250000250000250000250000250000250000250000250000", "routed_out_msat": 500000000, "routed_in_msat": 0, "lease_fee_paid_msat": 0, "lease_fee_earned_msat": 0, "pushed_out_msat": 0, "pushed_in_msat": 0, "our_start_balance_msat": 1000000000, "channel_start_balance_msat": 1000000000, "fees_out_msat": 0, "fees_in_msat": 0, "utilization_out": "32.7060%", "utilization_out_initial": "52.5591%", "utilization_in": "12.0027%", "apy_out": "0.0082%", "apy_out_initial": "0.0122%", "apy_in": "0.0082%", "apy_total": "0.0162%", "apy_total_initial": "0.0162%" }, { "account": "net", "routed_out_msat": 1011190102, "routed_in_msat": 510091208, "lease_fee_paid_msat": 0, "lease_fee_earned_msat": 0, "pushed_out_msat": 0, "pushed_in_msat": 0, "our_start_balance_msat": 2000000000, "channel_start_balance_msat": 3000000000, "fees_out_msat": 106, "fees_in_msat": 106, "utilization_out": "33.7060%", "utilization_out_initial": "53.5591%", "utilization_in": "13.0027%", "utilization_in_initial": "53.0081%", "apy_out": "0.0083%", "apy_out_initial": "0.0123%", "apy_in": "0.0083%", "apy_in_initial": "0.0253%", "apy_total": "0.0163%", "apy_total_initial": "0.0163%" } ] } Core Lightning v25.02 LIGHTNING-BKPR-CHANNELSAPY(7)
NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | AUTHOR | SEE ALSO | RESOURCES | EXAMPLES
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=lightning-bkpr-channelsapy&sektion=7&manpath=FreeBSD+Ports+14.3.quarterly>