lightning-bkpr-dumpincomecsv

lightning-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 location. 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, consolidated 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", "quickbooks"): Format to print csv as.

AUTHOR

Lisa Neigut <[email protected]> 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 (previously c-lightning) is a lightweight, highly customizable and standard compliant implementation of the Lightning Network protocol.

© 2023 Core Lightning
All rights reserved.

Discussion Forum

The official Core Lightning forum is hosted at discuss.corelightning.org

BuildonL2 Community

The official BuildOnL2 community lives at community.corelightning.org. Join us and build the future of bitcoin on lightning.

Mailing List

For general discussions about CLN implementation, use [email protected]. For the Lightning Network, use [email protected]

Telegram

Community-driven telegram group where most of the node operators hang out. Go to https://t.me/lightningd to join.

Discord

Community-driven discord server where the devs flock together. Go to https://discord.gg/w27fMFESMN to join.

Internet Relay Chat

Don't hesitate to reach out to us on IRC at #lightning-dev @ libera.chat, #c-lightning @ libera.chat.