Bitcoin Core APIs

Hash Byte Order

Bitcoin Core RPCs accept and return the byte-wise reverse of computed SHA-256 hash values. For example, the Unix sha256sum command displays the SHA256(SHA256()) hash of mainnet block 300,000’s header as:

> /bin/echo -n '020000007ef055e1674d2e6551dba41cd214debbee34aeb544c7ec670000000000000000d3998963f80c5bab43fe8c26228e98d030edf4dcbe48a666f5c39e2d7a885c9102c86d536c890019593a470d' | xxd -r -p | sha256sum -b | xxd -r -p | sha256sum -b
5472ac8b1187bfcf91d6d218bbda1eb2405d7c55f1f8cc820000000000000000

The result above is also how the hash appears in the previous-header-hash part of block 300,001’s header:

020000005472ac8b1187bfcf91d6d218bbda1eb2405d7c55f1f8cc82000\
0000000000000ab0aaa377ca3f49b1545e2ae6b0667a08f42e72d8c24ae\
237140e28f14f3bb7c6bcc6d536c890019edd83ccf

However, Bitcoin Core’s RPCs use the byte-wise reverse for hashes, so if you want to get information about block 300,000 using the getblock RPC, you need to reverse the requested hash:

> bitcoin-cli getblock \
  000000000000000082ccf8f1557c5d40b21edabb18d2d691cfbf87118bac7254

(Note: hex representation uses two characters to display each byte of data, which is why the reversed string looks somewhat mangled.)

The rationale for the reversal is unknown, but it likely stems from Bitcoin Core’s use of hashes (which are byte arrays in C++) as integers for the purpose of determining whether the hash is below the network target. Whatever the reason for reversing header hashes, the reversal also extends to other hashes used in RPCs, such as TXIDs and merkle roots.

As header hashes and TXIDs are widely used as global identifiers in other Bitcoin software, this reversal of hashes has become the standard way to refer to certain objects. The table below should make clear where each byte order is used.

Note: RPCs which return raw results, such as getrawtransaction or the raw mode of getblock, always display hashes as they appear in blocks (internal byte order).

The code below may help you check byte order by generating hashes from raw hex.

#!/usr/bin/env python

from sys import byteorder
from hashlib import sha256

## You can put in $data an 80-byte block header to get its header hash,
## or a raw transaction to get its txid
data = "00".decode("hex")
hash = sha256(sha256(data).digest()).digest()

print "Warning: this code only tested on a little-endian x86_64 arch"
print
print "System byte order:", byteorder
print "Internal-Byte-Order Hash: ", hash.encode('hex_codec')
print "RPC-Byte-Order Hash:      ", hash[::-1].encode('hex_codec')

Remote Procedure Calls (RPCs)

Bitcoin Core provides a remote procedure call (RPC) interface for various administrative tasks, wallet operations, and queries about network and block chain data.

If you start Bitcoin Core using bitcoin-qt, the RPC interface is disabled by default. To enable it, set server=1 in bitcoin.conf or supply the -server argument when invoking the program. If you start Bitcoin Core using bitcoind, the RPC interface is enabled by default.

The interface requires the user to provide a password for authenticating RPC requests. This password can be set either using the rpcpassword property in bitcoin.conf or by supplying the -rpcpassword program argument. Optionally a username can be set using the rpcuser configuration value. See the Examples Page for more information about setting Bitcoin Core configuration values.

Open-source client libraries for the RPC interface are readily available in most modern programming languages, so you probably don’t need to write your own from scratch. Bitcoin Core also ships with its own compiled C++ RPC client, bitcoin-cli, located in the bin directory alongside bitcoind and bitcoin-qt. The bitcoin-cli program can be used as a command-line interface (CLI) to Bitcoin Core or for making RPC calls from applications written in languages lacking a suitable native client. The remainder of this section describes the Bitcoin Core RPC protocol in detail.

The Bitcoin Core RPC service listens for HTTP POST requests on port 8332 in mainnet mode or 18332 in testnet or regtest mode. The port number can be changed by setting rpcport in bitcoin.conf. By default the RPC service binds to your server’s localhost loopback network interface so it’s not accessible from other servers. Authentication is implemented using HTTP basic authentication. RPC HTTP requests must include a Content-Type header set to text/plain and a Content-Length header set to the size of the request body.

The format of the request body and response data is based on version 1.0 of the JSON-RPC specification. Specifically, the HTTP POST data of a request must be a JSON object with the following format:

In the table above and in other tables describing RPC input and output, we use the following conventions

• “→” indicates an argument that is the child of a JSON array or JSON object. For example, “→ → Parameter” above means Parameter is the child of the params array which itself is a child of the Request object.

• Plain-text names like “Request” are unnamed in the actual JSON object

• Code-style names like params are literal strings that appear in the JSON object.

• “Type” is the JSON data type and the specific Bitcoin Core type.

• “Presence” indicates whether or not a field must be present within its containing array or object. Note that an optional object may still have required children.

The HTTP response data for a RPC request is a JSON object with the following format:

As an example, here is the JSON-RPC request object for the hash of the genesis block:

{
    "method": "getblockhash",
    "params": [0],
    "id": "foo"
}

The command to send this request using bitcoin-cli is:

bitcoin-cli getblockhash 0

Alternatively, we could POST this request using the cURL command-line program as follows:

curl --user ':my_secret_password' --data-binary '''
  {
      "method": "getblockhash",
      "params": [0],
      "id": "foo"
  }''' \
  --header 'Content-Type: text/plain;' localhost:8332

The HTTP response data for this request would be:

{
    "result": "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f",
    "error": null,
    "id": "foo"
}

Note: In order to minimize its size, the raw JSON response from Bitcoin Core doesn’t include any extraneous whitespace characters. Here we’ve added whitespace to make the object more readable. Speaking of which, bitcoin-cli also transforms the raw response to make it more human-readable. It:

• Adds whitespace indentation to JSON objects
• Expands escaped newline characters (“\n”) into actual newlines
• Returns only the value of the result field if there’s no error
• Strips the outer double-quotes around results of type string
• Returns only the error field if there’s an error

Continuing with the example above, the output from the bitcoin-cli command would be simply:

000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f

If there’s an error processing a request, Bitcoin Core sets the result field to null and provides information about the error in the error field. For example, a request for the block hash at block height -1 would be met with the following response (again, whitespace added for clarity):

{
    "result": null,
    "error": {
        "code": -8,
        "message": "Block height out of range"
    },
    "id": "foo"
}

If bitcoin-cli encounters an error, it exits with a non-zero status code and outputs the error field as text to the process’s standard error stream:

error: {"code": -8, "message": "Block height out of range"}

Starting in Bitcoin Core version 0.7.0, the RPC interface supports request batching as described in version 2.0 of the JSON-RPC specification. To initiate multiple RPC requests within a single HTTP request, a client can POST a JSON array filled with Request objects. The HTTP response data is then a JSON array filled with the corresponding Response objects. Depending on your usage pattern, request batching may provide significant performance gains. The bitcoin-cli RPC client does not support batch requests.

To keep this documentation compact and readable, the examples for each of the available RPC calls will be given as bitcoin-cli commands:

bitcoin-cli [options] <method name> <param1> <param2> ...

This translates into an JSON-RPC Request object of the form:

{
    "method": "<method name>",
    "params": [ "<param1>", "<param2>", "..." ],
    "id": "foo"
}

Warning: if you write programs using the JSON-RPC interface, you must ensure they handle high-precision real numbers correctly. See the Proper Money Handling Bitcoin Wiki article for details and example code.

Quick Reference

Block Chain RPCs

• GetBestBlockHash: returns the header hash of the most recent block on the best block chain. New in 0.9.0
• GetBlock: gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block.
• GetBlockChainInfo: provides information about the current state of the block chain. New in 0.9.2, Updated in 0.10.0
• GetBlockCount: returns the number of blocks in the local best block chain.
• GetBlockHash: returns the header hash of a block at the given height in the local best block chain.
• GetChainTips: returns information about the highest-height block (tip) of each local block chain. New in 0.10.0
• GetDifficulty: returns the proof-of-work difficulty as a multiple of the minimum difficulty.
• GetMemPoolInfo: returns information about the node’s current transaction memory pool. New in 0.10.0
• GetRawMemPool: 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.
• GetTxOut: returns details about a transaction output. Only unspent transaction outputs (UTXOs) are guaranteed to be available.
• GetTxOutProof: returns a hex-encoded proof that one or more specified transactions were included in a block. New in 0.11.0
• GetTxOutSetInfo: 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.
• VerifyChain: verifies each entry in the local block chain database.
• VerifyTxOutProof: 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. New in 0.11.0

Control RPCs

• GetInfo: prints various information about the node and the network. Updated in 0.10.0, Deprecated
• Help: 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.
• Stop: safely shuts down the Bitcoin Core server.

Generating RPCs

• Generate: nearly instantly generates blocks (in regtest mode only) New in master
• GetGenerate: returns true if the node is set to generate blocks using its CPU.
• SetGenerate: enables or disables hashing to attempt to find the next block. Updated in master

Mining RPCs

• GetBlockTemplate: gets a block template or proposal for use with mining software.
• GetMiningInfo: returns various mining-related information. Updated in master
• GetNetworkHashPS: returns the estimated current or historical network hashes per second based on the last n blocks.
• PrioritiseTransaction: 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.) New in 0.10.0
• SubmitBlock: 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.

Network RPCs

• AddNode: attempts to add or remove a node from the addnode list, or to try a connection to a node once.
• GetAddedNodeInfo: 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.
• GetConnectionCount: returns the number of connections to other nodes.
• GetNetTotals: returns information about network traffic, including bytes in, bytes out, and the current time.
• GetNetworkInfo: returns information about the node’s connection to the network. New in 0.9.2, Updated in 0.10.0
• GetPeerInfo: returns data about each connected network node. Updated in 0.10.0
• Ping: 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.

Raw Transaction RPCs

• CreateRawTransaction: 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.
• DecodeRawTransaction: decodes a serialized transaction hex string into a JSON object describing the transaction.
• DecodeScript: decodes a hex-encoded P2SH redeem script.
• GetRawTransaction: 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.
• SendRawTransaction: validates a transaction and broadcasts it to the peer-to-peer network.
• SignRawTransaction: signs a transaction in the serialized transaction format using private keys stored in the wallet or provided in the call.

Utility RPCs

• CreateMultiSig: creates a P2SH multi-signature address.
• EstimateFee: estimates the transaction fee per kilobyte that needs to be paid for a transaction to be included within a certain number of blocks. New in 0.10.0
• EstimatePriority: estimates the priority that a transaction needs in order to be included within a certain number of blocks as a free high-priority transaction. New in 0.10.0
• ValidateAddress: returns information about the given Bitcoin address.
• VerifyMessage: verifies a signed message.

Wallet RPCs

Note: the wallet RPCs are only available if Bitcoin Core was built with wallet support, which is the default.

• AddMultiSigAddress: adds a P2SH multisig address to the wallet.
• BackupWallet: safely copies wallet.dat to the specified file, which can be a directory or a path with filename.
• DumpPrivKey: returns the wallet-import-format (WIP) private key corresponding to an address. (But does not remove it from the wallet.)
• DumpWallet: creates or overwrites a file with all wallet keys in a human-readable format.
• EncryptWallet: 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.
• GetAccountAddress: 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.
• GetAccount: returns the name of the account associated with the given address.
• GetAddressesByAccount: returns a list of every address assigned to a particular account.
• GetBalance: gets the balance in decimal bitcoins across all accounts or for a particular account.
• GetNewAddress: returns a new Bitcoin address for receiving payments. If an account is specified, payments received with the address will be credited to that account.
• GetRawChangeAddress: returns a new Bitcoin address for receiving change. This is for use with raw transactions, not normal use.
• GetReceivedByAccount: 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: returns the total amount received by the specified address in transactions with the specified number of confirmations. It does not count coinbase transactions.
• GetTransaction: gets detailed information about an in-wallet transaction. Updated in 0.10.0
• GetUnconfirmedBalance: returns the wallet’s total unconfirmed balance.
• GetWalletInfo: provides information about the wallet. New in 0.9.2
• ImportAddress: 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. New in 0.10.0
• ImportPrivKey: adds a private key to your wallet. The key should be formatted in the wallet import format created by the dumpprivkey RPC.
• ImportWallet: 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.
• KeyPoolRefill: fills the cache of unused pre-generated keys (the keypool).
• ListAccounts: lists accounts and their balances. Updated in 0.10.0
• ListAddressGroupings: 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.
• ListLockUnspent: returns a list of temporarily unspendable (locked) outputs.
• ListReceivedByAccount: lists the total number of bitcoins received by each account. Updated in 0.10.0
• ListReceivedByAddress: lists the total number of bitcoins received by each address. Updated in 0.10.0
• ListSinceBlock: gets all transactions affecting the wallet which have occurred since a particular block, plus the header hash of a block at a particular depth. Updated in 0.10.0
• ListTransactions: returns the most recent transactions that affect the wallet. Updated in 0.10.0
• ListUnspent: returns an array of unspent transaction outputs belonging to this wallet. Updated in 0.10.0
• LockUnspent: 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.
• Move: moves a specified amount from one account in your wallet to another using an off-block-chain transaction.
• SendFrom: spends an amount from a local account to a bitcoin address.
• SendMany: creates and broadcasts a transaction which sends outputs to multiple addresses.
• SendToAddress: spends an amount to a given address.
• SetAccount: puts the specified address in the given account.
• SetTxFee: sets the transaction fee per kilobyte paid by transactions created by this wallet.
• SignMessage: signs a message with the private key of an address.
• WalletLock: 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: 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: changes the wallet passphrase from ‘old passphrase’ to ‘new passphrase’.

Removed RPCs

• GetHashesPerSec: was removed in Bitcoin Core master (unreleased). It returned a recent hashes per second performance measurement when the node was generating blocks.
• GetWork: was removed in Bitcoin Core 0.10.0.

RPCs

Warning: the block chain and memory pool can include arbitrary data which several of the commands below will return in hex format. If you convert this data to another format in an executable context, it could be used in an exploit. For example, displaying a pubkey script as ASCII text in a webpage could add arbitrary Javascript to that page and create a cross-site scripting (XSS) exploit. To avoid problems, please treat block chain and memory pool data as an arbitrary input from an untrusted source.

AddMultiSigAddress

Requires wallet support.

The addmultisigaddress RPC adds a P2SH multisig address to the wallet.

Parameter #1—the number of signatures required

Parameter #2—the full public keys, or addresses for known public keys

Parameter #3—the account name

Result—a P2SH address printed and stored in the wallet

Example from Bitcoin Core 0.10.0

Adding a 2-of-3 P2SH multisig address to the “test account” by mixing two P2PKH addresses and one full public key:

bitcoin-cli -testnet addmultisigaddress \
  2 \
  '''
    [
      "mjbLRSidW1MY8oubvs4SMEnHNFXxCcoehQ",
      "02ecd2d250a76d204011de6bc365a56033b9b3a149f679bc17205555d3c2b2854f",
      "mt17cV37fBqZsnMmrHnGCm9pM28R1kQdMG"
    ]
  ''' \
  'test account'

Result:

2MyVxxgNBk5zHRPRY2iVjGRJHYZEp1pMCSq

(New P2SH multisig address also stored in wallet.)

See also

• CreateMultiSig: creates a P2SH multi-signature address.
• DecodeScript: decodes a hex-encoded P2SH redeem script.
• Pay-To-Script-Hash (P2SH)

AddNode

The addnode RPC attempts to add or remove a node from the addnode list, or to try a connection to a node once.

Parameter #1—hostname/IP address and port of node to add or remove

Parameter #2—whether to add or remove the node, or to try only once to connect

Result—null plus error on failed remove

Example from Bitcoin Core 0.10.0

Try connecting to the following node.

bitcoin-cli -testnet addnode 192.0.2.113:18333 onetry

Result (no output from bitcoin-cli because result is set to null).

See also

• GetAddedNodeInfo: 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.

BackupWallet

Requires wallet support.

The backupwallet RPC safely copies wallet.dat to the specified file, which can be a directory or a path with filename.

Parameter #1—destination directory or filename

Result—null or error

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet backupwallet /tmp/backup.dat

See also

• DumpWallet: creates or overwrites a file with all wallet keys in a human-readable format.
• ImportWallet: 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.

CreateMultiSig

The createmultisig RPC creates a P2SH multi-signature address.

Parameter #1—the number of signatures required

Parameter #2—the full public keys, or addresses for known public keys

Result—P2SH address and hex-encoded redeem script

Example from Bitcoin Core 0.10.0

Creating a 2-of-3 P2SH multisig address by mixing two P2PKH addresses and one full public key:

bitcoin-cli -testnet createmultisig 2 '''
  [
    "mjbLRSidW1MY8oubvs4SMEnHNFXxCcoehQ",
    "02ecd2d250a76d204011de6bc365a56033b9b3a149f679bc17205555d3c2b2854f",
    "mt17cV37fBqZsnMmrHnGCm9pM28R1kQdMG"
  ]
'''

Result:

{
  "address" : "2MyVxxgNBk5zHRPRY2iVjGRJHYZEp1pMCSq",
  "redeemScript" : "522103ede722780d27b05f0b1169efc90fa15a601a32fc6c3295114500c586831b6aaf2102ecd2d250a76d204011de6bc365a56033b9b3a149f679bc17205555d3c2b2854f21022d609d2f0d359e5bc0e5d0ea20ff9f5d3396cb5b1906aa9c56a0e7b5edc0c5d553ae"
}

See also

• AddMultiSigAddress: adds a P2SH multisig address to the wallet.
• DecodeScript: decodes a hex-encoded P2SH redeem script.
• Pay-To-Script-Hash (P2SH)

CreateRawTransaction

The createrawtransaction RPC 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.

Parameter #1—references to previous outputs

Parameter #2—P2PKH or P2SH addresses and amounts

Result—the unsigned raw transaction in hex

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet createrawtransaction '''
  [
    {
      "txid": "1eb590cd06127f78bf38ab4140c4cdce56ad9eb8886999eb898ddf4d3b28a91d",
      "vout" : 0
    }
  ]''' '{ "mgnucj8nYqdrPFh2JfZSB1NmUThUGnmsqe": 0.13 }'

Result (wrapped):

01000000011da9283b4ddf8d89eb996988b89ead56cecdc44041ab38bf787f12\
06cd90b51e0000000000ffffffff01405dc600000000001976a9140dfc8bafc8\
419853b34d5e072ad37d1a5159f58488ac00000000

See also

• DecodeRawTransaction: decodes a serialized transaction hex string into a JSON object describing the transaction.
• SignRawTransaction: signs a transaction in the serialized transaction format using private keys stored in the wallet or provided in the call.
• SendRawTransaction: validates a transaction and broadcasts it to the peer-to-peer network.
• Serialized Transaction Format

DecodeRawTransaction

The decoderawtransaction RPC decodes a serialized transaction hex string into a JSON object describing the transaction.

Parameter #1—serialized transaction in hex

Result—the decoded transaction

Example from Bitcoin Core 0.10.0

Decode a signed one-input, three-output transaction:

bitcoin-cli -testnet decoderawtransaction 0100000001268a9ad7bfb2\
1d3c086f0ff28f73a064964aa069ebb69a9e437da85c7e55c7d7000000006b48\
3045022100ee69171016b7dd218491faf6e13f53d40d64f4b40123a2de52560f\
eb95de63b902206f23a0919471eaa1e45a0982ed288d374397d30dff541b2dd4\
5a4c3d0041acc0012103a7c1fd1fdec50e1cf3f0cc8cb4378cd8e9a2cee8ca9b\
3118f3db16cbbcf8f326ffffffff0350ac6002000000001976a91456847befbd\
2360df0e35b4e3b77bae48585ae06888ac80969800000000001976a9142b1495\
0b8d31620c6cc923c5408a701b1ec0a02088ac002d3101000000001976a9140d\
fc8bafc8419853b34d5e072ad37d1a5159f58488ac00000000

Result:

{
    "txid" : "ef7c0cbf6ba5af68d2ea239bba709b26ff7b0b669839a63bb01c2cb8e8de481e",
    "version" : 1,
    "locktime" : 0,
    "vin" : [
        {
            "txid" : "d7c7557e5ca87d439e9ab6eb69a04a9664a0738ff20f6f083c1db2bfd79a8a26",
            "vout" : 0,
            "scriptSig" : {
                "asm" : "3045022100ee69171016b7dd218491faf6e13f53d40d64f4b40123a2de52560feb95de63b902206f23a0919471eaa1e45a0982ed288d374397d30dff541b2dd45a4c3d0041acc001 03a7c1fd1fdec50e1cf3f0cc8cb4378cd8e9a2cee8ca9b3118f3db16cbbcf8f326",
                "hex" : "483045022100ee69171016b7dd218491faf6e13f53d40d64f4b40123a2de52560feb95de63b902206f23a0919471eaa1e45a0982ed288d374397d30dff541b2dd45a4c3d0041acc0012103a7c1fd1fdec50e1cf3f0cc8cb4378cd8e9a2cee8ca9b3118f3db16cbbcf8f326"
            },
            "sequence" : 4294967295
        }
    ],
    "vout" : [
        {
            "value" : 0.39890000,
            "n" : 0,
            "scriptPubKey" : {
                "asm" : "OP_DUP OP_HASH160 56847befbd2360df0e35b4e3b77bae48585ae068 OP_EQUALVERIFY OP_CHECKSIG",
                "hex" : "76a91456847befbd2360df0e35b4e3b77bae48585ae06888ac",
                "reqSigs" : 1,
                "type" : "pubkeyhash",
                "addresses" : [
                    "moQR7i8XM4rSGoNwEsw3h4YEuduuP6mxw7"
                ]
            }
        },
        {
            "value" : 0.10000000,
            "n" : 1,
            "scriptPubKey" : {
                "asm" : "OP_DUP OP_HASH160 2b14950b8d31620c6cc923c5408a701b1ec0a020 OP_EQUALVERIFY OP_CHECKSIG",
                "hex" : "76a9142b14950b8d31620c6cc923c5408a701b1ec0a02088ac",
                "reqSigs" : 1,
                "type" : "pubkeyhash",
                "addresses" : [
                    "mjSk1Ny9spzU2fouzYgLqGUD8U41iR35QN"
                ]
            }
        },
        {
            "value" : 0.20000000,
            "n" : 2,
            "scriptPubKey" : {
                "asm" : "OP_DUP OP_HASH160 0dfc8bafc8419853b34d5e072ad37d1a5159f584 OP_EQUALVERIFY OP_CHECKSIG",
                "hex" : "76a9140dfc8bafc8419853b34d5e072ad37d1a5159f58488ac",
                "reqSigs" : 1,
                "type" : "pubkeyhash",
                "addresses" : [
                    "mgnucj8nYqdrPFh2JfZSB1NmUThUGnmsqe"
                ]
            }
        }
    ]
}

See also

• CreateRawTransaction: 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.
• SignRawTransaction: signs a transaction in the serialized transaction format using private keys stored in the wallet or provided in the call.
• SendRawTransaction: validates a transaction and broadcasts it to the peer-to-peer network.

DecodeScript

The decodescript RPC decodes a hex-encoded P2SH redeem script.

Parameter #1—a hex-encoded redeem script

Result—the decoded script

Example from Bitcoin Core 0.10.0

A 2-of-3 P2SH multisig pubkey script:

bitcoin-cli -testnet decodescript 522103ede722780d27b05f0b1169ef\
c90fa15a601a32fc6c3295114500c586831b6aaf2102ecd2d250a76d204011de\
6bc365a56033b9b3a149f679bc17205555d3c2b2854f21022d609d2f0d359e5b\
c0e5d0ea20ff9f5d3396cb5b1906aa9c56a0e7b5edc0c5d553ae

Result:

{
    "asm" : "2 03ede722780d27b05f0b1169efc90fa15a601a32fc6c3295114500c586831b6aaf 02ecd2d250a76d204011de6bc365a56033b9b3a149f679bc17205555d3c2b2854f 022d609d2f0d359e5bc0e5d0ea20ff9f5d3396cb5b1906aa9c56a0e7b5edc0c5d5 3 OP_CHECKMULTISIG",
    "reqSigs" : 2,
    "type" : "multisig",
    "addresses" : [
        "mjbLRSidW1MY8oubvs4SMEnHNFXxCcoehQ",
        "mo1vzGwCzWqteip29vGWWW6MsEBREuzW94",
        "mt17cV37fBqZsnMmrHnGCm9pM28R1kQdMG"
    ],
    "p2sh" : "2MyVxxgNBk5zHRPRY2iVjGRJHYZEp1pMCSq"
}

See also

• CreateMultiSig: creates a P2SH multi-signature address.
• Pay-To-Script-Hash (P2SH)

DumpPrivKey

Requires wallet support. Requires an unlocked wallet or an unencrypted wallet.

The dumpprivkey RPC returns the wallet-import-format (WIP) private key corresponding to an address. (But does not remove it from the wallet.)

Parameter #1—the address corresponding to the private key to get

Result—the private key

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet dumpprivkey moQR7i8XM4rSGoNwEsw3h4YEuduuP6mxw7

Result:

cTVNtBK7mBi2yc9syEnwbiUpnpGJKohDWzXMeF4tGKAQ7wvomr95

See also

• ImportPrivKey: adds a private key to your wallet. The key should be formatted in the wallet import format created by the dumpprivkey RPC.
• DumpWallet: creates or overwrites a file with all wallet keys in a human-readable format.

DumpWallet

Requires wallet support. Requires an unlocked wallet or an unencrypted wallet.

The dumpwallet RPC creates or overwrites a file with all wallet keys in a human-readable format.

Parameter #1—a filename

Result—null or error

Example from Bitcoin Core 0.10.0

Create a wallet dump and then print its first 10 lines.

bitcoin-cli -testnet dumpwallet /tmp/dump.txt
head /tmp/dump.txt

Results (only showing the first 10 lines):

# Wallet dump created by Bitcoin v0.9.1.0-g026a939-beta (Tue, 8 Apr 2014 12:04:06 +0200)
# * Created on 2014-04-29T20:46:09Z
# * Best block at time of backup was 227221 (0000000026ede4c10594af8087748507fb06dcd30b8f4f48b9cc463cabc9d767),
#   mined on 2014-04-29T21:15:07Z

cTtefiUaLfXuyBXJBBywSdg8soTEkBNh9yTi1KgoHxUYxt1xZ2aA 2014-02-05T15:44:03Z label=test1 # addr=mnUbTmdAFD5EAg3348Ejmonub7JcWtrMck
cQNY9v93Gyt8KmwygFR59bDhVs3aRDkuT8pKaCBpop82TZ8ND1tH 2014-02-05T16:58:41Z reserve=1 # addr=mp4MmhTp3au21HPRz5waf6YohGumuNnsqT
cNTEPzZH9mjquFFADXe5S3BweNiHLUKD6PvEKEsHApqjX4ZddeU6 2014-02-05T16:58:41Z reserve=1 # addr=n3pdvsxveMBkktjsGJixfSbxacRUwJ9jQW
cTVNtBK7mBi2yc9syEnwbiUpnpGJKohDWzXMeF4tGKAQ7wvomr95 2014-02-05T16:58:41Z change=1 # addr=moQR7i8XM4rSGoNwEsw3h4YEuduuP6mxw7
cNCD679B4xi17jb4XeLpbRbZCbYUugptD7dCtUTfSU4KPuK2DyKT 2014-02-05T16:58:41Z reserve=1 # addr=mq8fzjxxVbAKxUGPwaSSo3C4WaUxdzfw3C

See also

• BackupWallet: safely copies wallet.dat to the specified file, which can be a directory or a path with filename.
• ImportWallet: 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.

EncryptWallet

Requires wallet support.

The encryptwallet RPC 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.

Warning: if using this RPC on the command line, remember that your shell probably saves your command lines (including the value of the passphrase parameter). In addition, there is no RPC to completely disable encryption. If you want to return to an unencrypted wallet, you must create a new wallet and restore your data from a backup made with the dumpwallet RPC.

Parameter #1—a passphrase

Result—a notice (with program shutdown)

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet encryptwallet "test"

Result:

wallet encrypted; Bitcoin server stopping, restart to run with encrypted
wallet. The keypool has been flushed, you need to make a new backup.

See also

• WalletPassphrase: 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.
• WalletLock: 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.
• WalletPassphraseChange: changes the wallet passphrase from ‘old passphrase’ to ‘new passphrase’.

EstimateFee

Added in Bitcoin Core 0.10.0.

The estimatefee RPC estimates the transaction fee per kilobyte that needs to be paid for a transaction to be included within a certain number of blocks.

Parameter #1—how many blocks the transaction may wait before being included

Result—the fee the transaction needs to pay per kilobyte

Examples from Bitcoin Core 0.10.0

bitcoin-cli estimatefee 6

Result:

0.00026809

Requesting data the node can’t calculate yet:

bitcoin-cli estimatefee 100

Result:

-1.00000000

See also

• EstimatePriority: estimates the priority that a transaction needs in order to be included within a certain number of blocks as a free high-priority transaction.
• SetTxFee: sets the transaction fee per kilobyte paid by transactions created by this wallet.

EstimatePriority

Added in Bitcoin Core 0.10.0.

The estimatepriority RPC estimates the priority that a transaction needs in order to be included within a certain number of blocks as a free high-priority transaction.

Transaction priority is relative to a transaction’s byte size.

Parameter #1—how many blocks the transaction may wait before being included as a free high-priority transaction

Result—the priority a transaction needs

Examples from Bitcoin Core 0.10.0

bitcoin-cli estimatepriority 6

Result:

718158904.10958910

Requesting data the node can’t calculate yet:

bitcoin-cli estimatepriority 100

Result:

-1.00000000

See also

• EstimateFee: estimates the transaction fee per kilobyte that needs to be paid for a transaction to be included within a certain number of blocks.

Generate

Requires wallet support.

The generate RPC nearly instantly generates blocks (in regtest mode only)

Parameter #1—the number of blocks to generate

Result—the generated block header hashes

Examples from Bitcoin Core master (commit c2fa0846)

Using regtest mode, generate 2 blocks:

bitcoin-cli -regtest generate 2

Result:

[
    "36252b5852a5921bdfca8701f936b39edeb1f8c39fffe73b0d8437921401f9af",
    "5f2956817db1e386759aa5794285977c70596b39ea093b9eab0aa4ba8cd50c06"
]

See also

• SetGenerate: returns true if the node is set to generate blocks using its CPU.
• GetMiningInfo: returns various mining-related information.
• GetBlockTemplate: gets a block template or proposal for use with mining software.

GetAccountAddress

Requires wallet support.

The getaccountaddress RPC 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.

Parameter #1—an account name

Result—a bitcoin address

Example from Bitcoin Core 0.10.0

Get an address for the default account:

bitcoin-cli -testnet getaccountaddress ""

Result:

msQyFNYHkFUo4PG3puJBbpesvRCyRQax7r

See also

• GetNewAddress: returns a new Bitcoin address for receiving payments. If an account is specified, payments received with the address will be credited to that account.
• GetRawChangeAddress: returns a new Bitcoin address for receiving change. This is for use with raw transactions, not normal use.
• GetAddressesByAccount: returns a list of every address assigned to a particular account.

GetAccount

Requires wallet support.

The getaccount RPC returns the name of the account associated with the given address.

Parameter #1—a Bitcoin address

Result—an account name

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet getaccount mjSk1Ny9spzU2fouzYgLqGUD8U41iR35QN

Result:

doc test

See also

• GetAddressesByAccount: returns a list of every address assigned to a particular account.

GetAddedNodeInfo

The getaddednodeinfo RPC 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.

Parameter #1—whether to display connection information

Parameter #2—what node to display information about

Result—a list of added nodes

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet getaddednodeinfo true

Result (real hostname and IP address replaced):

[
    {
        "addednode" : "bitcoind.example.com:18333",
        "connected" : true,
        "addresses" : [
            {
                "address" : "192.0.2.113:18333",
                "connected" : "outbound"
            }
        ]
    }
]

See also

• AddNode: attempts to add or remove a node from the addnode list, or to try a connection to a node once.
• GetPeerInfo: returns data about each connected network node.

GetAddressesByAccount

Requires wallet support.

The getaddressesbyaccount RPC returns a list of every address assigned to a particular account.

Parameter #1—the account name

Result—a list of addresses

Example from Bitcoin Core 0.10.0

Get the addresses assigned to the account “doc test”:

bitcoin-cli -testnet getaddressesbyaccount "doc test"

Result:

[
    "mjSk1Ny9spzU2fouzYgLqGUD8U41iR35QN",
    "mft61jjkmiEJwJ7Zw3r1h344D6aL1xwhma",
    "mmXgiR6KAhZCyQ8ndr2BCfEq1wNG2UnyG6"
]

See also

• GetAccount: returns the name of the account associated with the given address.
• GetBalance: gets the balance in decimal bitcoins across all accounts or for a particular account.

GetBalance

Requires wallet support.

The getbalance RPC gets the balance in decimal bitcoins across all accounts or for a particular account.

Parameter #1—an account name

Parameter #2—the minimum number of confirmations

Parameter #3—whether to include watch-only addresses

Result—the balance in bitcoins

Examples from Bitcoin Core 0.10.0

Get the balance for the “test1” account, including transactions with at least one confirmation and those spent to watch-only addresses in that account.

bitcoin-cli -testnet getbalance "test1" 1 true

Result:

1.99900000

See also

• ListAccounts: lists accounts and their balances.
• GetReceivedByAccount: 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: returns the total amount received by the specified address in transactions with the specified number of confirmations. It does not count coinbase transactions.

GetBestBlockHash

Added in Bitcoin Core 0.9.0

The getbestblockhash RPC returns the header hash of the most recent block on the best block chain.

Parameters: none

Result—hash of the tip from the best block chain

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet getbestblockhash

Result:

0000000000075c58ed39c3e50f99b32183d090aefa0cf8c324a82eea9b01a887

See also

• GetBlock: gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block.
• GetBlockHash: returns the header hash of a block at the given height in the local best block chain.

GetBlock

The getblock RPC gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block.

Parameter #1—header hash

Parameter #2—JSON or hex output

Result (if format was false)—a serialized block

Result (if format was true or omitted)—a JSON block

Example from Bitcoin Core 0.10.0

Get a block in raw hex:

bitcoin-cli -testnet getblock \
            000000000fe549a89848c76070d4132872cfb6efe5315d01d7ef77e4900f2d39 \
            false

Result (wrapped):

02000000df11c014a8d798395b5059c722ebdf3171a4217ead71bf6e0e99f4c7\
000000004a6f6a2db225c81e77773f6f0457bcb05865a94900ed11356d0b7522\
8efb38c7785d6053ffff001d005d437001010000000100000000000000000000\
00000000000000000000000000000000000000000000ffffffff0d03b4770301\
64062f503253482fffffffff0100f9029500000000232103adb7d8ef6b63de74\
313e0cd4e07670d09a169b13e4eda2d650f529332c47646dac00000000

Get the same block in JSON:

bitcoin-cli -testnet getblock \
            000000000fe549a89848c76070d4132872cfb6efe5315d01d7ef77e4900f2d39 \
            true

Result:

{
    "hash" : "000000000fe549a89848c76070d4132872cfb6efe5315d01d7ef77e4900f2d39",
    "confirmations" : 88029,
    "size" : 189,
    "height" : 227252,
    "version" : 2,
    "merkleroot" : "c738fb8e22750b6d3511ed0049a96558b0bc57046f3f77771ec825b22d6a6f4a",
    "tx" : [
        "c738fb8e22750b6d3511ed0049a96558b0bc57046f3f77771ec825b22d6a6f4a"
    ],
    "time" : 1398824312,
    "nonce" : 1883462912,
    "bits" : "1d00ffff",
    "difficulty" : 1.00000000,
    "chainwork" : "000000000000000000000000000000000000000000000000083ada4a4009841a",
    "previousblockhash" : "00000000c7f4990e6ebf71ad7e21a47131dfeb22c759505b3998d7a814c011df",
    "nextblockhash" : "00000000afe1928529ac766f1237657819a11cfcc8ca6d67f119e868ed5b6188"
}

See also

• GetBlockHash: returns the header hash of a block at the given height in the local best block chain.
• GetBestBlockHash: returns the header hash of the most recent block on the best block chain.

GetBlockChainInfo

Added in Bitcoin Core 0.9.2

The getblockchaininfo RPC provides information about the current state of the block chain.

Parameters: none

Result—A JSON object providing information about the block chain

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet getblockchaininfo

Result:

{
    "chain" : "test",
    "blocks" : 315280,
    "headers" : 315280,
    "bestblockhash" : "000000000ebb17fb455e897b8f3e343eea1b07d926476d00bc66e2c0342ed50f",
    "difficulty" : 1.00000000,
    "verificationprogress" : 1.00000778,
    "chainwork" : "0000000000000000000000000000000000000000000000015e984b4fb9f9b350"
}

See also

• GetMiningInfo: returns various mining-related information.
• GetNetworkInfo: returns information about the node’s connection to the network.
• GetWalletInfo: provides information about the wallet.

GetBlockCount

The getblockcount RPC returns the number of blocks in the local best block chain.

Parameters: none

Result—the number of blocks in the local best block chain

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet getblockcount

Result:

315280

See also

• GetBlockHash: returns the header hash of a block at the given height in the local best block chain.
• GetBlock: gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block.

GetBlockHash

The getblockhash RPC returns the header hash of a block at the given height in the local best block chain.

Parameter—a block height

Result—the block header hash

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet getblockhash 240886

Result:

00000000a0faf83ab5799354ae9c11da2a2bd6db44058e03c528851dee0a3fff

See also

• GetBlock: gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block.
• GetBestBlockHash: returns the header hash of the most recent block on the best block chain.

GetBlockTemplate

The getblocktemplate RPC gets a block template or proposal for use with mining software. For more information, please see the following resources:

• Bitcoin Wiki GetBlockTemplate
• BIP22
• BIP23

See also

• SetGenerate: enables or disables hashing to attempt to find the next block.
• GetMiningInfo: returns various mining-related information.
• SubmitBlock: 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.
• PrioritiseTransaction: 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.)

GetChainTips

Added in Bitcoin Core 0.10.0.

The getchaintips RPC returns information about the highest-height block (tip) of each local block chain.

Parameters: none

Result—an array of block chain tips

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet getchaintips

[
    {
        "height" : 312647,
        "hash" : "000000000b1be96f87b31485f62c1361193304a5ad78acf47f9164ea4773a843",
        "branchlen" : 0,
        "status" : "active"
    },
    {
        "height" : 282072,
        "hash" : "00000000712340a499b185080f94b28c365d8adb9fc95bca541ea5e708f31028",
        "branchlen" : 5,
        "status" : "valid-fork"
    },
    {
        "height" : 281721,
        "hash" : "000000006e1f2a32199629c6c1fbd37766f5ce7e8c42bab0c6e1ae42b88ffe12",
        "branchlen" : 1,
        "status" : "valid-headers"
    },
]

See also

• GetBestBlockHash: returns the header hash of the most recent block on the best block chain.
• GetBlock: gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block.
• GetBlockChainInfo: provides information about the current state of the block chain.

GetConnectionCount

The getconnectioncount RPC returns the number of connections to other nodes.

Parameters: none

Result—the number of connections to other nodes

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet getconnectioncount

Result:

14

See also

• GetNetTotals: returns information about network traffic, including bytes in, bytes out, and the current time.
• GetPeerInfo: returns data about each connected network node.
• GetNetworkInfo: returns information about the node’s connection to the network.

GetDifficulty

The getdifficulty RPC

Parameters: none

Result—the current difficulty

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet getdifficulty

Result:

1.00000000

See also

• GetNetworkHashPS: returns the estimated current or historical network hashes per second based on the last n blocks.
• GetMiningInfo: returns various mining-related information.

GetGenerate

Requires wallet support.

The getgenerate RPC returns true if the node is set to generate blocks using its CPU.

Parameters: none

Result—whether the server is set to generate blocks

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet getgenerate

Result:

false

See also

• SetGenerate: enables or disables hashing to attempt to find the next block.
• GetMiningInfo: returns various mining-related information.
• GetHashesPerSec: was removed in Bitcoin Core master (unreleased). It returned a recent hashes per second performance measurement when the node was generating blocks.

GetHashesPerSec

Requires wallet support.

The gethashespersec RPC was removed in Bitcoin Core master (unreleased). It returned a recent hashes per second performance measurement when the node was generating blocks.

Parameters: none

Result—the number of hashes your computer generated per second

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet gethashespersec

Result:

1995356

See also

• SetGenerate: enables or disables hashing to attempt to find the next block.
• GetMiningInfo: returns various mining-related information.

GetInfo

The getinfo RPC prints various information about the node and the network.

Warning: getinfo will be removed in a later version of Bitcoin Core. Use the RPCs listed in the See Also subsection below instead.

Parameters: none

Result—information about the node and network

Example from Bitcoin Core 0.10.0 with wallet support enabled

bitcoin-cli -testnet getinfo

Result:

{
    "version" : 100000,
    "protocolversion" : 70002,
    "walletversion" : 60000,
    "balance" : 1.27007770,
    "blocks" : 315281,
    "timeoffset" : 0,
    "connections" : 9,
    "proxy" : "",
    "difficulty" : 1.00000000,
    "testnet" : true,
    "keypoololdest" : 1418924649,
    "keypoolsize" : 101,
    "paytxfee" : 0.00000000,
    "relayfee" : 0.00001000,
    "errors" : ""
}

See also

• GetBlockChainInfo: provides information about the current state of the block chain.
• GetMemPoolInfo: returns information about the node’s current transaction memory pool.
• GetMiningInfo: returns various mining-related information.
• GetNetworkInfo: returns information about the node’s connection to the network.
• GetWalletInfo: provides information about the wallet.

GetMemPoolInfo

Added in Bitcoin Core 0.10.0

The getmempoolinfo RPC returns information about the node’s current transaction memory pool.

Parameters: none

Result—information about the transaction memory pool

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet getmempoolinfo

Result:

{
    "size" : 37,
    "bytes" : 9423
}

See also

• GetBlockChainInfo: provides information about the current state of the block chain.
• GetRawMemPool: 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.
• GetTxOutSetInfo: 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.

GetMiningInfo

The getmininginfo RPC returns various mining-related information.

Parameters: none

Result—various mining-related information

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet getmininginfo

Result:

{
    "blocks" : 313168,
    "currentblocksize" : 1819,
    "currentblocktx" : 3,
    "difficulty" : 1.00000000,
    "errors" : "",
    "genproclimit" : 1,
    "networkhashps" : 5699977416637,
    "pooledtx" : 8,
    "testnet" : true,
    "chain" : "test",
    "generate" : true,
    "hashespersec" : 921200
}

See also

• GetMemPoolInfo: returns information about the node’s current transaction memory pool.
• GetRawMemPool: 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.
• GetBlockTemplate: gets a block template or proposal for use with mining software.
• SetGenerate: enables or disables hashing to attempt to find the next block.

GetNetTotals

The getnettotals RPC returns information about network traffic, including bytes in, bytes out, and the current time.

Parameters: none

Result—the current bytes in, bytes out, and current time

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet getnettotals

Result:

{
    "totalbytesrecv" : 723992206,
    "totalbytessent" : 16846662695,
    "timemillis" : 1419268217354
}

See also

• GetNetworkInfo: returns information about the node’s connection to the network.
• GetPeerInfo: returns data about each connected network node.

GetNetworkHashPS

The getnetworkhashps RPC returns the estimated current or historical network hashes per second based on the last n blocks.

Parameter #1—number of blocks to average

Parameter #2—block height

Result—estimated hashes per second

Example from Bitcoin Core 0.10.0

Get the average hashes per second for all the blocks since the last difficulty change before block 227255.

bitcoin-cli -testnet getnetworkhashps -1 227255

Result:

79510076167

See also

• GetDifficulty: returns the proof-of-work difficulty as a multiple of the minimum difficulty.
• GetBlock: gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block.

GetNetworkInfo

Added in Bitcoin Core 0.9.2.

The getnetworkinfo RPC returns information about the node’s connection to the network.

Parameters: none

Result—information about the node’s connection to the network

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet getnetworkinfo

Result (actual addresses have been replaced with reserved addresses):

{
    "version" : 100000,
    "subversion" : "/Satoshi:0.10.0/",
    "protocolversion" : 70002,
    "localservices" : "0000000000000001",
    "timeoffset" : 0,
    "connections" : 51,
    "networks" : [
        {
            "name" : "ipv4",
            "limited" : false,
            "reachable" : true,
            "proxy" : ""
        },
        {
            "name" : "ipv6",
            "limited" : false,
            "reachable" : true,
            "proxy" : ""
        },
        {
            "name" : "onion",
            "limited" : false,
            "reachable" : false,
            "proxy" : ""
        }
    ],
    "relayfee" : 0.00001000,
    "localaddresses" : [
        {
            "address" : "192.0.2.113",
            "port" : 18333,
            "score" : 6470
        },
        {
            "address" : "0600:3c03::f03c:91ff:fe89:dfc4",
            "port" : 18333,
            "score" : 2029
        }
    ]
}

See also

• GetPeerInfo: returns data about each connected network node.
• GetNetTotals: returns information about network traffic, including bytes in, bytes out, and the current time.

GetNewAddress

Requires wallet support.

The getnewaddress RPC returns a new Bitcoin address for receiving payments. If an account is specified, payments received with the address will be credited to that account.

Parameter #1—an account name

Result—a bitcoin address never previously returned

Example from Bitcoin Core 0.10.0

Create a new address in the “doc test” account:

bitcoin-cli -testnet getnewaddress "doc test"

Result:

mft61jjkmiEJwJ7Zw3r1h344D6aL1xwhma

See also

• GetAccountAddress: 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.
• GetRawChangeAddress: returns a new Bitcoin address for receiving change. This is for use with raw transactions, not normal use.
• GetBalance: gets the balance in decimal bitcoins across all accounts or for a particular account.

GetPeerInfo

The getpeerinfo RPC returns data about each connected network node.

Parameters: none

Result—information about each currently-connected network node

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet getpeerinfo

Result (edited to show only a single entry, with IP addresses changed to RFC5737 reserved IP addresses):

[
    {
        "id" : 9,
        "addr" : "192.0.2.113:18333",
        "addrlocal" : "192.0.2.51:18333",
        "services" : "0000000000000002",
        "lastsend" : 1419277992,
        "lastrecv" : 1419277992,
        "bytessent" : 4968,
        "bytesrecv" : 105078,
        "conntime" : 1419265985,
        "pingtime" : 0.05617800,
        "version" : 70001,
        "subver" : "/Satoshi:0.8.6/",
        "inbound" : false,
        "startingheight" : 315280,
        "banscore" : 0,
        "synced_headers" : -1,
        "synced_blocks" : -1,
        "inflight" : [
        ],
        "whitelisted" : false
    }
]

See also

• GetAddedNodeInfo: 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.
• GetNetTotals: returns information about network traffic, including bytes in, bytes out, and the current time.
• GetNetworkInfo: returns information about the node’s connection to the network.

GetRawChangeAddress

Requires wallet support.

The getrawchangeaddress RPC returns a new Bitcoin address for receiving change. This is for use with raw transactions, not normal use.

Parameters: none

Result—a P2PKH address which can be used in raw transactions

Example from Bitcoin Core 0.10.0

bitcoin-cli -testnet getrawchangeaddress

Result:

mnycUc8FRjJodfKhaj9QBZs2PwxxYoWqaK

See also

• GetNewAddress: returns a new Bitcoin address for receiving payments. If an account is specified, payments received with the address will be credited to that account.
• GetAccountAddress: 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.

GetRawMemPool

The getrawmempool RPC 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.

Parameter—desired output format

Result (format false)—an array of TXIDs

Result (format: true)—a JSON object describing each transaction

Examples from Bitcoin Core 0.10.0

The default (false):

bitcoin-cli -testnet getrawmempool

Result:

[
    "2b1f41d6f1837e164d6d6811d3d8dad2e66effbd1058cd9ed7bdbe1cab20ae03",
    "2baa1f49ac9b951fa781c4c95814333a2f3eda71ed3d0245cd76c2829b3ce354"
]

Verbose output (true):

bitcoin-cli -testnet getrawmempool true

Result:

{
    "2baa1f49ac9b951fa781c4c95814333a2f3eda71ed3d0245cd76c2829b3ce354" : {
        "size" : 191,
        "fee" : 0.00020000,
        "time" : 1398867772,
        "height" : 227310,
        "startingpriority" : 54545454.54545455,
        "currentpriority" : 54545454.54545455,
        "depends" : [
        ]
    }
}

See also

• GetMemPoolInfo: returns information about the node’s current transaction memory pool.
• GetTxOutSetInfo: 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.

GetRawTransaction

The getrawtransaction RPC 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.

Note: if you begin using txindex=1 after downloading the block chain, you must rebuild your indexes by starting Bitcoin Core with the option -reindex. This may take several hours to complete, during which time your node will not process new blocks or transactions. This reindex only needs to be done once.

Parameter #1—the TXID of the transaction to get

Parameter #2—whether to get the serialized or decoded transaction

Result (if transaction not found)—null

Result (if verbose=0)—the serialized transaction

Result (if verbose=1)—the decoded transaction

Examples from Bitcoin Core 0.10.0

A transaction in serialized transaction format:

bitcoin-cli -testnet getrawtransaction \
  ef7c0cbf6ba5af68d2ea239bba709b26ff7b0b669839a63bb01c2cb8e8de481e

Result (wrapped):

0100000001268a9ad7bfb21d3c086f0ff28f73a064964aa069ebb69a9e437da8\
5c7e55c7d7000000006b483045022100ee69171016b7dd218491faf6e13f53d4\
0d64f4b40123a2de52560feb95de63b902206f23a0919471eaa1e45a0982ed28\
8d374397d30dff541b2dd45a4c3d0041acc0012103a7c1fd1fdec50e1cf3f0cc\
8cb4378cd8e9a2cee8ca9b3118f3db16cbbcf8f326ffffffff0350ac60020000\
00001976a91456847befbd2360df0e35b4e3b77bae48585ae06888ac80969800\
000000001976a9142b14950b8d31620c6cc923c5408a701b1ec0a02088ac002d\
3101000000001976a9140dfc8bafc8419853b34d5e072ad37d1a5159f58488ac\
00000000

Get the same transaction in JSON:

bitcoin-cli -testnet getrawtransaction \
ef7c0cbf6ba5af68d2ea239bba709b26ff7b0b669839a63bb01c2cb8e8de481e \
1

Result:

{
    "hex" : "0100000001268a9ad7bfb21d3c086f0ff28f73a064964aa069ebb69a9e437da85c7e55c7d7000000006b483045022100ee69171016b7dd218491faf6e13f53d40d64f4b40123a2de52560feb95de63b902206f23a0919471eaa1e45a0982ed288d374397d30dff541b2dd45a4c3d0041acc0012103a7c1fd1fdec50e1cf3f0cc8cb4378cd8e9a2cee8ca9b3118f3db16cbbcf8f326ffffffff0350ac6002000000001976a91456847befbd2360df0e35b4e3b77bae48585ae06888ac80969800000000001976a9142b14950b8d31620c6cc923c5408a701b1ec0a02088ac002d3101000000001976a9140dfc8bafc8419853b34d5e072ad37d1a5159f58488ac00000000",
    "txid" : "ef7c0cbf6ba5af68d2ea239bba709b26ff7b0b669839a63bb01c2cb8e8de481e",
    "version" : 1,
    "locktime" : 0,
    "vin" : [
        {
            "txid" : "d7c7557e5ca87d439e9ab6eb69a04a9664a0738ff20f6f083c1db2bfd79a8a26",
            "vout" : 0,
            "scriptSig" : {
                "asm" : "3045022100ee69171016b7dd218491faf6e13f53d40d64f4b40123a2de52560feb95de63b902206f23a0919471eaa1e45a0982ed288d374397d30dff541b2dd45a4c3d0041acc001 03a7c1fd1fdec50e1cf3f0cc8cb4378cd8e9a2cee8ca9b3118f3db16cbbcf8f326",
                "hex" : "483045022100ee69171016b7dd218491faf6e13f53d40d64f4b40123a2de52560feb95de63b902206f23a0919471eaa1e45a0982ed288d374397d30dff541b2dd45a4c3d0041acc0012103a7c1fd1fdec50e1cf3f0cc8cb4378cd8e9a2cee8ca9b3118f3db16cbbcf8f326"
            },
            "sequence" : 4294967295
        }
    ],
    "vout" : [
        {
            "value" : 0.39890000,
            "n" : 0,
            "scriptPubKey" : {
                "asm" : "OP_DUP OP_HASH160 56847befbd2360df0e35b4e3b77bae48585ae068 OP_EQUALVERIFY OP_CHECKSIG",
                "hex" : "76a91456847befbd2360df0e35b4e3b77bae48585ae06888ac",
                "reqSigs" : 1,
                "type" : "pubkeyhash",
                "addresses" : [
                    "moQR7i8XM4rSGoNwEsw3h4YEuduuP6mxw7"
                ]
            }
        },
        {
            "value" : 0.10000000,
            "n" : 1,
            "scriptPubKey" : {
                "asm" : "OP_DUP OP_HASH160 2b14950b8d31620c6cc923c5408a701b1ec0a020 OP_EQUALVERIFY OP_CHECKSIG",
                "hex" : "76a9142b14950b8d31620c6cc923c5408a701b1ec0a02088ac",
                "reqSigs" : 1,
                "type" : "pubkeyhash",
                "addresses" : [
                    "mjSk1Ny9spzU2fouzYgLqGUD8U41iR35QN"
                ]
            }
        },
        {
            "value" : 0.20000000,
            "n" : 2,
            "scriptPubKey" : {
                "asm" : "OP_DUP OP_HASH160 0dfc8bafc8419853b34d5e072ad37d1a5159f584 OP_EQUALVERIFY OP_CHECKSIG",
                "hex" : "76a9140dfc8bafc8419853b34d5e072ad37d1a5159f58488ac",
                "reqSigs" : 1,
                "type" : "pubkeyhash",
                "addresses" : [
                    "mgnucj8nYqdrPFh2JfZSB1NmUThUGnmsqe"
                ]
            }
        }
    ],
    "blockhash" : "00000000103e0091b7d27e5dc744a305108f0c752be249893c749e19c1c82317",
    "confirmations" : 88192,
    "time" : 1398734825,
    "blocktime" : 1398734825
}

See also

• GetTransaction: gets detailed information about an in-wallet transaction.

GetReceivedByAccount

Requires wallet support.

The getreceivedbyaccount RPC 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.

Parameter #1—the account name

Parameter #2—the minimum number of confirmations

Result—the number of bitcoins received

Example from Bitcoin Core 0.10.0

Get the bitcoins received by the “doc test” account with six or more confirmations:

bitcoin-cli -testnet getreceivedbyaccount "doc test" 6

Result:

0.30000000

See also

• GetReceivedByAddress: returns the total amount received by the specified address in transactions with the specified number of confirmations. It does not count coinbase transactions.
• GetAddressesByAccount: returns a list of every address assigned to a particular account.
• ListAccounts: lists accounts and their balances.

GetReceivedByAddress

Requires wallet support.

The getreceivedbyaddress RPC returns the total amount received by the specified address in transactions with the specified number of confirmations. It does not count coinbase transactions.

Parameter #1—the address

Parameter #2—the minimum number of confirmations

Result—the number of bitcoins received

Example from Bitcoin Core 0.10.0

Get the bitcoins received for a particular address, only counting transactions with six or more confirmations:

bitcoin-cli -testnet getreceivedbyaddress mjSk1Ny9spzU2fouzYgLqGUD8U41iR35QN 6

Result:

0.30000000

See also

• GetReceivedByAccount: 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.
• GetAddressesByAccount: returns a list of every address assigned to a particular account.
• ListAccounts: lists accounts and their balances.

GetTransaction

Requires wallet support.

The gettransaction RPC gets detailed information about an in-wallet transaction.

Parameter #1—a transaction identifier (TXID)

Parameter #2—whether to include watch-only addresses in details and calculations

Result—a description of the transaction