• abandontransaction "txid" Marks an in-wallet transaction and all its in-wallet descendants as abandoned. This allows their inputs to be respent.
• abortrescan none Stops current wallet rescan triggered by an RPC call, e.g. by an importprivkey call.
• addmultisigaddress nrequired ["key",...] ( "label" "address_type" ) Adds a P2SH multisig address to the wallet.
• addnode "node" "add|remove|onetry" Attempts to add or remove a node from the addnode list, or to try a connection to a node once.
• analyzepsbt "psbt" Examines a PSBT and provides information about what the PSBT contains and the next steps that need to be taken in order to complete the transaction. For each input of a PSBT, analyzepsbt provides information about what information is missing for that input, including whether a UTXO needs to be provided, what pubkeys still need to be provided, which scripts need to be provided, and what signatures are still needed. Every input will also list which role is needed to complete that input, and analyzepsbt will also list the next role in general needed to complete the PSBT. analyzepsbt will also provide the estimated fee rate and estimated virtual size of the completed transaction if it has enough information to do so.
• backupwallet "destination" Safely copies `wallet.dat` to the specified file, which can be a directory or a path with filename.
• bumpfee "txid" ( options ) Replaces an unconfirmed wallet transaction that signaled RBF with a new transaction that pays a higher fee.
• clearbanned none Clears list of banned nodes.
• combinepsbt ["psbt",...] Implements a Combiner. It can be used at any point in the workflow to merge information added to different versions of the same PSBT. In particular it is useful to combine the output of multiple Updaters or Signers.
• combinerawtransaction ["hexstring",...] Combines multiple partially signed transactions into one transaction. The combined transaction may be another partially signed transaction or a fully signed transaction.
• converttopsbt "hexstring" ( permitsigdata iswitness ) Converts an unsigned raw transaction to PSBT format. It ignores existing signatures.
• createmultisig nrequired ["key",...] ( "address_type" ) Creates a P2SH multi-signature address.
• createpsbt [{"txid":"id","vout":n},...] [{"address":amount},{"data":"hex"},...] ( locktime ) ( replaceable ) Takes a list of inputs and outputs and converts them to a PSBT with no additional information. It is equivalent to calling createrawtransaction followed by converttopsbt.
• createrawtransaction [{"txid":"id","vout":n},...] [{"address":amount},{"data":"hex"},...] ( locktime ) ( replaceable ) Creates an unsigned serialized transaction that spends a previous output to a new output with a P2PKH or P2SH address. The transaction is not stored in the wallet or transmitted to the network.
• createwallet "wallet_name" ( disable_private_keys ) Creates and loads a new wallet.
• decodepsbt "psbt" Shows all information in a PSBT in human-readable form, as well as compute its eventual fee if known.
• decoderawtransaction "hexstring" ( iswitness ) Decodes a serialized transaction hex string into a JSON object describing the transaction.
• decodescript "hexstring" Decodes a hex-encoded P2SH redeem script.
• deriveaddresses "descriptor" ( range ) Returns one or more addresses corresponding to an output descriptor.
• disconnectnode "[address]" [nodeid] Immediately disconnects from a specified node.
• dumpprivkey "address" Returns the wallet-import-format (WIF) private key corresponding to an address. (But does not remove it from the wallet.)
• dumpwallet "filename" Creates or overwrites a file with all wallet keys in a human-readable format.
• encryptwallet "passphrase" Encrypts the wallet with a passphrase. This is only to enable encryption for the first time. After encryption is enabled, you will need to enter the passphrase to use private keys.
• estimaterawfee conf_target (threshold) Estimates the approximate fee per kilobyte needed for a transaction to begin confirmation within conf_target blocks if possible. External clients can query and use this data in their own fee estimation logic.
• estimatesmartfee conf_target ("estimate_mode") Estimates the approximate fee per kilobyte needed for a transaction to begin confirmation within conf_target blocks if possible and return the number of blocks for which the estimate is valid.
• finalizepsbt "psbt" ( extract ) Finalizes any partial signatures, and if all inputs are finalized, converts the result to a fully signed transaction which can be broadcast with sendrawtransaction.
• fundrawtransaction "hexstring" ( options iswitness ) Adds inputs to a transaction until it has enough in value to meet its out value.
• generate nblocks ( maxtries ) Nearly instantly generates blocks.
• generatetoaddress nblocks address (maxtries) Mines blocks immediately to a specified address.
• getaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts) Returns the name of the account associated with the given address.
• getaccountaddress (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts) Returns the current Bitcoin address for receiving payments to this account. If the account doesn't exist, it creates both the account and a new address for receiving payment. Once a payment has been received to an address, future calls to this RPC for the same account will return a different address.
• getaddednodeinfo ( "node" ) Returns information about the given added node, or all added nodes (except onetry nodes). Only nodes which have been manually added using the `addnode` RPC will have their information displayed.
• getaddressbyaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts) Returns a list of every address assigned to a particular account.
• getaddressesbylabel "label" Returns the list of addresses assigned the specified label.
• getaddressinfo "address" Returns information about the given bitcoin address. Some information requires the address to be in the wallet.
• getbalance ( "(dummy)" minconf include_watchonly ) Gets the balance in decimal bitcoins across all accounts or for a particular account.
• getbestblockhash none Returns the header hash of the most recent block on the best block chain.
• getblock "blockhash" ( verbosity ) Gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block.
• getblockchaininfo none Provides information about the current state of the block chain.
• getblockcount none Returns the number of blocks in the local best block chain.
• getblockhash height Returns the header hash of a block at the given height in the local best block chain.
• getblockheader "hash" ( verbose ) Gets a block header with a particular header hash from the local block database either as a JSON object or as a serialized block header.
• getblockstats hash_or_height ( stats ) Computes per block statistics for a given window. All amounts are in satoshis.
• getblocktemplate ( TemplateRequest ) Gets a block template or proposal for use with mining software.
• getchaintips none Returns information about the highest-height block (tip) of each local block chain.
• getchaintxstats ( nblocks blockhash ) Computes statistics about the total number and rate of transactions in the chain.
• getconnectioncount none Returns the number of connections to other nodes.
• getdescriptorinfo "descriptor" Accepts a descriptor and returns information about it, including its computed checksum.
• getdifficulty none Returns the proof-of-work difficulty as a multiple of the minimum difficulty.
• getmemoryinfo ("mode") Returns information about memory usage.
• getmempoolancestors txid (verbose) Returns all in-mempool ancestors for a transaction in the mempool.
• getmempooldescendants txid (verbose) Returns all in-mempool descendants for a transaction in the mempool.
• getmempoolentry txid Returns mempool data for given transaction (must be in mempool).
• getmempoolinfo none Returns information about the node's current transaction memory pool.
• getmininginfo none Returns various mining-related information.
• getnettotals none Returns information about network traffic, including bytes in, bytes out, and the current time.
• getnetworkhashps ( nblocks height ) Returns the estimated current or historical network hashes per second based on the last *n* blocks.
• getnetworkinfo none Returns information about the node's connection to the network.
• getnewaddress ( "label" "address_type" ) Returns a new Bitcoin address for receiving payments. If an account is specified, payments received with the address will be credited to that account.
• getnodeaddresses ( count ) Returns peer addresses known to this node. It may be used to find nodes to connect to without using a DNS seeder.
• getpeerinfo none Returns data about each connected network node.
• getrawchangeaddress ( "address_type" ) Returns a new Bitcoin address for receiving change. This is for use with raw transactions, not normal use.
• getrawmempool ( verbose ) Returns all transaction identifiers (TXIDs) in the memory pool as a JSON array, or detailed information about each transaction in the memory pool as a JSON object.
• getrawtransaction "txid" ( verbose "blockhash" ) Gets a hex-encoded serialized transaction or a JSON object describing the transaction. By default, Bitcoin Core only stores complete transaction data for UTXOs and your own transactions, so the RPC may fail on historic transactions unless you use the non-default `txindex=1` in your Bitcoin Core startup settings.
• getreceivedbyaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts) Returns the total amount received by addresses in a particular account from transactions with the specified number of confirmations. It does not count coinbase transactions.
• getreceivedbyaddress "address" ( minconf ) Returns the total amount received by the specified address in transactions with the specified number of confirmations. It does not count coinbase transactions.
• getreceivedbylabel "label" minconf Returns the total amount received by addresses with in transactions with at least [minconf] confirmations.
• getrpcinfo none Returns runtime details of the RPC server. At the moment, it returns an array of the currently active commands and how long they’ve been running.
• gettransaction "txid" ( include_watchonly ) Gets detailed information about an in-wallet transaction.
• gettxout "txid" n ( include_mempool ) Returns details about an unspent transaction output (UTXO).
• gettxoutproof ["txid",...] ( blockhash ) Returns a hex-encoded proof that one or more specified transactions were included in a block.
• gettxoutsetinfo none Returns statistics about the confirmed unspent transaction output (UTXO) set. Note that this call may take some time and that it only counts outputs from confirmed transactions---it does not count outputs from the memory pool.
• getunconfirmedbalance none Returns the wallet's total unconfirmed balance.
• getwalletinfo none Provides information about the wallet.
• getzmqnotifications none Returns information about the active ZeroMQ notifications.
• help ( "command" ) Lists all available public RPC commands, or gets help for the specified RPC. Commands which are unavailable will not be listed, such as wallet RPCs if wallet support is disabled.
• importaddress "address" ( "label" rescan p2sh ) Adds an address or pubkey script to the wallet without the associated private key, allowing you to watch for transactions affecting that address or pubkey script without being able to spend any of its outputs.
• importmulti "requests" ( "options" ) Imports addresses or scripts (with private keys, public keys, or P2SH redeem scripts) and optionally performs the minimum necessary rescan for all imports.
• importprivkey "privkey" ( "label" ) ( rescan ) Adds a private key to your wallet. The key should be formatted in the wallet import format created by the `dumpprivkey` RPC.
• importprunedfunds none Imports funds without the need of a rescan. Meant for use with pruned wallets.
• importpubkey "pubkey" ( "label" rescan ) Adds a public key (in hex) that can be watched as if it were in your wallet but cannot be used to spend. Requires a new wallet backup.
• importwallet "filename" Imports private keys from a file in wallet dump file format (see the `dumpwallet` RPC). These keys will be added to the keys currently in the wallet. This call may need to rescan all or parts of the block chain for transactions affecting the newly-added keys, which may take several minutes.
• joinpsbts ["psbt",...] Merges multiple distinct PSBTs into a single PSBT. The multiple PSBTs must have different inputs. The resulting PSBT will contain every input and output from all of the PSBTs. Any signatures provided in any of the PSBTs will be dropped.
• keypoolrefill ( newsize ) Fills the cache of unused pre-generated keys (the keypool).
• listaccounts (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts) Lists accounts and their balances.
• listaddressgroupings none Lists groups of addresses that may have had their common ownership made public by common use as inputs in the same transaction or from being used as change from a previous transaction.
• listbanned none Lists all banned IPs/Subnets.
• listlabels ( "purpose" ) Returns the list of all labels, or labels that are assigned to addresses with a specific purpose.
• listlockunspent none Returns a list of temporarily unspendable (locked) outputs.
• listreceivedbyaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts) Lists the total number of bitcoins received by each account.
• listreceivedbyaddress ( minconf include_empty include_watchonly address_filter ) Lists the total number of bitcoins received by each address.
• listreceivedbylabel minconf include_empty include_watchonly Lists received transactions by label.
• listsinceblock ( "blockhash" target_confirmations include_watchonly include_removed ) Gets all transactions affecting the wallet which have occurred since a particular block, plus the header hash of a block at a particular depth.
• listtransactions (dummy count skip include_watchonly) Returns the most recent transactions that affect the wallet.
• listunspent ( minconf maxconf ["addresses",...] [include_unsafe] [query_options]) Returns an array of unspent transaction outputs belonging to this wallet.
• listwalletdir none Returns a list of wallets in the wallet directory (either the default wallet directory or the directory configured by the -walletdir parameter).
• listwallets none Returns a list of currently loaded wallets.
• loadwallet "filename" Loads a wallet from a wallet file or directory.
• lockunspent unlock ([{"txid":"txid","vout":n},...]) Temporarily locks or unlocks specified transaction outputs. A locked transaction output will not be chosen by automatic coin selection when spending bitcoins. Locks are stored in memory only, so nodes start with zero locked outputs and the locked output list is always cleared when a node stops or fails.
• logging ( <include> <exclude> ) Gets and sets the logging configuration.
• move (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts) Moves a specified amount from one account in your wallet to another using an off-block-chain transaction.
• ping none Sends a P2P ping message to all connected nodes to measure ping time. Results are provided by the `getpeerinfo` RPC pingtime and pingwait fields as decimal seconds. The P2P `ping` message is handled in a queue with all other commands, so it measures processing backlog, not just network ping.
• preciousblock "blockhash" Treats a block as if it were received before others with the same work.
• prioritisetransaction <txid> <dummy value> <fee delta> Adds virtual priority or fee to a transaction, allowing it to be accepted into blocks mined by this node (or miners which use this node) with a lower priority or fee. (It can also remove virtual priority or fee, requiring the transaction have a higher priority or fee to be accepted into a locally-mined block.)
• pruneblockchain "height" Prunes the blockchain up to a specified height or timestamp.
• removeprunedfunds "txid" Deletes the specified transaction from the wallet. Meant for use with pruned wallets and as a companion to importprunedfunds.
• rescanblockchain ("start_height") ("stop_height") Rescan the local blockchain for wallet related transactions.
• savemempool none Allows the current mempool to be saved to disk at any time to avoid it being lost due to crashes / power loss.
• scantxoutset <action> ( <scanobjects> ) Scan the UTXO set for entries that match certain output descriptors.
• sendfrom (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts) Spends an amount from a local account to a bitcoin address.
• sendmany "" {"address":amount,...} ( minconf "comment" ["address",...] replaceable conf_target "estimate_mode") Creates and broadcasts a transaction which sends outputs to multiple addresses.
• sendrawtransaction "hexstring" ( allowhighfees ) Validates a transaction and broadcasts it to the peer-to-peer network.
• sendtoaddress "address" amount ( "comment" "comment_to" subtractfeefromamount replaceable conf_target "estimate_mode") Spends an amount to a given address.
• setaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts) Puts the specified address in the given account.
• setban "subnet" "add|remove" (bantime) (absolute) Attempts add or remove a IP/Subnet from the banned list.
• sethdseed ( "newkeypool" "seed" ) Allows users to set a new HD seed or set their own HD seed. This allows for a new HD seed to be used. A new backup must be made when a new HD seed is set.
• setlabel "address" "label" Intended as a replacement for the deprecated 'account' API.
• setnetworkactive true|false Disables/enables all P2P network activity.
• settxfee amount Sets the transaction fee per kilobyte paid by transactions created by this wallet.
• signmessage "address" "message" Signs a message with the private key of an address.
• signmessagewithprivkey "privkey" "message" Signs a message with a given private key.
• signrawtransaction "hexstring" ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] ["privatekey1",...] sighashtype ) Signs a transaction in the serialized transaction format using private keys stored in the wallet or provided in the call.
• signrawtransactionwithkey "hexstring" ["privatekey1",...] ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] sighashtype ) Signs inputs for raw transaction
• signrawtransactionwithwallet "hexstring" ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] sighashtype ) Signs inputs for raw transaction
• stop none Safely shuts down the Bitcoin Core server.
• submitblock "hexdata" ( "dummy" ) Accepts a block, verifies it is a valid addition to the block chain, and broadcasts it to the network. Extra parameters are ignored by Bitcoin Core but may be used by mining pools or other programs.
• submitheader "hexdata" Decodes the given hexdata as a header and submits it as a candidate chain tip if valid.
• testmempoolaccept ["rawtxs"] ( allowhighfees ) Tests acceptance of a transaction to the mempool without adding it.
• unloadwallet ( "wallet_name" ) Unloads the wallet referenced by the request endpoint otherwise unloads the wallet specified in the argument.
• uptime none Returns the total uptime of the server in seconds.
• utxoupdatepsbt "psbt" Searches the set of Unspent Transaction Outputs (UTXOs) to find the outputs being spent by the partial transaction. PSBTs need to have the UTXOs being spent to be provided because the signing algorithm requires information from the UTXO being spent. For segwit inputs, only the UTXO itself is necessary. For non-segwit outputs, the entire previous transaction is needed so that signers can be sure that they are signing the correct thing. Unfortunately, because the UTXO set only contains UTXOs and not full transactions, utxoupdatepsbt will only add the UTXO for segwit inputs.
• validateaddress "address" Returns information about the given Bitcoin address.
• verifychain ( checklevel nblocks ) Verifies each entry in the local block chain database.
• verifymessage "address" "signature" "message" Verifies a signed message.
• verifytxoutproof "proof" Verifies that a proof points to one or more transactions in a block, returning the transactions the proof commits to and throwing an RPC error if the block is not in our best block chain.
• walletcreatefundedpsbt [{"txid":"id","vout":n},...] [{"address":amount},{"data":"hex"},...] ( locktime ) ( replaceable ) ( options bip32derivs ) Creates a PSBT with the specified inputs and outputs, adds additional inputs and change to it to balance it out, and adds relevant metadata. In particular, for inputs that the wallet knows about (counting towards its normal or watch-only balance), UTXO information will be added. For outputs and inputs with UTXO information present, key and script information will be added which the wallet knows about. It is equivalent to running createrawtransaction, followed by fundrawtransaction, and converttopsbt.
• walletlock none Removes the wallet encryption key from memory, locking the wallet. After calling this method, you will need to call `walletpassphrase` again before being able to call any methods which require the wallet to be unlocked.
• walletpassphrase "passphrase" timeout Stores the wallet decryption key in memory for the indicated number of seconds. Issuing the `walletpassphrase` command while the wallet is already unlocked will set a new unlock time that overrides the old one.
• walletpassphrasechange "oldpassphrase" "newpassphrase" Changes the wallet passphrase from 'old passphrase' to 'new passphrase'.
• walletprocesspsbt "psbt" ( sign "sighashtype" bip32derivs ) Takes as input a PSBT, adds UTXO, key, and script data to inputs and outputs that miss it, and optionally signs inputs. Where possible it also finalizes the partial signatures.