home | help 
LIGHTNING-BKPR-LISTINCOME(7)			    LIGHTNING-BKPR-LISTINCOME(7)

NAME
     bkpr-listincome -- Command for listing all income impacting events

SYNOPSIS
     bkpr-listincome [consolidate_fees] [start_time] [end_time]

DESCRIPTION
     The  bkpr-listincome  RPC	command is a list of all income impacting events
     that the bookkeeper plugin has recorded for this node.

     *	consolidate_fees (boolean, optional): If true, we emit a single, consol-
	idated event for any onchain-fees for a  txid  and  account.  Otherwise,
	events	for every update to the onchain fee calculation for this account
	and txid will be printed. Note that this means that the  events  emitted
	are  non-stable,  i.e.	calling listincome twice may result in different
	onchain fee events being emitted,  depending  on  how  much  information
	we've logged for that transaction. The default is True.
     *	start_time  (u32,  optional):  UNIX  timestamp (in seconds) that filters
	events after the provided timestamp. The default is zero.
     *	end_time (u32, optional):  UNIX  timestamp  (in  seconds)  that  filters
	events up to and at the provided timestamp. The default is max-int.

RETURN VALUE
     On  success, an object containing income_events is returned. It is an array
     of objects, where each object contains:

     *	account (string): The account name. If the account  is	a  channel,  the
	channel_id.
     *	tag (string): Type of income event.
     *	credit_msat (msat): Amount earned (income).
     *	debit_msat (msat): Amount spent (expenses).
     *	currency (string): Human-readable bech32 part for this coin type.
     *	timestamp (u32): Timestamp this event was recorded by the node. For con-
	solidated events such as onchain_fees, the most recent timestamp.
     *	description  (string, optional): More information about this event. If a
	invoice type, typically the bolt11/bolt12 description.
     *	outpoint (string, optional): The txid:outnum for this event, if applica-
	ble.
     *	txid (txid, optional): The txid of the	transaction  that  created  this
	event, if applicable.
     *	payment_id  (hex,  optional): Lightning payment identifier. For an htlc,
	this will be the preimage.

AUTHOR
     Lisa Neigut niftynei@gmail.com is mainly responsible.

SEE ALSO
     lightning-bkpr-listaccountevents(7),   lightning-listfunds(7),   lightning-
     bkpr-listbalances(7)

RESOURCES
     Main web site: https://github.com/ElementsProject/lightning

EXAMPLES
     Example 1:

     Request:

     $ lightning-cli bkpr-listincome -k "consolidate_fees"=False

     {
       "id": "example:bkpr-listincome#1",
       "method": "bkpr-listincome",
       "params": {
	 "consolidate_fees": false
       }
     }

     Response:

     {
       "income_events": [
	 {
	   "account": "wallet",
	   "tag": "deposit",
	   "credit_msat": 200000000000,
	   "debit_msat": 0,
	   "currency": "bcrt",
	   "timestamp": 1738500000,
	   "description": "edited utxo description",
	   "outpoint": "txidbk0000000000000000000000000000000000000000000000000000000000:1"
	 },
	 {
	   "account": "wallet",
	   "tag": "deposit",
	   "credit_msat": 2000000000,
	   "debit_msat": 0,
	   "currency": "bcrt",
	   "timestamp": 1738510000,
	   "outpoint": "txidbk0101010101010101010101010101010101010101010101010101010101:1"
	 },
	 {
	   "account": "wallet",
	   "tag": "onchain_fee",
	   "credit_msat": 0,
	   "debit_msat": 1004927000,
	   "currency": "bcrt",
	   "timestamp": 1738520000,
	   "txid": "channeltxid340000340000340000340000340000340000340000340000340000"
	 },
	 {
	   "account": "wallet",
	   "tag": "onchain_fee",
	   "credit_msat": 1004927000,
	   "debit_msat": 0,
	   "currency": "bcrt",
	   "timestamp": 1738530000,
	   "txid": "channeltxid340000340000340000340000340000340000340000340000340000"
	 }
       ]
     }

     Example 2:

     Request:

     $ lightning-cli bkpr-listincome

     {
       "id": "example:bkpr-listincome#2",
       "method": "bkpr-listincome",
       "params": {}
     }

     Response:

     {
       "income_events": [
	 {
	   "account": "wallet",
	   "tag": "deposit",
	   "credit_msat": 200000000000,
	   "debit_msat": 0,
	   "currency": "bcrt",
	   "timestamp": 1738510000,
	   "description": "edited utxo description",
	   "outpoint": "txidbk0101010101010101010101010101010101010101010101010101010101:1"
	 },
	 {
	   "account": "channelid0230000230000230000230000230000230000230000230000230000",
	   "tag": "invoice",
	   "credit_msat": 500000000,
	   "debit_msat": 0,
	   "currency": "bcrt",
	   "timestamp": 1738520000,
	   "description": "edited invoice description from description send some sats l2 to l3",
	   "payment_id": "paymentid0000202020202020202020202020202020202020202020202020202"
	 },
	 {
	   "account": "channelid0340200340200340200340200340200340200340200340200340200",
	   "tag": "onchain_fee",
	   "credit_msat": 0,
	   "debit_msat": 6960000,
	   "currency": "bcrt",
	   "timestamp": 1738530000,
	   "txid": "channeltxid340200340200340200340200340200340200340200340200340200"
	 }
       ]
     }

Core Lightning v26.06.1 			    LIGHTNING-BKPR-LISTINCOME(7)
home | help