Last active
August 6, 2022 06:06
-
-
Save b-rucel/05a3dfc7c44fbdb3f5db419c879d42f9 to your computer and use it in GitHub Desktop.
bitcoin-cli
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Bitcoin Core RPC client version v23.0.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 | |
Options: | |
-? | |
Print this help message and exit | |
-addrinfo | |
Get the number of addresses known to the node, per network and total, | |
after filtering for quality and recency. The total number of | |
addresses known to the node may be higher. | |
-color=<when> | |
Color setting for CLI output (default: auto). Valid values: always, auto | |
(add color codes when standard output is connected to a terminal | |
and OS is not WIN32), never. | |
-conf=<file> | |
Specify configuration file. Relative paths will be prefixed by datadir | |
location. (default: bitcoin.conf) | |
-datadir=<dir> | |
Specify data directory | |
-generate | |
Generate blocks, equivalent to RPC getnewaddress followed by RPC | |
generatetoaddress. Optional positional integer arguments are | |
number of blocks to generate (default: 1) and maximum iterations | |
to try (default: 1000000), equivalent to RPC generatetoaddress | |
nblocks and maxtries arguments. Example: bitcoin-cli -generate 4 | |
1000 | |
-getinfo | |
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) | |
-named | |
Pass named instead of positional arguments (default: false) | |
-netinfo | |
Get network peer connection information from the remote server. An | |
optional integer argument from 0 to 4 can be passed for different | |
peers listings (default: 0). Pass "help" for detailed help | |
documentation. | |
-rpcclienttimeout=<n> | |
Timeout in seconds during HTTP requests, or 0 for no timeout. (default: | |
900) | |
-rpcconnect=<ip> | |
Send commands to node running on <ip> (default: 127.0.0.1) | |
-rpccookiefile=<loc> | |
Location of the auth cookie. Relative paths will be prefixed by a | |
net-specific datadir location. (default: data dir) | |
-rpcpassword=<pw> | |
Password for JSON-RPC connections | |
-rpcport=<port> | |
Connect to JSON-RPC on <port> (default: 8332, testnet: 18332, signet: | |
38332, regtest: 18443) | |
-rpcuser=<user> | |
Username for JSON-RPC connections | |
-rpcwait | |
Wait for RPC server to start | |
-rpcwaittimeout=<n> | |
Timeout in seconds to wait for the RPC server to start, or 0 for no | |
timeout. (default: 0) | |
-rpcwallet=<walletname> | |
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. | |
http://127.0.0.1:8332/wallet/<walletname> | |
-stdin | |
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. | |
-stdinrpcpass | |
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. | |
-stdinwalletpassphrase | |
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. | |
-version | |
Print version and exit | |
Debugging/Testing options: | |
Chain selection options: | |
-chain=<chain> | |
Use the chain <chain> (default: main). Allowed values: main, test, | |
signet, regtest | |
-signet | |
Use the signet chain. Equivalent to -chain=signet. Note that the network | |
is defined by the -signetchallenge parameter | |
-signetchallenge | |
Blocks must satisfy the given script to be considered valid (only for | |
signet networks; defaults to the global default signet test | |
network challenge) | |
-signetseednode | |
Specify a seed node for the signet network, in the hostname[:port] | |
format, e.g. sig.net:1234 (may be used multiple times to specify | |
multiple seed nodes; defaults to the global default signet test | |
network seed node(s)) | |
-testnet | |
Use the test chain. Equivalent to -chain=test. | |
bitcoin-cli [options] <command> [params] | |
>>> | |
== Blockchain == | |
getbestblockhash | |
getblock "blockhash" ( verbosity ) | |
getblockchaininfo | |
getblockcount | |
getblockfilter "blockhash" ( "filtertype" ) | |
getblockfrompeer "blockhash" peer_id | |
getblockhash height | |
getblockheader "blockhash" ( verbose ) | |
getblockstats hash_or_height ( stats ) | |
getchaintips | |
getchaintxstats ( nblocks "blockhash" ) | |
getdeploymentinfo ( "blockhash" ) | |
getdifficulty | |
getmempoolancestors "txid" ( verbose ) | |
getmempooldescendants "txid" ( verbose ) | |
getmempoolentry "txid" | |
getmempoolinfo | |
getrawmempool ( verbose mempool_sequence ) | |
gettxout "txid" n ( include_mempool ) | |
gettxoutproof ["txid",...] ( "blockhash" ) | |
gettxoutsetinfo ( "hash_type" hash_or_height use_index ) | |
preciousblock "blockhash" | |
pruneblockchain height | |
savemempool | |
scantxoutset "action" ( [scanobjects,...] ) | |
verifychain ( checklevel nblocks ) | |
verifytxoutproof "proof" | |
== Control == | |
getmemoryinfo ( "mode" ) | |
getrpcinfo | |
help ( "command" ) | |
logging ( ["include_category",...] ["exclude_category",...] ) | |
stop | |
uptime | |
== Mining == | |
getblocktemplate ( "template_request" ) | |
getmininginfo | |
getnetworkhashps ( nblocks height ) | |
prioritisetransaction "txid" ( dummy ) fee_delta | |
submitblock "hexdata" ( "dummy" ) | |
submitheader "hexdata" | |
== Network == | |
addnode "node" "command" | |
clearbanned | |
disconnectnode ( "address" nodeid ) | |
getaddednodeinfo ( "node" ) | |
getconnectioncount | |
getnettotals | |
getnetworkinfo | |
getnodeaddresses ( count "network" ) | |
getpeerinfo | |
listbanned | |
ping | |
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 ) | |
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]},...] ) | |
== Signer == | |
enumeratesigners | |
== Util == | |
createmultisig nrequired ["key",...] ( "address_type" ) | |
deriveaddresses "descriptor" ( range ) | |
estimatesmartfee conf_target ( "estimate_mode" ) | |
getdescriptorinfo "descriptor" | |
getindexinfo ( "index_name" ) | |
signmessagewithprivkey "privkey" "message" | |
validateaddress "address" | |
verifymessage "address" "signature" "message" | |
== Zmq == | |
getzmqnotifications |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment