GetBestBlockHashreturns the header hash of the most recent block on the best block chain.
GetBlockgets a block with a particular header hash from the local block database either as a JSON object or as a serialized block.
GetBlockChainInfoprovides information about the current state of the block chain.
GetBlockCountreturns the number of blocks in the local best block chain.
GetBlockHashreturns the header hash of a block at the given height in the local best block chain.
GetBlockHeadergets a block header with a particular header hash from the local block database either as a JSON object or as a serialized block header.
GetChainTipsreturns information about the highest-height block (tip) of each local block chain.
GetDifficultyreturns the proof-of-work difficulty as a multiple of the minimum difficulty.
GetMemPoolAncestorsreturns all in-mempool ancestors for a transaction in the mempool.
GetMemPoolDescendantsreturns all in-mempool descendants for a transaction in the mempool.
GetMemPoolEntryreturns mempool data for given transaction (must be in mempool).
GetMemPoolInforeturns information about the node’s current transaction memory pool.
GetRawMemPoolreturns 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.
GetTxOutreturns details about a transaction output. Only unspent transaction outputs (UTXOs) are guaranteed to be available.
GetTxOutProofreturns a hex-encoded proof that one or more specified transactions were included in a block.
GetTxOutSetInforeturns 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.
PreciousBlocktreats a block as if it were received before others with the same work.
PruneBlockChainprunes the blockchain up to a specified height or timestamp.
VerifyChainverifies each entry in the local block chain database.
VerifyTxOutProofverifies 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.
GetInfoprints various information about the node and the network. Deprecated
Helplists 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.
Stopsafely shuts down the Bitcoin Core server.
Generatenearly instantly generates blocks.
GenerateToAddressmines blocks immediately to a specified address.
GetBlockTemplategets a block template or proposal for use with mining software.
GetMiningInforeturns various mining-related information.
GetNetworkHashPSreturns the estimated current or historical network hashes per second based on the last n blocks.
PrioritiseTransactionadds 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.)
SubmitBlockaccepts 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.
AddNodeattempts to add or remove a node from the addnode list, or to try a connection to a node once.
ClearBannedclears list of banned nodes.
DisconnectNodeimmediately disconnects from a specified node.
GetAddedNodeInforeturns 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.
GetConnectionCountreturns the number of connections to other nodes.
GetNetTotalsreturns information about network traffic, including bytes in, bytes out, and the current time.
GetNetworkInforeturns information about the node’s connection to the network.
GetPeerInforeturns data about each connected network node.
ListBannedlists all banned IPs/Subnets.
Pingsends 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.
SetBanattempts add or remove a IP/Subnet from the banned list.
SetNetworkActivedisables/enables all P2P network activity.
Raw Transaction RPCs
CreateRawTransactioncreates 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.
FundRawTransactionadds inputs to a transaction until it has enough in value to meet its out value.
DecodeRawTransactiondecodes a serialized transaction hex string into a JSON object describing the transaction.
DecodeScriptdecodes a hex-encoded P2SH redeem script.
GetRawTransactiongets 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.
SendRawTransactionvalidates a transaction and broadcasts it to the peer-to-peer network.
SignRawTransactionsigns a transaction in the serialized transaction format using private keys stored in the wallet or provided in the call.
CreateMultiSigcreates a P2SH multi-signature address.
EstimateFeeestimates the transaction fee per kilobyte that needs to be paid for a transaction to be included within a certain number of blocks. Deprecated
EstimatePriorityestimates the priority that a transaction needs in order to be included within a certain number of blocks as a free high-priority transaction. Deprecated
GetMemoryInforeturns information about memory usage.
ValidateAddressreturns information about the given Bitcoin address.
VerifyMessageverifies a signed message.
AbandonTransactionmarks an in-wallet transaction and all its in-wallet descendants as abandoned. This allows their inputs to be respent.
BackupWalletsafely copies wallet.dat to the specified file, which can be a directory or a path with filename.
BumpFeereplaces an unconfirmed wallet transaction that signaled RBF with a new transaction that pays a higher fee.
DumpPrivKeyreturns the wallet-import-format (WIP) private key corresponding to an address. (But does not remove it from the wallet.)
DumpWalletcreates or overwrites a file with all wallet keys in a human-readable format.
EncryptWalletencrypts 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.
GetAccountAddressreturns 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. Deprecated
GetAccountreturns the name of the account associated with the given address.
GetAddressesByAccountreturns a list of every address assigned to a particular account. Deprecated
GetBalancegets the balance in decimal bitcoins across all accounts or for a particular account.
GetNewAddressreturns a new Bitcoin address for receiving payments. If an account is specified, payments received with the address will be credited to that account.
GetRawChangeAddressreturns a new Bitcoin address for receiving change. This is for use with raw transactions, not normal use.
GetReceivedByAccountreturns the total amount received by addresses in a particular account from transactions with the specified number of confirmations. It does not count coinbase transactions. Deprecated
GetReceivedByAddressreturns the total amount received by the specified address in transactions with the specified number of confirmations. It does not count coinbase transactions.
GetTransactiongets detailed information about an in-wallet transaction.
GetUnconfirmedBalancereturns the wallet’s total unconfirmed balance.
GetWalletInfoprovides information about the wallet.
ImportAddressadds 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.
ImportMultiimports addresses or scripts (with private keys, public keys, or P2SH redeem scripts) and optionally performs the minimum necessary rescan for all imports.
ImportPrunedFundsimports funds without the need of a rescan. Meant for use with pruned wallets.
ImportPrivKeyadds a private key to your wallet. The key should be formatted in the wallet import format created by the dumpprivkey RPC.
ImportWalletimports 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.
KeyPoolRefillfills the cache of unused pre-generated keys (the keypool).
ListAccountslists accounts and their balances. Deprecated
ListAddressGroupingslists 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.
ListLockUnspentreturns a list of temporarily unspendable (locked) outputs.
ListReceivedByAccountlists the total number of bitcoins received by each account. Deprecated
ListReceivedByAddresslists the total number of bitcoins received by each address.
ListSinceBlockgets all transactions affecting the wallet which have occurred since a particular block, plus the header hash of a block at a particular depth.
ListTransactionsreturns the most recent transactions that affect the wallet.
ListUnspentreturns an array of unspent transaction outputs belonging to this wallet.
LockUnspenttemporarily 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.
Movemoves a specified amount from one account in your wallet to another using an off-block-chain transaction. Deprecated
RemovePrunedFundsdeletes the specified transaction from the wallet. Meant for use with pruned wallets and as a companion to importprunedfunds.
SendFromspends an amount from a local account to a bitcoin address. Deprecated
SendManycreates and broadcasts a transaction which sends outputs to multiple addresses.
SendToAddressspends an amount to a given address.
SetAccountputs the specified address in the given account. Deprecated
SetTxFeesets the transaction fee per kilobyte paid by transactions created by this wallet.
SignMessagesigns a message with the private key of an address.
SignMessageWithPrivKeysigns a message with a given private key.
WalletLockremoves 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.
WalletPassphrasestores 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.
WalletPassphraseChangechanges the wallet passphrase from ‘old passphrase’ to ‘new passphrase’.