electrum1
Easy to use bitcoin client
Usage
electrum
electrum url
electrum [command]
[options]
[global_options]
[positional_arguments]
electrum help
command
Overview
Electrum is a lightweight Bitcoin wallet focused is speed, with low resource usage and simplifying Bitcoin. Startup times are instant because it operates in conjunction with high-performance servers that handle the most complicated parts of the Bitcoin system.
Electrum has a list of possible options specific to each command as well as a set of global options. Some commands also accept positional arguments at the end of the options list. Running electrum help command will list the options and positional arguments compatible with that command.
Commands
gui-
Run the GUI. This is the default if no command is specified. May use the url positional argument.
daemon-
Run the daemon.
add_peer-
Add a peer. Requires the connection_string positional argument.
add_request-
Create a payment request, using the first unused address of the wallet. The address will be considered as used after this operation. If no payment is received, the address will be considered as unused if the payment request is deleted from the wallet. Requires the amount positional argument.
addtransaction-
Add a transaction to the wallet history. Requires the tx positional argument.
broadcast-
Broadcast a transaction to the network. Requires the tx positional argument.
bumpfee-
Bump the fee for an unconfirmed transaction. Requires the tx and new_fee_rate positional arguments.
changegaplimit-
Change the gap limit of the wallet. See https://support.ledger.com/hc/en-us/articles/360010892360-Address-gap-limit and https://blog.lopp.net/mind-the-bitcoin-address-gap/ for more information. Requires the new_limit positional argument.
clear_invoices-
Remove all invoices.
clear_ln_blacklist-
Clear the Lightning blacklist.
clear_requests-
Remove all payment requests.
close_channel-
Close a Lightning channel. Requires the channel_point positional argument.
close_wallet-
Close the wallet.
commands-
List the available commands.
convert_currency-
Convert the given amount from one currency to another using the configured exchange rate source.
convert_xkey-
Convert the xtype of a master key. E.G. xpub -> ypub. Valid options are 'xprv', 'yprv', 'zprv', 'Yprv', 'Zprv', 'xpub', 'ypub', 'zpub', 'Ypub', and 'Zpub'. Requires the xkey and xtype positional arguments.
create-
Create a new wallet. If you want to be prompted for an argument in a concealed fashion, use '?' or ':' for the argument value.
createmultisig-
Create a MultiSig address. Requires the num and pubkeys positional arguments.
createnewaddress-
Create a new receiving address, beyond the gap limit of the wallet. See https://support.ledger.com/hc/en-us/articles/360010892360-Address-gap-limit and https://blog.lopp.net/mind-the-bitcoin-address-gap/ for more information.
decode_invoice-
Decode an invoice. Requires the invoice positional argument.
decrypt-
Decode a message encrypted with a public key. Requires the pubkey and encrypted positional arguments.
delete_invoice-
Delete an invoice. Requires the invoice_id positional argument.
delete_request-
Delete a request. Requires the request_id positional argument.
deserialize-
Delete a serialized transaction. Requires the tx positional argument.
dumpprivkeys-
This command is deprecated.
enable_htlc_settle-
Enable Hashed TimeLock Contract settlement. See https://www.investopedia.com/terms/h/hashed-timelock-contract.asp for more information. Requires the b positional argument.
encrypt-
Encrypt a message with a public key. Use quotes if the message contains whitespace. Requires the pubkey and message positional arguments.
export_channel_backup-
Export the channel backup. Requires the channel_point positional argument.
freeze-
Freeze the funds in one of your wallet's addresses. Requires the address positional argument.
freeze_utxo-
Freeze a UTXO (Unspent Transaction Output) so that the wallet will not spend it. See https://river.com/learn/bitcoins-utxo-model for more information. Requires the coin positional argument.
get-
Return an item from the wallet storage. Requires the key positional argument.
get_channel_ctx-
Return the current channel's commitment transaction. Requires the channel_point positional argument.
get_invoice-
Return the specified invoice (request for outgoing payment). Requires the invoice_id positional argument.
get_request-
Return the specified payment request. Requires the request_id positional argument.
get_tx_status-
Return information regarding the transaction (for now, only the number of confirmations). The transaction must be related to the wallet. Requires the txid positional argument.
get_watchtower_ctn-
Return the local watchtower's CTN of channel. Used in regtests. Requires the channel_point positional argument.
getaddressbalance-
Return the balance of a Bitcoin address. Note that this is a walletless server query, meaning that the results are not checked by SPV (Simple Payment Verification). Requires the address positional argument.
getaddresshistory-
Return the transaction history of a Bitcoin address. Note that this is a walletless server query, meaning that the results are not checked by SPV (Simple Payment Verification). Requires the address positional argument.
getaddressunspent-
Return the UTXO (Unspent Transaction Output) list of a Bitcoin address. Note that this is a walletless server query, meaning that the results are not checked by SPV (Simple Payment Verification). Requires the address positional argument.
getalias-
Retrieve an alias. This looks in your list of contacts, and for an OpenAlias DNS record. Requires the key positional argument.
getbalance-
Return the balance of your wallet.
getconfig-
Return a configuration variable. Requires the key positional argument.
getfeerate-
Return the current suggested fee rate (in sat/kvByte), according to the config settings or the supplied parameters.
getinfo-
Return the current network information.
getmasterprivate-
Return the wallet's master private key.
getmerkle-
Return the Merkle branch of a transaction included in a block. Electrum uses this to verify transactions (Simple Payment Verification). Requires the txid and height positional arguments.
getminacceptablegap-
Return the minimum value for gap limit that would be sufficient to discover all known addresses in the wallet.
getmpk-
Return the wallet's master public key.
getprivatekeyforpath-
Return the private key corresponding to a derivation path (address index). path can be either a str such as "m/0/50" or a list of ints such as [0, 50]. See https://learnmeabitcoin.com/technical/derivation-paths for more information. Requires the path positional argument.
getprivatekeys-
Return the private key of an address. You may pass a single wallet address or a list of wallet addresses. Requires the address positional argument.
getpubkeys-
Return the public key of an address. Requires the address positional argument.
getseed-
Return the wallet's generation seed phrase.
getservers-
Return the list of known servers (connections candidates).
gettransaction-
Return a transaction. Requires the txid positional argument.
getunusedaddress-
Return the wallet's first unused address, or None if all addresses are used. An address is considered to be used if it has received a transaction or if it is used in a payment request.
help-
Display help information. This is the same as the
-hand--helpoptions. Callinghelpfollowed by another command will display specific options for that command.
import_channel_backup-
Import a channel backup. Requires the encrypted positional argument.
importprivkey-
Import a private key. If you want to be prompted for an argument in a concealed fashion, use '?' for the argument value. Requires the privkey positional argument.
is_synchronized-
Return the wallet synchronization status.
ismine-
Check if address is in the wallet. Requires the address positional argument.
lightning_history-
Return the lightning history.
list_channels-
Return a list of the channels.
list_invoices-
Return a list of invoices (requests for outgoing payments) saved in the wallet.
list_peers-
Return a list of lightning peers.
list_requests-
Return a list of incoming payment requests saved in the wallet.
list_wallets-
Return a list of wallets open in the daemon.
listaddresses-
Return a list of all addresses in the wallet. Use options to filter the results.
listcontacts-
Return a list of contacts.
listunspent-
Return a list of unspent transaction outputs in the wallet.
lnpay-
Lightning Pay. Requires the invoice positional argument.
load_wallet-
Load a wallet in the daemon.
make_seed-
Create a seed.
nodeid-
Return the lightning node ID.
normal_swap-
Perform a normal submarine swap, which is to send on-chain BTC and receive on Lightning. Note that your funds will be locked for 24h if you do not have enough incoming capacity. Requires the onchain_amount and lightning_amount positional arguments.
notify-
Watch an address. Every time the address changes, a HTTP POST is sent to the URL. Call with an empty URL to stop watching an address. Requires the address and URL positional arguments.
onchain_history-
Return the on-chain transaction history of the wallet.
open_channel-
Open a channel. Requires the connection_string and amount positional arguments.
password-
Change the wallet password.
payto-
Create a transaction. Requires the destination and amount positional arguments.
paytomany-
Create a multi-output transaction. Requires the outputs positional argument.
rebalance_channels-
Rebalance the channels. If trampoline is used, the channels must be with different trampolines. Requires the from_scid, dest_scid, and amount positional arguments.
removelocaltx-
Remove a local transaction, and it dependent transactions, from the wallet. Requires the txid positional argument.
request_force_close-
Request the remove to force-close a channel. If a connection string is passed, it can be used without having a state or any backup for the channel. Assumes that the channel was originally opened with the same local peer (node_keypair). Requires the channel_point positional argument.
reset_liquidity_hints-
Reset the liquidity hints.
restore-
Restore a wallet from text, which can be a seed phrase, a master public key, a master private key, a list of Bitcoin addresses, or a list of Bitcoin private keys. If you want to be prompted for the text in a concealed fashion, use '?' or ':' for the argument value. Requires the text positional argument.
reverse_swap-
Perform a reverse submarine swap, which is to send on Lightning and receive on-chain BTC. Requires the lighting_amount and onchain_amount positional arguments.
searchcontacts-
Return contacts that match the query. Requires the query positional argument.
serialize-
Create a signed raw transaction from a JSON transaction template. An example value for the jsontx argument would be: { "inputs": [ {"prevout_hash": "9d221a69ca3997cbeaf5624d723e7dc5f829b1023078c177d37bdae95f37c539", "prevout_n": 1, "value_sats": 1000000, "privkey": "p2wpkh:cVDXzzQg6RoCTfiKpe8MBvmm5d5cJc6JLuFApsFDKwWa6F5TVHpD"} ], "outputs": [ {"address": "tb1q4s8z6g5jqzllkgt8a4har94wl8tg0k9m8kv5zd", "value_sats": 990000} ] }. Requires the jsontx positional argument.
setconfig-
Set a configuration variable. value may be a string or a Python expression. Requires the key and value positional arguments.
setlabel-
Assign a label to a Bitcoin address or a transaction ID. Requires the key and label positional arguments.
signmessage-
Sign a message with the address key. Use quotes if the message contain whitespaces. Requires the address and message positional arguments.
signtransaction-
Sign a transaction with the wallet keys. Requires the tx positional argument.
signtransaction_with_privkey-
Sign a transaction with the provided list of private keys. Requires the tx and privkey positional argument.
stop-
Stop the daemon.
sweep-
Sweep a private key, which return a transaction that spends UTXOs (Unspent Transaction Outputs) from the private key to a destination address. The transaction is not broadcast. Requires the privkey and destination positional arguments.
unfreeze-
Unfreeze the funds in one of your wallet's addresses. Requires the address positional argument.
unfreeze_utxo-
Unfreeze a UTXO (Unspent Transaction Output) so that the wallet will can spend it. See https://river.com/learn/bitcoins-utxo-model for more information. Requires the coin positional argument.
validateaddress-
Check that an address is valid. Requires the address positional argument.
verifymessage-
Verify a message signature. Requires the address, signature, and message positional arguments.
version-
Display the version information. This is the same as the
--versionoption.
version_info-
Display information about dependencies, such as their version and path.
Options
-
-h, --help -
Display help information. This is the same as using the
helpcommand with no arguments. Can be used by any command.
-
--version -
Display the version. This is the same as using the
versioncommand. Typically used without any command.
-
--addtransaction -
Specify whether to add the transaction to the wallet, so that it can be used for broadcasting afterwards. Can be used by the
paytoandpaytomanycommands.
-
-b, --balance -
Show the balances of the listed addresses. Can be used by the
listaddressescommand.
-cCHANGE_ADDR, --change_addr CHANGE_ADDR-
Change the address. The default is a spare address, or the source address if it is not in the wallet. Can be used by the
paytoandpaytomanycommands.
-
--change -
Show only change addresses. Can be used by the
listaddressescommand.
--connection_stringCONNECTION_STRING-
The Lightning network node ID or network address. Can be used by the
request_force_closecommand.
-
-d, --detached -
Run the daemon in detached mode. Can be used by the
daemoncommand.
-
--daemon -
Keep the daemon running after the GUI exits. Can be used by the
guicommand.
-
--decrease_payment -
Specify whether the payment amount will be decreased (true/false). Can be used by the
bumpfeecommand.
--encrypt_fileENCRYPT_FILE-
Specify whether the file on disk should be encrypted with the provided password. Can be used by the
create,password, andrestorecommands.
-
--expired -
Show only expired requests. Can be used by the
list_invoicesandlist_requestscommands.
--expiryEXPIRY-
The expiry time in seconds. Can be used by the
add_requestcommand.
-fSERVERFINGERPRINT, --serverfingerprint SERVERFINGERPRINT-
Only connect to servers with a matching SSL certificate SHA256 fingerprint. To calculate this yourself: '$ openssl x509 -noout -fingerprint -sha256 -inform pem -in servercertfile.crt'. The server fingerprint should be entered as 64 hexadecimal characters. Can be used by the
guianddaemoncommands.
-fFEE, --fee FEE-
The transaction fee (absolute, in BTC). Can be used by the
payto,paytomany, andsweepcommands.
-FFROM_ADDR, --from_addr FROM_ADDR-
The source address, which must be a wallet address. Use
sweepto spend from a non-wallet address. Can be used by thepaytoandpaytomanycommands.
--feerateFEERATE-
The transaction fee rate (in sat/byte). Can be used by the
paytoandpaytomanycommands.
--fee_levelFEE_LEVEL-
A float between 0.0 and 1.0, representing the fee slider position. Can be used by the
getfeeratecommand.
--fee_methodFEE_METHOD-
The fee estimation method to use. Can be used by the
getfeeratecommand.
-
--force -
Create a new address beyond the gap limit if no more addresses are available. Can be used by the
add_requestcommand.
-
--forgetconfig -
Forget the config on exit. Can be used by the
gui,add_peer,add_request,addtransaction,bumpfee,changegaplimit,clear_invoices,clear_requests,close_channel,close_wallet,create,createnewaddress,decrypt,delete_invoice,delete_request,enable_htlc_settle,export_channel_backup,freeze,freeze_utxo,get,get_channel_ctx,get_invoice,get_request,get_tx_status,get_watchtower_ctn,getalias,getbalance,getmasterprivate,getminacceptablegap,getmpk,getprivatekeyforpath,getprivatekeys,getpubkeys,getseed,gettransaction,getunusedaddress,import_channel_backup,importprivkey,is_synchronized,ismine,lightning_history,list_channels,list_invoices,list_peers,list_requests,listaddresses,listcontacts,listunspent,lnpay,load_wallet,nodeid,normal_swap,onchain_history,open_channel,password,payto,paytomany,rebalance_channels,removelocaltx,request_force_close,restore,reverse_swap,searchcontacts,setlabel,signmessage,signtransaction,unfreeze, andunfreeze_utxocommands.
--from_amountFROM_AMOUNT-
The amount to convert (the default is 1). Can be used by the
convert_currencycommand.
--from_ccyFROM_CCY-
The currency to convert from. Can be used by the
convert_currencycommand.
--from_coinsFROM_COINS-
The source coins, which must be in the wallet. Use
sweepto spend from a non-wallet address. Can be used by thebumpfee,payto, andpaytomanycommands.
--from_heightFROM_HEIGHT-
Only show transactions that confirmed after the specified block height. Can be used by the
onchain_historycommand.
-
--frozen -
Show only frozen addresses. Can be used by the
listaddressescommand.
-
--funded -
Show only funded addresses. Can be used by the
listaddressescommand.
-gGUI, --GUI GUI-
Specify the GUI. Valid arguments are 'qt', 'kivy', 'text', 'stdio', and 'qml'. The default is Qt. Kivy and QML are used for the Android GUI and are not included in the Debian package. The text dependencies are also not included in the Debian package. Can be used by the
guicommand.
-
--gossip -
Apply the command to the gossip node instead of the wallet. Can be used by the
add_peerandlist_peerscommands.
-
--iknowwhatiamdoing -
Acknowledge that you understand the full implications of what you are about to do. Can be used by the
changegaplimitandget_channel_ctxcommands.
--imaxIMAX-
Specify the maximum number of inputs. Can be used by the
sweepcommand.
-
-l, --labels -
Show the labels of the listed addresses. Can be used by the
listaddressescommand.
|
Specify the language. Can be used by the |
|---|---|
|
Set the locktime block number. Can be used by the |
|
The description of the request. Can be used by the |
|
The new password. Can be used by the |
|
The number of bits of entropy. Can be used by the |
-
--nocheck -
Do not verify aliases. Can be used by the
payto,paytomany, andsweepcommands.
-
--noonion -
Do not connect to onion servers. Can be used by the
guianddaemoncommands.
-
--nosegwit -
Do not create SegWit (Segregated Witness) wallets. See https://en.wikipedia.org/wiki/SegWit for more information. Can be used by the
guicommand.
-
-1, --oneserver -
Only connect to one server. Can be used by the Can be used by the
guianddaemoncommands.
-pPROXY, --proxy PROXY-
Specify the proxy using the [type:]host[:port] syntax (or 'none' to disable the proxy), where type is either 'socks4', 'socks5', or 'http'. Can be used by the
guianddaemoncommands.
-
--paid -
Show only paid requests. Can be used by the
list_invoicesandlist_requestscommands.
--passphrasePASSPHRASE-
The seed extension. Can be used by the
createandrestorecommands.
-
--pending -
Show only pending requests. Can be used by the
list_invoicesandlist_requestscommands.
--push_amountPUSH_AMOUNT-
The push initial amount (in BTC). Can be used by the
open_channelcommand.
--rbfRBF-
Specify whether to signal opt-in Replace-By-Fee in the transaction (true/false). Can be used by the payto and paytomany commands.
-
--receiving -
Show only receiving addresses. Can be used by the
listaddressescommand.
--rpchostRPCHOST-
The RPC host used by the RPC daemon. See https://electrum.readthedocs.io/en/latest/jsonrpc.html for more information. Can be used by the
daemoncommand.
--rpcportRPCPORT-
The RPC port used by the RPC daemon. See https://electrum.readthedocs.io/en/latest/jsonrpc.html for more information. Can be used by the
daemoncommand.
--rpcsockTYPE-
The RPC socket type used by the RPC daemon. Valid arguments are 'unix', 'tcp', and 'auto'. See https://electrum.readthedocs.io/en/latest/jsonrpc.html for more information. Can be used by the
daemoncommand.
--rpcsockpathTYPE-
The RPC socket file location used by the RPC daemon. See https://electrum.readthedocs.io/en/latest/jsonrpc.html for more information. Can be used by the
daemoncommand.
-sSERVER, --server SERVER-
Specify the server using the host:port:protocol syntax, where protocol is either 't' (TCP) or 's' (SSL). Can be used by the
guianddaemoncommands.
--seed_typeSEED_TYPE-
Specify the seed type. Valid arguments are 'standard', 'segwit', '2fa', and '2fa_segwit'. The default is 'segwit'. Can be used by the
createandmake_seedcommands.
-
--show_addresses -
Show the input and output addresses. Can be used by the
onchain_historycommand.
-
--show_fiat -
Show the fiat value of transactions. Can be used by the
lightning_historyandonchain_historycommands.
-
--skipmerklecheck -
Tolerate invalid Merkle proofs from the server. See https://medium.com/crypto-0-nite/merkle-proofs-explained-6dd429623dc5 for more information. Can be used by the
guianddaemoncommands.
--timeoutTIMEOUT-
The timeout in seconds. Can be used by the
add_peerandlnpaycommands.
--to_ccyTO_CCY-
The currency to convert to. Can be used by the
convert_currencycommand.
--to_heightTO_HEIGHT-
Only show transactions that confirmed before the specified block height. Can be used by the
onchain_historycommand.
-
-u, --unsigned -
Do not sign the transaction. Can be used by the
bumpfee,payto, andpaytomanycommands.
-
--unused -
Show only unused addresses. Can be used by the
listaddressescommand.
-wWALLET_PATH, --wallet WALLET_PATH-
Set the wallet path. Can be used by the
gui,add_peer,add_request,addtransaction,bumpfee,changegaplimit,clear_invoices,clear_requests,close_channel,close_wallet,create,createnewaddress,decrypt,delete_invoice,delete_request,enable_htlc_settle,export_channel_backup,freeze,freeze_utxo,get,get_channel_ctx,get_invoice,get_request,get_tx_status,get_watchtower_ctn,getalias,getbalance,getmasterprivate,getminacceptablegap,getmpk,getprivatekeyforpath,getprivatekeys,getpubkeys,getseed,gettransaction,getunusedaddress,import_channel_backup,importprivkey,is_synchronized,ismine,lightning_history,list_channels,list_invoices,list_peers,list_requests,listaddresses,listcontacts,listunspent,lnpay,load_wallet,nodeid,normal_swap,onchain_history,open_channel,password,payto,paytomany,rebalance_channels,removelocaltx,request_force_close,restore,reverse_swap,searchcontacts,setlabel,signmessage,signtransaction,unfreeze, andunfreeze_utxocommands.
-WPASSWORD, --password PASSWORD-
The password. Can be used by the
bumpfee,create,decrypt,getmasterprivate,getprivatekeyforpath,getprivatekeys,getseed,importprivkey,load_wallet,normal_swap,open_channel,password,payto,paytomany,restore,signmessage, andsigntransactioncommands.
--yearYEAR-
Show history for a given year. Can be used by the
onchain_historycommand.
Options
-DELECTRUM_PATH, --dir ELECTRUM_PATH-
Set the electrum data directory. The default is ~/.electrum.
-
-o, --offline -
Run electrum in offline mode.
-
-P, --portable -
Run electrum in portable mode, which uses ./electrum_data (electrum_data in the current directory) instead of ~/.electrum for the data directory.
--rpcuserRPCUSER-
Set the RPC user. See https://electrum.readthedocs.io/en/latest/jsonrpc.html for more information.
--rpcpasswordRPCPASSWORD-
Set the RPC password. See https://electrum.readthedocs.io/en/latest/jsonrpc.html for more information.
-
--regtest -
Run in regtest (regression test) mode. The default data directory is ~/.electrum/regtest. See https://developer.bitcoin.org/examples/testing.html and https://bitcoin.stackexchange.com/questions/98462/how-to-use-electrum-with-a-local-regtest-network for more information.
-
--simnet -
Run in simnet (simulation test network) mode. The default data directory is ~/.electrum/simnet. See https://bitcoin.stackexchange.com/questions/81260/bitcoin-node-what-is-the-difference-between-simnet-and-regtest for more information.
-
--signet -
Run in signet (signature network), which is similar to testnet but adds a signature requirement for block verification. The default data directory is ~./electrum/signet. See https://en.bitcoin.it/wiki/Signet for more information.
-
--testnet -
Run in testnet mode, which connects to Bitcoin's testnet network instead of the mainnet one. The coins on testnet have no value, which allows users to safely test functionality without risk. The default data directory is ~/.electrum/testnet. See https://developer.bitcoin.org/examples/testing.html for more information.
|
Set the verbosity (log level). |
|---|---|
|
Set the verbosity (shortcut-filter list). |
Positional arguments
- address
-
The Bitcoin address. Can be used by the
freeze,getaddressbalance,getaddresshistory,getaddressunspent,getprivatekeys,getpubkeys,ismine,notify,signmessage,unfreeze,validateaddress, andverifymessagecommands.
- amount
-
The amount to be sent (in BTC). Use '!' to send the maximum available. Can be used by the
add_request,open_channel,payto, andrebalance_channelscommands.
- b
-
B. Can be used by the
enable_htlc_settlecommand.
- channel_point
-
The channel point. Can be used by the
close_channel,export_channel_backup,get_channel_ctx,get_watchtower_ctn, andrequest_force_closecommands.
- coin
-
The coin, otherwise known as the UTXO (Unspent Transaction Output). Can be used by the
freeze_utxoandunfreeze_utxocommands.
- connection_string
-
The Lightning network node ID or network address. Can be used by the
add_peerandopen_channelcommands.
- dest_scid
-
The destination Short Channel Identifier. Can be used by the
rebalance_channelscommand.
- destination
-
A Bitcoin address, contact, or alias. Can be used by the
paytoandsweepcommands.
- encrypted
-
The encrypted message. Can be used by the
decryptandimport_channel_backupcommands.
- from_scid
-
The from Short Channel Identifier. Can be used by the
rebalance_channelscommand.
- height
-
The block height. Can be used by the
getmerklecommand.
- invoice
-
The invoice. Can be used by the
decode_invoiceandlnpaycommands.
- invoice_id
-
The invoice ID. Can be used by the
delete_invoiceandget_invoicecommands.
- jsontx
-
The JSON transaction. An example value would be: { "inputs": [ {"prevout_hash": "9d221a69ca3997cbeaf5624d723e7dc5f829b1023078c177d37bdae95f37c539", "prevout_n": 1, "value_sats": 1000000, "privkey": "p2wpkh:cVDXzzQg6RoCTfiKpe8MBvmm5d5cJc6JLuFApsFDKwWa6F5TVHpD"} ], "outputs": [ {"address": "tb1q4s8z6g5jqzllkgt8a4har94wl8tg0k9m8kv5zd", "value_sats": 990000} ] }. Can be used by the
serializecommand.
- key
-
The variable name. Can be used by the
get,getalias,getconfig,setconfig, andsetlabelcommands.
- label
-
The label. Can be used by the
setlabelcommand.
- lightning_amount
-
The amount sent or received in a submarine swap. Set it to 'dryrun' to receive a value. Can be used by the
normal_swapandreverse_swapcommands.
- message
-
The message. Use quotes if it contains whitespaces. Can be used by the
encrypt,signmessage, andverifymessagecommands.
- new_fee_rate
-
The new fee rate. Can be used by the
bumpfeecommand.
- new_limit
-
The new gap limit. Can be used by the
changegaplimitcommand.
- num
-
The number of signatures. Can be used by the
createmultisigcommand.
- onchain_amount
-
The amount sent or received in a submarine swap. Set it to 'dryrun' to receive a value. Can be used by the
normal_swapandreverse_swapcommands.
- outputs
-
A list of ["address", amount ]. Can be used by the
paytomanycommand.
- path
-
The derivation path (address index). Can be used by the
getprivatekeyforpathcommand.
- privkey
-
The private key. In the case of
signtransaction_with_privkeya list of private keys can be used. If you want to be prompted for the privkey in a concealed fashion, use '?' for the argument value. Can be used by thegetprivatekeyforpath,importprivkey,signtransaction_with_privkey, andsweepcommands.
- pubkey
-
The public key. Can be used by the
decryptandencryptcommands.
- pubkeys
-
The public keys. Can be used by the
createmultisigcommand.
- query
-
The query. Can be used by the
searchcontactscommand.
- requset_id
-
The request ID. Can be used by the
delete_requestandget_requestcommands.
- signature
-
The signature. Can be used by the
verifymessagecommand.
- text
-
The text, which can be a seed phrase, a master public key, a master private key, a list of Bitcoin addresses, or a list of Bitcoin private keys. If you want to be prompted for the text in a concealed fashion, use '?' or ':' for the argument value. Can be used by the
restorecommand.
- tx
-
A serialized transaction in hexadecimal. Can be used by the
addtransaction,broadcast,bumpfee,deserialize,signtransaction, andsigntransaction_with_privkeycommands.
- txid
-
The transaction ID. Can be used by the
get_tx_status,getmerkle,gettransaction, andremovelocaltxcommands.
- value
-
The value, which may be a string or a Python expression. Can be used by the
setconfigcommand.
- url
-
A Bitcoin URI or a BIP70 file. The Bitcoin URI syntax is bitcoin:address[?amount=amount][?label=label][?message=message]. Can be used by the
guicommand.
- URL
-
A standard web URL that can receive HTTP POST commands. Can be used by the
notifycommand.
- xkey
-
The XKey. Can be used by the
convert_xkeycommand.
- xtype
-
The XType. Can be used by the
convert_xkeycommand.
Releases
3 releases since Debian 11 (Bullseye); the text changed 1 time.
--addtransaction since Debian 13 (Trixie);
--change since Debian 13 (Trixie);
--daemon since Debian 13 (Trixie);
--decrease_payment since Debian 13 (Trixie);
--detached since Debian 13 (Trixie);
--expired since Debian 13 (Trixie);
--force since Debian 13 (Trixie);
--forgetconfig since Debian 13 (Trixie);
--frozen since Debian 13 (Trixie);
--funded since Debian 13 (Trixie);
--gossip since Debian 13 (Trixie);
--help since Debian 13 (Trixie);
--iknowwhatiamdoing since Debian 13 (Trixie);
--nocheck since Debian 13 (Trixie);
--noonion since Debian 13 (Trixie);
--nosegwit since Debian 13 (Trixie);
--oneserver since Debian 13 (Trixie);
--paid since Debian 13 (Trixie);
--pending since Debian 13 (Trixie);
--receiving since Debian 13 (Trixie);
--regtest since Debian 13 (Trixie);
--show_addresses since Debian 13 (Trixie);
--show_fiat since Debian 13 (Trixie);
--signet since Debian 13 (Trixie);
--simnet since Debian 13 (Trixie);
--skipmerklecheck since Debian 13 (Trixie);
--testnet since Debian 13 (Trixie);
--unsigned since Debian 13 (Trixie);
--unused since Debian 13 (Trixie);
--version since Debian 13 (Trixie);
-1 since Debian 13 (Trixie);
-d since Debian 13 (Trixie);
-h since Debian 13 (Trixie).
--all until Debian 12 (Bookworm);
--changeaddr until Debian 12 (Bookworm);
--fee until Debian 12 (Bookworm);
--fromad until Debian 12 (Bookworm);
--gui until Debian 12 (Bookworm);
--lang until Debian 12 (Bookworm);
--proxy until Debian 12 (Bookworm);
--server until Debian 12 (Bookworm);
--usb until Debian 12 (Bookworm);
--verbose until Debian 12 (Bookworm);
--wallet until Debian 12 (Bookworm);
-F until Debian 12 (Bookworm);
-L until Debian 12 (Bookworm);
-a until Debian 12 (Bookworm);
-c until Debian 12 (Bookworm);
-f until Debian 12 (Bookworm);
-g until Debian 12 (Bookworm);
-p until Debian 12 (Bookworm);
-s until Debian 12 (Bookworm);
-v until Debian 12 (Bookworm);
-w until Debian 12 (Bookworm).