Skip to content

Bitcoin Cash Node RPC client version v23.0.1-13f5ed3

Usage Description
bitcoin-cli [options] <command> [params] Send command to Bitcoin Cash Node
bitcoin-cli [options] -named <command> [name=value]... Send command to Bitcoin Cash Node (with named arguments)
bitcoin-cli [options] help List commands
bitcoin-cli [options] help <command> Get help for a command


Argument Description
-?, -h, -help Print this help message and exit
-conf=<file> Specify configuration file. Relative paths will be prefixed by datadir location. (default: bitcoin.conf)
-datadir=<dir> Specify data directory
-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)
-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:
-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, testnet4: 28332, scalenet: 38332, regtest: 18443)
-rpcuser=<user> Username for JSON-RPC connections
-rpcwait Wait for RPC server to start
-rpcwallet=<walletname> Send RPC for non-default wallet on RPC server (needs to exactly match corresponding -wallet option passed to bitcoind)
-stdin Read extra arguments from standard input, one per line until EOF/Ctrl-D (recommended for sensitive information such as passphrases)
-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.
-version Print version and exit

Chain selection options

Argument Description
-regtest 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.
-scalenet Use the scaling test chain
-testnet Use the test chain
-testnet4 Use the test4 chain

Documentation on reflects the current master branch in Git, and may include API changes that are not yet present in the latest release.