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

NAME
     bkpr-dumpincomecsv -- Command to emit a CSV of income events

SYNOPSIS
     bkpr-dumpincomecsv  csv_format  [csv_file]  [consolidate_fees] [start_time]
     [end_time]

DESCRIPTION
     The bkpr-dumpincomcsv RPC command writes a CSV file to disk at csv_file lo-
     cation. This is a formatted output of the listincome RPC command.

     *	csv_format (string): CSV format to use. See RETURN VALUE for options.
     *	csv_file (string, optional): On-disk destination of  the  generated  CSV
	file.
     *	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 dumpincomecsv 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  (u64,  optional):  UNIX  timestamp (in seconds) that filters
	events after the provided timestamp. The default is zero.
     *	end_time (u64, 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 is returned, containing:

     *	csv_file (string): File that the csv was generated to.
     *	csv_format  (string) (one of "cointracker", "koinly", "harmony", "quick-
	books"): Format to print csv as.

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-channelsapy(7), lightning-listpeers(7)

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

EXAMPLES
     Example 1:

     Request:

     $ lightning-cli bkpr-dumpincomecsv "koinly" "koinly.csv"

     {
       "id": "example:bkpr-dumpincomecsv#1",
       "method": "bkpr-dumpincomecsv",
       "params": [
	 "koinly",
	 "koinly.csv"
       ]
     }

     Response:

     {
       "csv_file": "koinly.csv",
       "csv_format": "koinly"
     }

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