Skip to content

Instantly share code, notes, and snippets.

What would you like to do?
Bitcoin Core Help (v0.20.0)
Usage: bitcoin-cli [options] <command> [params] Send command to Bitcoin Core
or: bitcoin-cli [options] -named <command> [name=value]... Send command to Bitcoin Core (with named arguments)
or: bitcoin-cli [options] help List commands
or: bitcoin-cli [options] help <command> Get help for a command
Print this help message and exit
Specify configuration file. Relative paths will be prefixed by datadir
location. (default: bitcoin.conf)
Specify data directory
Get general information from the remote server. Note that unlike
server-side RPC calls, the results of -getinfo is the result of
multiple non-atomic requests. Some entries in the result may
represent results from different states (e.g. wallet balance may
be as of a different block from the chain state reported)
Pass named instead of positional arguments (default: false)
Timeout in seconds during HTTP requests, or 0 for no timeout. (default:
Send commands to node running on <ip> (default:
Location of the auth cookie. Relative paths will be prefixed by a
net-specific datadir location. (default: data dir)
Password for JSON-RPC connections
Connect to JSON-RPC on <port> (default: 8332, testnet: 18332, regtest:
Username for JSON-RPC connections
Wait for RPC server to start
Send RPC for non-default wallet on RPC server (needs to exactly match
corresponding -wallet option passed to bitcoind). This changes
the RPC endpoint used, e.g.<walletname>
Read extra arguments from standard input, one per line until EOF/Ctrl-D
(recommended for sensitive information such as passphrases). When
combined with -stdinrpcpass, the first line from standard input
is used for the RPC password.
Read RPC password from standard input as a single line. When combined
with -stdin, the first line from standard input is used for the
RPC password. When combined with -stdinwalletpassphrase,
-stdinrpcpass consumes the first line, and -stdinwalletpassphrase
consumes the second.
Read wallet passphrase from standard input as a single line. When
combined with -stdin, the first line from standard input is used
for the wallet passphrase.
Print version and exit
Debugging/Testing options:
Chain selection options:
Use the chain <chain> (default: main). Allowed values: main, test,
Use the test chain. Equivalent to -chain=test.
== Blockchain ==
getblock "blockhash" ( verbosity )
getblockfilter "blockhash" ( "filtertype" )
getblockhash height
getblockheader "blockhash" ( verbose )
getblockstats hash_or_height ( stats )
getchaintxstats ( nblocks "blockhash" )
getmempoolancestors "txid" ( verbose )
getmempooldescendants "txid" ( verbose )
getmempoolentry "txid"
getrawmempool ( verbose )
gettxout "txid" n ( include_mempool )
gettxoutproof ["txid",...] ( "blockhash" )
gettxoutsetinfo ( "hash_type" )
preciousblock "blockhash"
pruneblockchain height
scantxoutset "action" ( [scanobjects,...] )
verifychain ( checklevel nblocks )
verifytxoutproof "proof"
== Control ==
getmemoryinfo ( "mode" )
help ( "command" )
logging ( ["include_category",...] ["exclude_category",...] )
== Generating ==
generateblock "output" ["rawtx/txid",...]
generatetoaddress nblocks "address" ( maxtries )
generatetodescriptor num_blocks "descriptor" ( maxtries )
== Mining ==
getblocktemplate ( "template_request" )
getnetworkhashps ( nblocks height )
prioritisetransaction "txid" ( dummy ) fee_delta
submitblock "hexdata" ( "dummy" )
submitheader "hexdata"
== Network ==
addnode "node" "command"
disconnectnode ( "address" nodeid )
getaddednodeinfo ( "node" )
getnodeaddresses ( count )
setban "subnet" "command" ( bantime absolute )
setnetworkactive state
== Rawtransactions ==
analyzepsbt "psbt"
combinepsbt ["psbt",...]
combinerawtransaction ["hexstring",...]
converttopsbt "hexstring" ( permitsigdata iswitness )
createpsbt [{"txid":"hex","vout":n,"sequence":n},...] [{"address":amount},{"data":"hex"},...] ( locktime replaceable )
createrawtransaction [{"txid":"hex","vout":n,"sequence":n},...] [{"address":amount},{"data":"hex"},...] ( locktime replaceable )
decodepsbt "psbt"
decoderawtransaction "hexstring" ( iswitness )
decodescript "hexstring"
finalizepsbt "psbt" ( extract )
fundrawtransaction "hexstring" ( options iswitness )
getrawtransaction "txid" ( verbose "blockhash" )
joinpsbts ["psbt",...]
sendrawtransaction "hexstring" ( maxfeerate )
signrawtransactionwithkey "hexstring" ["privatekey",...] ( [{"txid":"hex","vout":n,"scriptPubKey":"hex","redeemScript":"hex","witnessScript":"hex","amount":amount},...] "sighashtype" )
testmempoolaccept ["rawtx",...] ( maxfeerate )
utxoupdatepsbt "psbt" ( ["",{"desc":"str","range":n or [n,n]},...] )
== Util ==
createmultisig nrequired ["key",...] ( "address_type" )
deriveaddresses "descriptor" ( range )
estimatesmartfee conf_target ( "estimate_mode" )
getdescriptorinfo "descriptor"
signmessagewithprivkey "privkey" "message"
validateaddress "address"
verifymessage "address" "signature" "message"
== Wallet ==
abandontransaction "txid"
addmultisigaddress nrequired ["key",...] ( "label" "address_type" )
backupwallet "destination"
bumpfee "txid" ( options )
createwallet "wallet_name" ( disable_private_keys blank "passphrase" avoid_reuse descriptors )
dumpprivkey "address"
dumpwallet "filename"
encryptwallet "passphrase"
getaddressesbylabel "label"
getaddressinfo "address"
getbalance ( "dummy" minconf include_watchonly avoid_reuse )
getnewaddress ( "label" "address_type" )
getrawchangeaddress ( "address_type" )
getreceivedbyaddress "address" ( minconf )
getreceivedbylabel "label" ( minconf )
gettransaction "txid" ( include_watchonly verbose )
importaddress "address" ( "label" rescan p2sh )
importdescriptors "requests"
importmulti "requests" ( "options" )
importprivkey "privkey" ( "label" rescan )
importprunedfunds "rawtransaction" "txoutproof"
importpubkey "pubkey" ( "label" rescan )
importwallet "filename"
keypoolrefill ( newsize )
listlabels ( "purpose" )
listreceivedbyaddress ( minconf include_empty include_watchonly "address_filter" )
listreceivedbylabel ( minconf include_empty include_watchonly )
listsinceblock ( "blockhash" target_confirmations include_watchonly include_removed )
listtransactions ( "label" count skip include_watchonly )
listunspent ( minconf maxconf ["address",...] include_unsafe query_options )
loadwallet "filename"
lockunspent unlock ( [{"txid":"hex","vout":n},...] )
removeprunedfunds "txid"
rescanblockchain ( start_height stop_height )
sendmany "" {"address":amount} ( minconf "comment" ["address",...] replaceable conf_target "estimate_mode" )
sendtoaddress "address" amount ( "comment" "comment_to" subtractfeefromamount replaceable conf_target "estimate_mode" avoid_reuse )
sethdseed ( newkeypool "seed" )
setlabel "address" "label"
settxfee amount
setwalletflag "flag" ( value )
signmessage "address" "message"
signrawtransactionwithwallet "hexstring" ( [{"txid":"hex","vout":n,"scriptPubKey":"hex","redeemScript":"hex","witnessScript":"hex","amount":amount},...] "sighashtype" )
unloadwallet ( "wallet_name" )
upgradewallet ( version )
walletcreatefundedpsbt [{"txid":"hex","vout":n,"sequence":n},...] [{"address":amount},{"data":"hex"},...] ( locktime options bip32derivs )
walletpassphrase "passphrase" timeout
walletpassphrasechange "oldpassphrase" "newpassphrase"
walletprocesspsbt "psbt" ( sign "sighashtype" bip32derivs )
== Zmq ==
Usage: bitcoind [options] Start Bitcoin Core
Print this help message and exit
Execute command when a relevant alert is received or we see a really
long fork (%s in cmd is replaced by message)
If this block is in the chain assume that it and its ancestors are valid
and potentially skip their script verification (0 to verify all,
Maintain an index of compact filters by block (default: 0, values:
basic). If <type> is not supplied or if <type> = 1, indexes for
all known types are enabled.
Execute command when the best block changes (%s in cmd is replaced by
block hash)
Extra transactions to keep in memory for compact block reconstructions
(default: 100)
Specify directory to hold blocks subdirectory for *.dat files (default:
Whether to reject transactions from network peers. Automatic broadcast
and rebroadcast of any transactions from inbound peers is
disabled, unless '-whitelistforcerelay' is '1', in which case
whitelisted peers' transactions will be relayed. RPC transactions
are not affected. (default: 0)
Specify configuration file. Relative paths will be prefixed by datadir
location. (default: bitcoin.conf)
Run in the background as a daemon and accept commands
Specify data directory
Maximum database write batch size in bytes (default: 16777216)
Maximum database cache size <n> MiB (4 to 16384, default: 450). In
addition, unused mempool memory is shared for this cache (see
Specify location of debug log file. Relative paths will be prefixed by a
net-specific datadir location. (-nodebuglogfile to disable;
default: debug.log)
Tell other nodes to filter invs to us by our mempool min fee (default:
Specify additional configuration file, relative to the -datadir path
(only useable from configuration file, not command line)
Imports blocks from external file on startup
Keep the transaction memory pool below <n> megabytes (default: 300)
Keep at most <n> unconnectable transactions in memory (default: 100)
Do not keep transactions in the mempool longer than <n> hours (default:
Minimum work assumed to exist on a valid chain in hex (default:
Set the number of script verification threads (-8 to 15, 0 = auto, <0 =
leave that many cores free, default: 0)
Whether to save the mempool on shutdown and load on restart (default: 1)
Specify pid file. Relative paths will be prefixed by a net-specific
datadir location. (default:
Reduce storage requirements by enabling pruning (deleting) of old
blocks. This allows the pruneblockchain RPC to be called to
delete specific blocks, and enables automatic pruning of old
blocks if a target size in MiB is provided. This mode is
incompatible with -txindex and -rescan. Warning: Reverting this
setting requires re-downloading the entire blockchain. (default:
0 = disable pruning blocks, 1 = allow manual pruning via RPC,
>=550 = automatically prune block files to stay under the
specified target size in MiB)
Rebuild chain state and block index from the blk*.dat files on disk
Rebuild chain state from the currently indexed blocks. When in pruning
mode or if blocks on disk might be corrupted, use full -reindex
Create new files with system default permissions, instead of umask 077
(only effective with disabled wallet functionality)
Maintain a full transaction index, used by the getrawtransaction rpc
call (default: 0)
Print version and exit
Connection options:
Add a node to connect to and attempt to keep the connection open (see
the `addnode` RPC command help for more info). This option can be
specified multiple times to add multiple nodes.
Specify asn mapping used for bucketing of the peers (default: Relative paths will be prefixed by the net-specific
datadir location.
Threshold for disconnecting misbehaving peers (default: 100)
Number of seconds to keep misbehaving peers from reconnecting (default:
Bind to given address and always listen on it. Use [host]:port notation
for IPv6
Connect only to the specified node; -noconnect disables automatic
connections (the rules for this peer are the same as for
-addnode). This option can be specified multiple times to connect
to multiple nodes.
Discover own IP addresses (default: 1 when listening and no -externalip
or -proxy)
Allow DNS lookups for -addnode, -seednode and -connect (default: 1)
Query for peer addresses via DNS lookup, if low on addresses (default: 1
unless -connect used)
Specify your own public address
Always query for peer addresses via DNS lookup (default: 0)
Accept connections from outside (default: 1 if no -proxy or -connect)
Automatically create Tor hidden service (default: 1)
Maintain at most <n> connections to peers (default: 125)
Maximum per-connection receive buffer, <n>*1000 bytes (default: 5000)
Maximum per-connection send buffer, <n>*1000 bytes (default: 1000)
Maximum allowed median peer time offset adjustment. Local perspective of
time may be influenced by peers forward or backward by this
amount. (default: 4200 seconds)
Tries to keep outbound traffic under the given target (in MiB per 24h).
Limit does not apply to peers with 'noban' permission. 0 = no
limit (default: 0)
Use separate SOCKS5 proxy to reach peers via Tor hidden services, set
-noonion to disable (default: -proxy)
Make outgoing connections only through network <net> (ipv4, ipv6 or
onion). Incoming connections are not affected by this option.
This option can be specified multiple times to allow multiple
Serve compact block filters to peers per BIP 157 (default: 0)
Support filtering of blocks and transaction with bloom filters (default:
Specify p2p connection timeout in seconds. This option determines the
amount of time a peer may be inactive before the connection to it
is dropped. (minimum: 1, default: 60)
Relay non-P2SH multisig (default: 1)
Listen for connections on <port> (default: 8333, testnet: 18333,
regtest: 18444)
Connect through SOCKS5 proxy, set -noproxy to disable (default:
Randomize credentials for every proxy connection. This enables Tor
stream isolation (default: 1)
Connect to a node to retrieve peer addresses, and disconnect. This
option can be specified multiple times to connect to multiple
Specify connection timeout in milliseconds (minimum: 1, default: 5000)
Tor control port to use if onion listening enabled (default:
Tor control port password (default: empty)
Use UPnP to map the listening port (default: 0)
Bind to given address and whitelist peers connecting to it. Use
[host]:port notation for IPv6. Allowed permissions: bloomfilter
(allow requesting BIP37 filtered blocks and transactions), noban
(do not ban for misbehavior), forcerelay (relay transactions that
are already in the mempool; implies relay), relay (relay even in
-blocksonly mode), mempool (allow requesting BIP35 mempool
contents). Specify multiple permissions separated by commas
(default: noban,mempool,relay). Can be specified multiple times.
-whitelist=<[permissions@]IP address or network>
Whitelist peers connecting from the given IP address (e.g. or
CIDR notated network(e.g. Uses same permissions as
-whitebind. Can be specified multiple times.
Wallet options:
What type of addresses to use ("legacy", "p2sh-segwit", or "bech32",
default: "bech32")
Group outputs by address, selecting all or none, instead of selecting on
a per-output basis. Privacy is improved as an address is only
used once (unless someone sends to it after spending from it),
but may result in slightly higher fees as suboptimal coin
selection may result due to the added limitation (default: 0
(always enabled for wallets with "avoid_reuse" enabled))
What type of change to use ("legacy", "p2sh-segwit", or "bech32").
Default is same as -addresstype, except when
-addresstype=p2sh-segwit a native segwit output is used when
sending to a native segwit address)
Do not load the wallet and disable wallet RPC calls
The fee rate (in BTC/kB) that indicates your tolerance for discarding
change by adding it to the fee (default: 0.0001). Note: An output
is discarded if it is dust at this rate, but we will always
discard up to the dust relay fee and a discard fee above that is
limited by the fee estimate for the longest target
A fee rate (in BTC/kB) that will be used when fee estimation has
insufficient data. 0 to entirely disable the fallbackfee feature.
(default: 0.00)
Set key pool size to <n> (default: 1000). Warning: Smaller sizes may
increase the risk of losing funds when restoring from an old
backup, if none of the addresses in the original keypool have
been used.
Fees (in BTC/kB) smaller than this are considered zero fee for
transaction creation (default: 0.00001)
Fee (in BTC/kB) to add to transactions you send (default: 0.00)
Rescan the block chain for missing wallet transactions on startup
Spend unconfirmed change when sending transactions (default: 1)
If paytxfee is not set, include enough fee so transactions begin
confirmation on average within n blocks (default: 6)
Specify wallet database path. Can be specified multiple times to load
multiple wallets. Path is interpreted relative to <walletdir> if
it is not absolute, and will be created if it does not exist (as
a directory containing a wallet.dat file and log files). For
backwards compatibility this will also accept names of existing
data files in <walletdir>.)
Make the wallet broadcast transactions (default: 1)
Specify directory to hold wallets (default: <datadir>/wallets if it
exists, otherwise <datadir>)
Execute command when a wallet transaction changes. %s in cmd is replaced
by TxID and %w is replaced by wallet name. %w is not currently
implemented on windows. On systems where %w is supported, it
should NOT be quoted because this would break shell escaping used
to invoke the command.
Send transactions with full-RBF opt-in enabled (RPC only, default: 0)
Delete all wallet transactions and only recover those parts of the
blockchain through -rescan on startup (1 = keep tx meta data e.g.
payment request information, 2 = drop tx meta data)
Wallet debugging/testing options:
Flush wallet database activity from memory to disk log every <n>
megabytes (default: 100)
Run a thread to flush wallet periodically (default: 1)
Sets the DB_PRIVATE flag in the wallet db environment (default: 1)
Wallet will not create transactions that violate mempool chain limits
(default: 0)
ZeroMQ notification options:
Enable publish hash block in <address>
Set publish hash block outbound message high water mark (default: 1000)
Enable publish hash transaction in <address>
Set publish hash transaction outbound message high water mark (default:
Enable publish raw block in <address>
Set publish raw block outbound message high water mark (default: 1000)
Enable publish raw transaction in <address>
Set publish raw transaction outbound message high water mark (default:
Debugging/Testing options:
Allows to test address relay on localhost
Do a consistency check for the block tree, chainstate, and other
validation data structures occasionally. (default: 0, regtest: 1)
How many blocks to check at startup (default: 6, 0 = all)
How thorough the block verification of -checkblocks is: level 0 reads
the blocks from disk, level 1 verifies block validity, level 2
verifies undo data, level 3 checks disconnection of tip blocks,
level 4 tries to reconnect the blocks, each level includes the
checks of the previous levels (0-4, default: 3)
Run checks every <n> transactions (default: 0, regtest: 1)
Enable rejection of any forks from the known historical chain until
block 295000 (default: 1)
Output debugging information (default: -nodebug, supplying <category> is
optional). If <category> is not supplied or if <category> = 1,
output all debugging information. <category> can be: net, tor,
mempool, http, bench, zmq, walletdb, rpc, estimatefee, addrman,
selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej,
libevent, coindb, qt, leveldb, validation.
Exclude debugging information for a category. Can be used in conjunction
with -debug=1 to output debug logs for all categories except one
or more specified categories.
Allows deprecated RPC method(s) to be used
Randomly drop 1 of every <n> network messages
Print help message with debugging options and exit
Do not accept transactions if number of in-mempool ancestors is <n> or
more (default: 25)
Do not accept transactions whose size with all in-mempool ancestors
exceeds <n> kilobytes (default: 101)
Do not accept transactions if any ancestor would have <n> or more
in-mempool descendants (default: 25)
Do not accept transactions if any ancestor would have more than <n>
kilobytes of in-mempool descendants (default: 101).
Include IP addresses in debug output (default: 0)
Prepend debug output with name of the originating thread (only available
on platforms supporting thread_local) (default: 0)
Add microsecond precision to debug timestamps (default: 0)
Prepend debug output with timestamp (default: 1)
Limit sum of signature cache and script execution cache sizes to <n> MiB
(default: 32)
Maximum tip age in seconds to consider node in initial block download
(default: 86400)
Maximum total fees (in BTC) to use in a single wallet transaction;
setting this too low may abort large transactions (default: 0.10)
Replace actual time with UNIX epoch time (default: 0)
Log transaction fee per kB when mining blocks (default: 0)
Send trace/debug info to console (default: 1 when no -daemon. To disable
logging to file, set -nodebuglogfile)
Set the activation height of segwit. -1 to disable. (regtest-only)
Shrink debug.log file on client startup (default: 1 when no -debug)
Stop running after importing blocks from disk (default: 0)
Stop running after reaching the given height in the main chain (default:
Append comment to the user agent string
Chain selection options:
Use the chain <chain> (default: main). Allowed values: main, test,
Enter regression test mode, which uses a special chain in which blocks
can be solved instantly. This is intended for regression testing
tools and app development. Equivalent to -chain=regtest.
Use the test chain. Equivalent to -chain=test.
Use given start/end times for specified version bits deployment
Node relay options:
Relay and mine "non-standard" transactions (testnet/regtest only;
default: 1)
Equivalent bytes per sigop in transactions for relay and mining
(default: 20)
Relay and mine data carrier transactions (default: 1)
Maximum size of data in data carrier transactions we relay and mine
(default: 83)
Fee rate (in BTC/kB) used to define dust, the value of an output such
that it will cost more than its value in fees at this fee rate to
spend it. (default: 0.00003)
Fee rate (in BTC/kB) used to define cost of relay, used for mempool
limiting and BIP 125 replacement. (default: 0.00001)
Fees (in BTC/kB) smaller than this are considered zero fee for relaying,
mining and transaction creation (default: 0.00001)
Add 'forcerelay' permission to whitelisted inbound peers with default
permissions. This will relay transactions even if the
transactions were already in the mempool. (default: 0)
Add 'relay' permission to whitelisted inbound peers with default
permissions. This will accept relayed transactions even when not
relaying transactions (default: 1)
Block creation options:
Set maximum BIP141 block weight (default: 3996000)
Set lowest fee rate (in BTC/kB) for transactions to be included in block
creation. (default: 0.00001)
Override block version to test forking scenarios
RPC server options:
Accept public REST requests (default: 0)
Allow JSON-RPC connections from specified source. Valid for <ip> are a
single IP (e.g., a network/netmask (e.g. or a network/CIDR (e.g. This
option can be specified multiple times
Username and HMAC-SHA-256 hashed password for JSON-RPC connections. The
field <userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A
canonical python script is included in share/rpcauth. The client
then connects normally using the
rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This
option can be specified multiple times
Bind to given address to listen for JSON-RPC connections. Do not expose
the RPC server to untrusted networks such as the public internet!
This option is ignored unless -rpcallowip is also passed. Port is
optional and overrides -rpcport. Use [host]:port notation for
IPv6. This option can be specified multiple times (default: and ::1 i.e., localhost)
Location of the auth cookie. Relative paths will be prefixed by a
net-specific datadir location. (default: data dir)
Password for JSON-RPC connections
Listen for JSON-RPC connections on <port> (default: 8332, testnet:
18332, regtest: 18443)
Sets the serialization of raw transaction or block hex returned in
non-verbose mode, non-segwit(0) or segwit(1) (default: 1)
Timeout during HTTP requests (default: 30)
Set the number of threads to service RPC calls (default: 4)
Username for JSON-RPC connections
Set a whitelist to filter incoming RPC calls for a specific user. The
field <whitelist> comes in the format: <USERNAME>:<rpc 1>,<rpc
2>,...,<rpc n>. If multiple whitelists are set for a given user,
they are set-intersected. See -rpcwhitelistdefault documentation
for information on default whitelist behavior.
Sets default behavior for rpc whitelisting. Unless rpcwhitelistdefault
is set to 0, if any -rpcwhitelist is set, the rpc server acts as
if all rpc users are subject to empty-unless-otherwise-specified
whitelists. If rpcwhitelistdefault is set to 1 and no
-rpcwhitelist is set, rpc server acts as if all rpc users are
subject to empty whitelists.
Set the depth of the work queue to service RPC calls (default: 16)
Accept command line and JSON-RPC commands
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment