diff --git a/abandontransaction.html b/abandontransaction.html index 23c28cd..7b34271 100644 --- a/abandontransaction.html +++ b/abandontransaction.html @@ -35,22 +35,22 @@
-abandontransaction "txid" +abandontransaction "txid" -Mark in-wallet transactionas abandoned +Mark in-wallet transaction <txid> as abandoned This will mark this transaction and all its in-wallet descendants as abandoned which will allow -for their inputs to be respent. It can be used to replace "stuck" or evicted transactions. +for their inputs to be respent. It can be used to replace "stuck" or evicted transactions. It only works on transactions which are not included in a block and are not currently in the mempool. It has no effect on transactions which are already conflicted or abandoned. Arguments: -1. "txid" (string, required) The transaction id +1. "txid" (string, required) The transaction id Result: Examples: -> bitcoin-cli abandontransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "abandontransaction", "params": ["1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli abandontransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "abandontransaction", "params": ["1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-addmultisigaddress nrequired ["key",...] ( "account" "address_type" ) +addmultisigaddress nrequired ["key",...] ( "account" "address_type" ) Add a nrequired-to-sign multisignature address to the wallet. Requires a new wallet backup. Each key is a Bitcoin address or hex-encoded public key. This functionality is only intended for use with non-watchonly addresses. See `importaddress` for watchonly p2sh address support. -If 'account' is specified (DEPRECATED), assign address to that account. +If 'account' is specified (DEPRECATED), assign address to that account. Arguments: 1. nrequired (numeric, required) The number of required signatures out of the n keys or addresses. -2. "keys" (string, required) A json array of bitcoin addresses or hex-encoded public keys +2. "keys" (string, required) A json array of bitcoin addresses or hex-encoded public keys [ - "address" (string) bitcoin address or hex-encoded public key + "address" (string) bitcoin address or hex-encoded public key ..., ] -3. "account" (string, optional) DEPRECATED. An account to assign the addresses to. -4. "address_type" (string, optional) The address type to use. Options are "legacy", "p2sh-segwit", and "bech32". Default is set by -addresstype. +3. "account" (string, optional) DEPRECATED. An account to assign the addresses to. +4. "address_type" (string, optional) The address type to use. Options are "legacy", "p2sh-segwit", and "bech32". Default is set by -addresstype. Result: { - "address":"multisigaddress", (string) The value of the new multisig address. - "redeemScript":"script" (string) The string value of the hex-encoded redemption script. + "address":"multisigaddress", (string) The value of the new multisig address. + "redeemScript":"script" (string) The string value of the hex-encoded redemption script. } Result (DEPRECATED. To see this result in v0.16 instead, please start bitcoind with -deprecatedrpc=addmultisigaddress). clients should transition to the new output api before upgrading to v0.17. -"address" (string) A bitcoin address associated with the keys. +"address" (string) A bitcoin address associated with the keys. Examples: Add a multisig address from 2 addresses -> bitcoin-cli addmultisigaddress 2 "[\"16sSauSf5pF2UkUwvKGq4qjNRzBZYqgEL5\",\"171sgjn4YtPu27adkKGrdDwzRTxnRkBfKV\"]" +> bitcoin-cli addmultisigaddress 2 "[\"16sSauSf5pF2UkUwvKGq4qjNRzBZYqgEL5\",\"171sgjn4YtPu27adkKGrdDwzRTxnRkBfKV\"]" As json rpc call -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "addmultisigaddress", "params": [2, "[\"16sSauSf5pF2UkUwvKGq4qjNRzBZYqgEL5\",\"171sgjn4YtPu27adkKGrdDwzRTxnRkBfKV\"]"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "addmultisigaddress", "params": [2, "[\"16sSauSf5pF2UkUwvKGq4qjNRzBZYqgEL5\",\"171sgjn4YtPu27adkKGrdDwzRTxnRkBfKV\"]"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-addnode "node" "add|remove|onetry" +addnode "node" "add|remove|onetry" Attempts to add or remove a node from the addnode list. Or try a connection to a node once. @@ -43,12 +43,12 @@ Nodes added using addnode (or -connect) are protected from DoS disconnection and full nodes/support SegWit as other outbound peers are (though such peers will not be synced from). Arguments: -1. "node" (string, required) The node (see getpeerinfo for nodes) -2. "command" (string, required) 'add' to add a node to the list, 'remove' to remove a node from the list, 'onetry' to try a connection to the node once +1. "node" (string, required) The node (see getpeerinfo for nodes) +2. "command" (string, required) 'add' to add a node to the list, 'remove' to remove a node from the list, 'onetry' to try a connection to the node once Examples: -> bitcoin-cli addnode "192.168.0.6:8333" "onetry" -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "addnode", "params": ["192.168.0.6:8333", "onetry"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli addnode "192.168.0.6:8333" "onetry" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "addnode", "params": ["192.168.0.6:8333", "onetry"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-backupwallet "destination" +backupwallet "destination" Safely copies current wallet file to destination, which can be a directory or a path with filename. Arguments: -1. "destination" (string) The destination directory or file +1. "destination" (string) The destination directory or file Examples: -> bitcoin-cli backupwallet "backup.dat" -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "backupwallet", "params": ["backup.dat"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli backupwallet "backup.dat" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "backupwallet", "params": ["backup.dat"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-bumpfee "txid" ( options ) +bumpfee "txid" ( options ) Bumps the fee of an opt-in-RBF transaction T, replacing it with a new transaction B. An opt-in RBF transaction with the given txid must be in the wallet. The command will pay the additional fee by decreasing (or perhaps removing) its change output. If the change output is not big enough to cover the increased fee, the command will currently fail instead of adding new inputs to compensate. (A future implementation could improve this.) -The command will fail if the wallet or mempool contains a transaction that spends one of T's outputs. +The command will fail if the wallet or mempool contains a transaction that spends one of T's outputs. By default, the new fee will be calculated automatically using estimatefee. The user can specify a confirmation target for estimatefee. Alternatively, the user can specify totalFee, or use RPC settxfee to set a higher fee rate. At a minimum, the new fee rate must be high enough to pay an additional new relay fee (incrementalfee -returned by getnetworkinfo) to enter the node's mempool. +returned by getnetworkinfo) to enter the node's mempool. Arguments: 1. txid (string, required) The txid to be bumped 2. options (object, optional) { - "confTarget" (numeric, optional) Confirmation target (in blocks) - "totalFee" (numeric, optional) Total fee (NOT feerate) to pay, in satoshis. + "confTarget" (numeric, optional) Confirmation target (in blocks) + "totalFee" (numeric, optional) Total fee (NOT feerate) to pay, in satoshis. In rare cases, the actual fee paid might be slightly higher than the specified totalFee if the tx change output has to be removed because it is too close to the dust threshold. - "replaceable" (boolean, optional, default true) Whether the new transaction should still be + "replaceable" (boolean, optional, default true) Whether the new transaction should still be marked bip-125 replaceable. If true, the sequence numbers in the transaction will be left unchanged from the original. If false, any input sequence numbers in the original transaction that were less than 0xfffffffe will be increased to 0xfffffffe so the new transaction will not be explicitly bip-125 replaceable (though it may still be replaceable in practice, for example if it has unconfirmed ancestors which are replaceable). - "estimate_mode" (string, optional, default=UNSET) The fee estimate mode, must be one of: - "UNSET" - "ECONOMICAL" - "CONSERVATIVE" + "estimate_mode" (string, optional, default=UNSET) The fee estimate mode, must be one of: + "UNSET" + "ECONOMICAL" + "CONSERVATIVE" } Result: { - "txid": "value", (string) The id of the new transaction - "origfee": n, (numeric) Fee of the replaced transaction - "fee": n, (numeric) Fee of the new transaction - "errors": [ str... ] (json array of strings) Errors encountered during processing (may be empty) + "txid": "value", (string) The id of the new transaction + "origfee": n, (numeric) Fee of the replaced transaction + "fee": n, (numeric) Fee of the new transaction + "errors": [ str... ] (json array of strings) Errors encountered during processing (may be empty) } Examples: -Bump the fee, get the new transaction's txid -> bitcoin-cli bumpfee+Bump the fee, get the new transaction's txid +> bitcoin-cli bumpfee <txid>
-combinerawtransaction ["hexstring",...] +combinerawtransaction ["hexstring",...] Combine multiple partially signed transactions into one transaction. The combined transaction may be another partially signed transaction or a fully signed transaction. Arguments: -1. "txs" (string) A json array of hex strings of partially signed transactions +1. "txs" (string) A json array of hex strings of partially signed transactions [ - "hexstring" (string) A transaction hash + "hexstring" (string) A transaction hash ,... ] Result: -"hex" (string) The hex-encoded raw transaction with signature(s) +"hex" (string) The hex-encoded raw transaction with signature(s) Examples: -> bitcoin-cli combinerawtransaction ["myhex1", "myhex2", "myhex3"] +> bitcoin-cli combinerawtransaction ["myhex1", "myhex2", "myhex3"]
-createmultisig nrequired ["key",...] +createmultisig nrequired ["key",...] Creates a multi-signature address with n signature of m keys required. It returns a json object with the address and redeemScript. @@ -45,25 +45,25 @@ to the wallet before upgrading to v0.17. To use the deprecated functionality, st Arguments: 1. nrequired (numeric, required) The number of required signatures out of the n keys or addresses. -2. "keys" (string, required) A json array of hex-encoded public keys +2. "keys" (string, required) A json array of hex-encoded public keys [ - "key" (string) The hex-encoded public key + "key" (string) The hex-encoded public key ,... ] Result: { - "address":"multisigaddress", (string) The value of the new multisig address. - "redeemScript":"script" (string) The string value of the hex-encoded redemption script. + "address":"multisigaddress", (string) The value of the new multisig address. + "redeemScript":"script" (string) The string value of the hex-encoded redemption script. } Examples: Create a multisig address from 2 public keys -> bitcoin-cli createmultisig 2 "[\"03789ed0bb717d88f7d321a368d905e7430207ebbd82bd342cf11ae157a7ace5fd\",\"03dbc6764b8884a92e871274b87583e6d5c2a58819473e17e107ef3f6aa5a61626\"]" +> bitcoin-cli createmultisig 2 "[\"03789ed0bb717d88f7d321a368d905e7430207ebbd82bd342cf11ae157a7ace5fd\",\"03dbc6764b8884a92e871274b87583e6d5c2a58819473e17e107ef3f6aa5a61626\"]" As a json rpc call -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "createmultisig", "params": [2, "[\"03789ed0bb717d88f7d321a368d905e7430207ebbd82bd342cf11ae157a7ace5fd\",\"03dbc6764b8884a92e871274b87583e6d5c2a58819473e17e107ef3f6aa5a61626\"]"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "createmultisig", "params": [2, "[\"03789ed0bb717d88f7d321a368d905e7430207ebbd82bd342cf11ae157a7ace5fd\",\"03dbc6764b8884a92e871274b87583e6d5c2a58819473e17e107ef3f6aa5a61626\"]"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-createrawtransaction [{"txid":"id","vout":n},...] {"address":amount,"data":"hex",...} ( locktime ) ( replaceable ) +createrawtransaction [{"txid":"id","vout":n},...] {"address":amount,"data":"hex",...} ( locktime ) ( replaceable ) Create a transaction spending the given inputs and creating new outputs. Outputs can be addresses or data. Returns hex-encoded raw transaction. -Note that the transaction's inputs are not signed, and +Note that the transaction's inputs are not signed, and it is not stored in the wallet or transmitted to the network. Arguments: -1. "inputs" (array, required) A json array of json objects +1. "inputs" (array, required) A json array of json objects [ { - "txid":"id", (string, required) The transaction id - "vout":n, (numeric, required) The output number - "sequence":n (numeric, optional) The sequence number + "txid":"id", (string, required) The transaction id + "vout":n, (numeric, required) The output number + "sequence":n (numeric, optional) The sequence number } ,... ] -2. "outputs" (object, required) a json object with outputs +2. "outputs" (object, required) a json object with outputs { - "address": x.xxx, (numeric or string, required) The key is the bitcoin address, the numeric value (can be string) is the BTC amount - "data": "hex" (string, required) The key is "data", the value is hex encoded data + "address": x.xxx, (numeric or string, required) The key is the bitcoin address, the numeric value (can be string) is the BTC amount + "data": "hex" (string, required) The key is "data", the value is hex encoded data ,... } 3. locktime (numeric, optional, default=0) Raw locktime. Non-0 value also locktime-activates inputs @@ -64,13 +64,13 @@ Arguments: Allows this transaction to be replaced by a transaction with higher fees. If provided, it is an error if explicit sequence numbers are incompatible. Result: -"transaction" (string) hex string of the transaction +"transaction" (string) hex string of the transaction Examples: -> bitcoin-cli createrawtransaction "[{\"txid\":\"myid\",\"vout\":0}]" "{\"address\":0.01}" -> bitcoin-cli createrawtransaction "[{\"txid\":\"myid\",\"vout\":0}]" "{\"data\":\"00010203\"}" -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "createrawtransaction", "params": ["[{\"txid\":\"myid\",\"vout\":0}]", "{\"address\":0.01}"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "createrawtransaction", "params": ["[{\"txid\":\"myid\",\"vout\":0}]", "{\"data\":\"00010203\"}"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli createrawtransaction "[{\"txid\":\"myid\",\"vout\":0}]" "{\"address\":0.01}" +> bitcoin-cli createrawtransaction "[{\"txid\":\"myid\",\"vout\":0}]" "{\"data\":\"00010203\"}" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "createrawtransaction", "params": ["[{\"txid\":\"myid\",\"vout\":0}]", "{\"address\":0.01}"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "createrawtransaction", "params": ["[{\"txid\":\"myid\",\"vout\":0}]", "{\"data\":\"00010203\"}"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-decoderawtransaction "hexstring" ( iswitness ) +decoderawtransaction "hexstring" ( iswitness ) Return a JSON object representing the serialized, hex-encoded transaction. Arguments: -1. "hexstring" (string, required) The transaction hex string +1. "hexstring" (string, required) The transaction hex string 2. iswitness (boolean, optional) Whether the transaction hex is a serialized witness transaction If iswitness is not present, heuristic tests will be used in decoding Result: { - "txid" : "id", (string) The transaction id - "hash" : "id", (string) The transaction hash (differs from txid for witness transactions) - "size" : n, (numeric) The transaction size - "vsize" : n, (numeric) The virtual transaction size (differs from size for witness transactions) - "version" : n, (numeric) The version - "locktime" : ttt, (numeric) The lock time - "vin" : [ (array of json objects) + "txid" : "id", (string) The transaction id + "hash" : "id", (string) The transaction hash (differs from txid for witness transactions) + "size" : n, (numeric) The transaction size + "vsize" : n, (numeric) The virtual transaction size (differs from size for witness transactions) + "version" : n, (numeric) The version + "locktime" : ttt, (numeric) The lock time + "vin" : [ (array of json objects) { - "txid": "id", (string) The transaction id - "vout": n, (numeric) The output number - "scriptSig": { (json object) The script - "asm": "asm", (string) asm - "hex": "hex" (string) hex + "txid": "id", (string) The transaction id + "vout": n, (numeric) The output number + "scriptSig": { (json object) The script + "asm": "asm", (string) asm + "hex": "hex" (string) hex }, - "txinwitness": ["hex", ...] (array of string) hex-encoded witness data (if any) - "sequence": n (numeric) The script sequence number + "txinwitness": ["hex", ...] (array of string) hex-encoded witness data (if any) + "sequence": n (numeric) The script sequence number } ,... ], - "vout" : [ (array of json objects) + "vout" : [ (array of json objects) { - "value" : x.xxx, (numeric) The value in BTC - "n" : n, (numeric) index - "scriptPubKey" : { (json object) - "asm" : "asm", (string) the asm - "hex" : "hex", (string) the hex - "reqSigs" : n, (numeric) The required sigs - "type" : "pubkeyhash", (string) The type, eg 'pubkeyhash' - "addresses" : [ (json array of string) - "12tvKAXCxZjSmdNbao16dKXC8tRWfcF5oc" (string) bitcoin address + "value" : x.xxx, (numeric) The value in BTC + "n" : n, (numeric) index + "scriptPubKey" : { (json object) + "asm" : "asm", (string) the asm + "hex" : "hex", (string) the hex + "reqSigs" : n, (numeric) The required sigs + "type" : "pubkeyhash", (string) The type, eg 'pubkeyhash' + "addresses" : [ (json array of string) + "12tvKAXCxZjSmdNbao16dKXC8tRWfcF5oc" (string) bitcoin address ,... ] } @@ -85,8 +85,8 @@ Result: } Examples: -> bitcoin-cli decoderawtransaction "hexstring" -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "decoderawtransaction", "params": ["hexstring"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli decoderawtransaction "hexstring" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "decoderawtransaction", "params": ["hexstring"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-decodescript "hexstring" +decodescript "hexstring" Decode a hex-encoded script. Arguments: -1. "hexstring" (string) the hex encoded script +1. "hexstring" (string) the hex encoded script Result: { - "asm":"asm", (string) Script public key - "hex":"hex", (string) hex encoded public key - "type":"type", (string) The output type - "reqSigs": n, (numeric) The required signatures - "addresses": [ (json array of string) - "address" (string) bitcoin address + "asm":"asm", (string) Script public key + "hex":"hex", (string) hex encoded public key + "type":"type", (string) The output type + "reqSigs": n, (numeric) The required signatures + "addresses": [ (json array of string) + "address" (string) bitcoin address ,... ], - "p2sh","address" (string) address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH). + "p2sh","address" (string) address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH). } Examples: -> bitcoin-cli decodescript "hexstring" -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "decodescript", "params": ["hexstring"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli decodescript "hexstring" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "decodescript", "params": ["hexstring"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-disconnectnode "[address]" [nodeid] +disconnectnode "[address]" [nodeid] Immediately disconnects from the specified peer node. -Strictly one out of 'address' and 'nodeid' can be provided to identify the node. +Strictly one out of 'address' and 'nodeid' can be provided to identify the node. -To disconnect by nodeid, either set 'address' to the empty string, or call using the named 'nodeid' argument only. +To disconnect by nodeid, either set 'address' to the empty string, or call using the named 'nodeid' argument only. Arguments: -1. "address" (string, optional) The IP address/port of the node -2. "nodeid" (number, optional) The node ID (see getpeerinfo for node IDs) +1. "address" (string, optional) The IP address/port of the node +2. "nodeid" (number, optional) The node ID (see getpeerinfo for node IDs) Examples: -> bitcoin-cli disconnectnode "192.168.0.6:8333" -> bitcoin-cli disconnectnode "" 1 -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "disconnectnode", "params": ["192.168.0.6:8333"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "disconnectnode", "params": ["", 1] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli disconnectnode "192.168.0.6:8333" +> bitcoin-cli disconnectnode "" 1 +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "disconnectnode", "params": ["192.168.0.6:8333"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "disconnectnode", "params": ["", 1] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-dumpprivkey "address" +dumpprivkey "address" -Reveals the private key corresponding to 'address'. +Reveals the private key corresponding to 'address'. Then the importprivkey can be used with this output Arguments: -1. "address" (string, required) The bitcoin address for the private key +1. "address" (string, required) The bitcoin address for the private key Result: -"key" (string) The private key +"key" (string) The private key Examples: -> bitcoin-cli dumpprivkey "myaddress" -> bitcoin-cli importprivkey "mykey" -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "dumpprivkey", "params": ["myaddress"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli dumpprivkey "myaddress" +> bitcoin-cli importprivkey "mykey" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "dumpprivkey", "params": ["myaddress"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-dumpwallet "filename" +dumpwallet "filename" Dumps all wallet keys in a human-readable format to a server-side file. This does not allow overwriting existing files. Imported scripts are included in the dumpfile, but corresponding BIP173 addresses, etc. may not be added automatically by importwallet. @@ -43,16 +43,16 @@ Note that if your wallet contains keys which are not derived from your HD seed ( only backing up the seed itself, and must be backed up too (e.g. ensure you back up the whole dumpfile). Arguments: -1. "filename" (string, required) The filename with path (either absolute or relative to bitcoind) +1. "filename" (string, required) The filename with path (either absolute or relative to bitcoind) Result: { (json object) - "filename" : { (string) The filename with full absolute path + "filename" : { (string) The filename with full absolute path } Examples: -> bitcoin-cli dumpwallet "test" -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "dumpwallet", "params": ["test"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli dumpwallet "test" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "dumpwallet", "params": ["test"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-encryptwallet "passphrase" +encryptwallet "passphrase" -Encrypts the wallet with 'passphrase'. This is for first time encryption. +Encrypts the wallet with 'passphrase'. This is for first time encryption. After this, any calls that interact with private keys such as sending or signing will require the passphrase to be set prior the making these calls. Use the walletpassphrase call for this, and then walletlock call. @@ -45,24 +45,24 @@ If the wallet is already encrypted, use the walletpassphrasechange call. Note that this will shutdown the server. Arguments: -1. "passphrase" (string) The pass phrase to encrypt the wallet with. It must be at least 1 character, but should be long. +1. "passphrase" (string) The pass phrase to encrypt the wallet with. It must be at least 1 character, but should be long. Examples: Encrypt your wallet -> bitcoin-cli encryptwallet "my pass phrase" +> bitcoin-cli encryptwallet "my pass phrase" Now set the passphrase to use the wallet, such as for signing or sending bitcoin -> bitcoin-cli walletpassphrase "my pass phrase" +> bitcoin-cli walletpassphrase "my pass phrase" Now we can do something like sign -> bitcoin-cli signmessage "address" "test message" +> bitcoin-cli signmessage "address" "test message" Now lock the wallet again by removing the passphrase -> bitcoin-cli walletlock +> bitcoin-cli walletlock As a json rpc call -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "encryptwallet", "params": ["my pass phrase"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "encryptwallet", "params": ["my pass phrase"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-estimatesmartfee conf_target ("estimate_mode") +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 @@ -44,21 +44,21 @@ in BIP 141 (witness data is discounted). Arguments: 1. conf_target (numeric) Confirmation target in blocks (1 - 1008) -2. "estimate_mode" (string, optional, default=CONSERVATIVE) The fee estimate mode. +2. "estimate_mode" (string, optional, default=CONSERVATIVE) The fee estimate mode. Whether to return a more conservative estimate which also satisfies a longer history. A conservative estimate potentially returns a higher feerate and is more likely to be sufficient for the desired target, but is not as responsive to short term drops in the prevailing fee market. Must be one of: - "UNSET" (defaults to CONSERVATIVE) - "ECONOMICAL" - "CONSERVATIVE" + "UNSET" (defaults to CONSERVATIVE) + "ECONOMICAL" + "CONSERVATIVE" Result: { - "feerate" : x.x, (numeric, optional) estimate fee rate in BTC/kB - "errors": [ str... ] (json array of strings, optional) Errors encountered during processing - "blocks" : n (numeric) block number where estimate was found + "feerate" : x.x, (numeric, optional) estimate fee rate in BTC/kB + "errors": [ str... ] (json array of strings, optional) Errors encountered during processing + "blocks" : n (numeric) block number where estimate was found } The request target will be clamped between 2 and the highest target @@ -67,7 +67,7 @@ An error is returned if not enough transactions and blocks have been observed to make an estimate for any number of blocks. Example: -> bitcoin-cli estimatesmartfee 6 +> bitcoin-cli estimatesmartfee 6
-fundrawtransaction "hexstring" ( options iswitness ) +fundrawtransaction "hexstring" ( options iswitness ) Add inputs to a transaction until it has enough in value to meet its out value. This will not modify existing inputs, and will add at most one change output to the outputs. -No existing outputs will be modified unless "subtractFeeFromOutputs" is specified. +No existing outputs will be modified unless "subtractFeeFromOutputs" is specified. Note that inputs which were signed may need to be resigned after completion since in/outputs have been added. The inputs added will not be signed, use signrawtransaction for that. Note that all existing inputs must have their previous output transaction be in the wallet. Note that all inputs selected must be of standard form and P2SH scripts must be in the wallet using importaddress or addmultisigaddress (to calculate fees). -You can see whether this is the case by checking the "solvable" field in the listunspent output. +You can see whether this is the case by checking the "solvable" field in the listunspent output. Only pay-to-pubkey, multisig, and P2SH versions thereof are currently supported for watch-only Arguments: -1. "hexstring" (string, required) The hex string of the raw transaction +1. "hexstring" (string, required) The hex string of the raw transaction 2. options (object, optional) { - "changeAddress" (string, optional, default pool address) The bitcoin address to receive the change - "changePosition" (numeric, optional, default random) The index of the change output - "change_type" (string, optional) The output type to use. Only valid if changeAddress is not specified. Options are "legacy", "p2sh-segwit", and "bech32". Default is set by -changetype. - "includeWatching" (boolean, optional, default false) Also select inputs which are watch only - "lockUnspents" (boolean, optional, default false) Lock selected unspent outputs - "feeRate" (numeric, optional, default not set: makes wallet determine the fee) Set a specific fee rate in BTC/kB - "subtractFeeFromOutputs" (array, optional) A json array of integers. + "changeAddress" (string, optional, default pool address) The bitcoin address to receive the change + "changePosition" (numeric, optional, default random) The index of the change output + "change_type" (string, optional) The output type to use. Only valid if changeAddress is not specified. Options are "legacy", "p2sh-segwit", and "bech32". Default is set by -changetype. + "includeWatching" (boolean, optional, default false) Also select inputs which are watch only + "lockUnspents" (boolean, optional, default false) Lock selected unspent outputs + "feeRate" (numeric, optional, default not set: makes wallet determine the fee) Set a specific fee rate in BTC/kB + "subtractFeeFromOutputs" (array, optional) A json array of integers. The fee will be equally deducted from the amount of each specified output. The outputs are specified by their zero-based index, before any change output is added. Those recipients will receive less bitcoins than you enter in their corresponding amount field. If no outputs are specified here, the sender pays the fee. [vout_index,...] - "replaceable" (boolean, optional) Marks this transaction as BIP125 replaceable. + "replaceable" (boolean, optional) Marks this transaction as BIP125 replaceable. Allows this transaction to be replaced by a transaction with higher fees - "conf_target" (numeric, optional) Confirmation target (in blocks) - "estimate_mode" (string, optional, default=UNSET) The fee estimate mode, must be one of: - "UNSET" - "ECONOMICAL" - "CONSERVATIVE" + "conf_target" (numeric, optional) Confirmation target (in blocks) + "estimate_mode" (string, optional, default=UNSET) The fee estimate mode, must be one of: + "UNSET" + "ECONOMICAL" + "CONSERVATIVE" } - for backward compatibility: passing in a true instead of an object will result in {"includeWatching":true} + for backward compatibility: passing in a true instead of an object will result in {"includeWatching":true} 3. iswitness (boolean, optional) Whether the transaction hex is a serialized witness transaction If iswitness is not present, heuristic tests will be used in decoding Result: { - "hex": "value", (string) The resulting raw transaction (hex-encoded string) - "fee": n, (numeric) Fee in BTC the resulting transaction pays - "changepos": n (numeric) The position of the added change output, or -1 + "hex": "value", (string) The resulting raw transaction (hex-encoded string) + "fee": n, (numeric) Fee in BTC the resulting transaction pays + "changepos": n (numeric) The position of the added change output, or -1 } Examples: Create a transaction with no inputs -> bitcoin-cli createrawtransaction "[]" "{\"myaddress\":0.01}" +> bitcoin-cli createrawtransaction "[]" "{\"myaddress\":0.01}" Add sufficient unsigned inputs to meet the output value -> bitcoin-cli fundrawtransaction "rawtransactionhex" +> bitcoin-cli fundrawtransaction "rawtransactionhex" Sign the transaction -> bitcoin-cli signrawtransaction "fundedtransactionhex" +> bitcoin-cli signrawtransaction "fundedtransactionhex" Send the transaction -> bitcoin-cli sendrawtransaction "signedtransactionhex" +> bitcoin-cli sendrawtransaction "signedtransactionhex"
-getaccount "address" +getaccount "address" DEPRECATED. Returns the account associated with the given address. Arguments: -1. "address" (string, required) The bitcoin address for account lookup. +1. "address" (string, required) The bitcoin address for account lookup. Result: -"accountname" (string) the account address +"accountname" (string) the account address Examples: -> bitcoin-cli getaccount "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaccount", "params": ["1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli getaccount "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaccount", "params": ["1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-getaccountaddress "account" +getaccountaddress "account" DEPRECATED. Returns the current Bitcoin address for receiving payments to this account. Arguments: -1. "account" (string, required) The account name for the address. It can also be set to the empty string "" to represent the default account. The account does not need to exist, it will be created and a new address created if there is no account by the given name. +1. "account" (string, required) The account name for the address. It can also be set to the empty string "" to represent the default account. The account does not need to exist, it will be created and a new address created if there is no account by the given name. Result: -"address" (string) The account bitcoin address +"address" (string) The account bitcoin address Examples: -> bitcoin-cli getaccountaddress -> bitcoin-cli getaccountaddress "" -> bitcoin-cli getaccountaddress "myaccount" -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaccountaddress", "params": ["myaccount"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli getaccountaddress +> bitcoin-cli getaccountaddress "" +> bitcoin-cli getaccountaddress "myaccount" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaccountaddress", "params": ["myaccount"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-getaddednodeinfo ( "node" ) +getaddednodeinfo ( "node" ) Returns information about the given added node, or all added nodes (note that onetry addnodes are not listed here) Arguments: -1. "node" (string, optional) If provided, return information about this specific node, otherwise all nodes are returned. +1. "node" (string, optional) If provided, return information about this specific node, otherwise all nodes are returned. Result: [ { - "addednode" : "192.168.0.201", (string) The node IP address or name (as provided to addnode) - "connected" : true|false, (boolean) If connected - "addresses" : [ (list of objects) Only when connected = true + "addednode" : "192.168.0.201", (string) The node IP address or name (as provided to addnode) + "connected" : true|false, (boolean) If connected + "addresses" : [ (list of objects) Only when connected = true { - "address" : "192.168.0.201:8333", (string) The bitcoin server IP and port we're connected to - "connected" : "outbound" (string) connection, inbound or outbound + "address" : "192.168.0.201:8333", (string) The bitcoin server IP and port we're connected to + "connected" : "outbound" (string) connection, inbound or outbound } ] } @@ -59,8 +59,8 @@ Result: ] Examples: -> bitcoin-cli getaddednodeinfo "192.168.0.201" -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaddednodeinfo", "params": ["192.168.0.201"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli getaddednodeinfo "192.168.0.201" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaddednodeinfo", "params": ["192.168.0.201"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-getaddressesbyaccount "account" +getaddressesbyaccount "account" DEPRECATED. Returns the list of addresses for the given account. Arguments: -1. "account" (string, required) The account name. +1. "account" (string, required) The account name. Result: [ (json array of string) - "address" (string) a bitcoin address associated with the given account + "address" (string) a bitcoin address associated with the given account ,... ] Examples: -> bitcoin-cli getaddressesbyaccount "tabby" -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaddressesbyaccount", "params": ["tabby"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli getaddressesbyaccount "tabby" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaddressesbyaccount", "params": ["tabby"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-getbalance ( "account" minconf include_watchonly ) +getbalance ( "account" minconf include_watchonly ) -If account is not specified, returns the server's total available balance. +If account is not specified, returns the server's total available balance. The available balance is what the wallet considers currently spendable, and is thus affected by options which limit spendability such as -spendzeroconfchange. If account is specified (DEPRECATED), returns the balance in the account. -Note that the account "" is not the same as leaving the parameter out. -The server total may be different to the balance in the default "" account. +Note that the account "" is not the same as leaving the parameter out. +The server total may be different to the balance in the default "" account. Arguments: -1. "account" (string, optional) DEPRECATED. The account string may be given as a +1. "account" (string, optional) DEPRECATED. The account string may be given as a specific account name to find the balance associated with wallet keys in - a named account, or as the empty string ("") to find the balance - associated with wallet keys not in any named account, or as "*" to find + a named account, or as the empty string ("") to find the balance + associated with wallet keys not in any named account, or as "*" to find the balance associated with all wallet keys regardless of account. When this option is specified, it calculates the balance in a different way than when it is not specified, and which can count spends twice when @@ -58,7 +58,7 @@ Arguments: reliable and has resulted in confusing outcomes, so it is recommended to avoid passing this argument. 2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times. -3. include_watchonly (bool, optional, default=false) Also include balance in watch-only addresses (see 'importaddress') +3. include_watchonly (bool, optional, default=false) Also include balance in watch-only addresses (see 'importaddress') Result: amount (numeric) The total amount in BTC received for this account. @@ -66,13 +66,13 @@ amount (numeric) The total amount in BTC received for this account. Examples: The total amount in the wallet with 1 or more confirmations -> bitcoin-cli getbalance +> bitcoin-cli getbalance The total amount in the wallet at least 6 blocks confirmed -> bitcoin-cli getbalance "*" 6 +> bitcoin-cli getbalance "*" 6 As a json rpc call -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getbalance", "params": ["*", 6] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getbalance", "params": ["*", 6] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-getblock "blockhash" ( verbosity ) +getblock "blockhash" ( verbosity ) -If verbosity is 0, returns a string that is serialized, hex-encoded data for block 'hash'. -If verbosity is 1, returns an Object with information about block. -If verbosity is 2, returns an Object with information about block and information about each transaction. +If verbosity is 0, returns a string that is serialized, hex-encoded data for block 'hash'. +If verbosity is 1, returns an Object with information about block <hash>. +If verbosity is 2, returns an Object with information about block <hash> and information about each transaction. Arguments: -1. "blockhash" (string, required) The block hash +1. "blockhash" (string, required) The block hash 2. verbosity (numeric, optional, default=1) 0 for hex encoded data, 1 for a json object, and 2 for json object with transaction data Result (for verbosity = 0): -"data" (string) A string that is serialized, hex-encoded data for block 'hash'. +"data" (string) A string that is serialized, hex-encoded data for block 'hash'. Result (for verbosity = 1): { - "hash" : "hash", (string) the block hash (same as provided) - "confirmations" : n, (numeric) The number of confirmations, or -1 if the block is not on the main chain - "size" : n, (numeric) The block size - "strippedsize" : n, (numeric) The block size excluding witness data - "weight" : n (numeric) The block weight as defined in BIP 141 - "height" : n, (numeric) The block height or index - "version" : n, (numeric) The block version - "versionHex" : "00000000", (string) The block version formatted in hexadecimal - "merkleroot" : "xxxx", (string) The merkle root - "tx" : [ (array of string) The transaction ids - "transactionid" (string) The transaction id + "hash" : "hash", (string) the block hash (same as provided) + "confirmations" : n, (numeric) The number of confirmations, or -1 if the block is not on the main chain + "size" : n, (numeric) The block size + "strippedsize" : n, (numeric) The block size excluding witness data + "weight" : n (numeric) The block weight as defined in BIP 141 + "height" : n, (numeric) The block height or index + "version" : n, (numeric) The block version + "versionHex" : "00000000", (string) The block version formatted in hexadecimal + "merkleroot" : "xxxx", (string) The merkle root + "tx" : [ (array of string) The transaction ids + "transactionid" (string) The transaction id ,... ], - "time" : ttt, (numeric) The block time in seconds since epoch (Jan 1 1970 GMT) - "mediantime" : ttt, (numeric) The median block time in seconds since epoch (Jan 1 1970 GMT) - "nonce" : n, (numeric) The nonce - "bits" : "1d00ffff", (string) The bits - "difficulty" : x.xxx, (numeric) The difficulty - "chainwork" : "xxxx", (string) Expected number of hashes required to produce the chain up to this block (in hex) - "previousblockhash" : "hash", (string) The hash of the previous block - "nextblockhash" : "hash" (string) The hash of the next block + "time" : ttt, (numeric) The block time in seconds since epoch (Jan 1 1970 GMT) + "mediantime" : ttt, (numeric) The median block time in seconds since epoch (Jan 1 1970 GMT) + "nonce" : n, (numeric) The nonce + "bits" : "1d00ffff", (string) The bits + "difficulty" : x.xxx, (numeric) The difficulty + "chainwork" : "xxxx", (string) Expected number of hashes required to produce the chain up to this block (in hex) + "previousblockhash" : "hash", (string) The hash of the previous block + "nextblockhash" : "hash" (string) The hash of the next block } Result (for verbosity = 2): { ..., Same output as verbosity = 1. - "tx" : [ (array of Objects) The transactions in the format of the getrawtransaction RPC. Different from verbosity = 1 "tx" result. + "tx" : [ (array of Objects) The transactions in the format of the getrawtransaction RPC. Different from verbosity = 1 "tx" result. ,... ], ,... Same output as verbosity = 1. } Examples: -> bitcoin-cli getblock "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09" -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblock", "params": ["00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli getblock "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblock", "params": ["00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-getblockheader "hash" ( verbose ) +getblockheader "hash" ( verbose ) -If verbose is false, returns a string that is serialized, hex-encoded data for blockheader 'hash'. -If verbose is true, returns an Object with information about blockheader. +If verbose is false, returns a string that is serialized, hex-encoded data for blockheader 'hash'. +If verbose is true, returns an Object with information about blockheader <hash>. Arguments: -1. "hash" (string, required) The block hash +1. "hash" (string, required) The block hash 2. verbose (boolean, optional, default=true) true for a json object, false for the hex encoded data Result (for verbose = true): { - "hash" : "hash", (string) the block hash (same as provided) - "confirmations" : n, (numeric) The number of confirmations, or -1 if the block is not on the main chain - "height" : n, (numeric) The block height or index - "version" : n, (numeric) The block version - "versionHex" : "00000000", (string) The block version formatted in hexadecimal - "merkleroot" : "xxxx", (string) The merkle root - "time" : ttt, (numeric) The block time in seconds since epoch (Jan 1 1970 GMT) - "mediantime" : ttt, (numeric) The median block time in seconds since epoch (Jan 1 1970 GMT) - "nonce" : n, (numeric) The nonce - "bits" : "1d00ffff", (string) The bits - "difficulty" : x.xxx, (numeric) The difficulty - "chainwork" : "0000...1f3" (string) Expected number of hashes required to produce the current chain (in hex) - "previousblockhash" : "hash", (string) The hash of the previous block - "nextblockhash" : "hash", (string) The hash of the next block + "hash" : "hash", (string) the block hash (same as provided) + "confirmations" : n, (numeric) The number of confirmations, or -1 if the block is not on the main chain + "height" : n, (numeric) The block height or index + "version" : n, (numeric) The block version + "versionHex" : "00000000", (string) The block version formatted in hexadecimal + "merkleroot" : "xxxx", (string) The merkle root + "time" : ttt, (numeric) The block time in seconds since epoch (Jan 1 1970 GMT) + "mediantime" : ttt, (numeric) The median block time in seconds since epoch (Jan 1 1970 GMT) + "nonce" : n, (numeric) The nonce + "bits" : "1d00ffff", (string) The bits + "difficulty" : x.xxx, (numeric) The difficulty + "chainwork" : "0000...1f3" (string) Expected number of hashes required to produce the current chain (in hex) + "previousblockhash" : "hash", (string) The hash of the previous block + "nextblockhash" : "hash", (string) The hash of the next block } Result (for verbose=false): -"data" (string) A string that is serialized, hex-encoded data for block 'hash'. +"data" (string) A string that is serialized, hex-encoded data for block 'hash'. Examples: -> bitcoin-cli getblockheader "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09" -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblockheader", "params": ["00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli getblockheader "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblockheader", "params": ["00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
getblocktemplate ( TemplateRequest ) -If the request parameters include a 'mode' key, that is used to explicitly select between the default 'template' request or a 'proposal'. +If the request parameters include a 'mode' key, that is used to explicitly select between the default 'template' request or a 'proposal'. It returns data needed to construct a block to work on. For full specification, see BIPs 22, 23, 9, and 145: https://github.com/bitcoin/bips/blob/master/bip-0022.mediawiki @@ -48,13 +48,13 @@ For full specification, see BIPs 22, 23, 9, and 145: Arguments: 1. template_request (json object, optional) A json object in the following spec { - "mode":"template" (string, optional) This must be set to "template", "proposal" (see BIP 23), or omitted - "capabilities":[ (array, optional) A list of strings - "support" (string) client side supported feature, 'longpoll', 'coinbasetxn', 'coinbasevalue', 'proposal', 'serverlist', 'workid' + "mode":"template" (string, optional) This must be set to "template", "proposal" (see BIP 23), or omitted + "capabilities":[ (array, optional) A list of strings + "support" (string) client side supported feature, 'longpoll', 'coinbasetxn', 'coinbasevalue', 'proposal', 'serverlist', 'workid' ,... ], - "rules":[ (array, optional) A list of strings - "support" (string) client side supported softfork deployment + "rules":[ (array, optional) A list of strings + "support" (string) client side supported softfork deployment ,... ] } @@ -62,53 +62,53 @@ Arguments: Result: { - "version" : n, (numeric) The preferred block version - "rules" : [ "rulename", ... ], (array of strings) specific block rules that are to be enforced - "vbavailable" : { (json object) set of pending, supported versionbit (BIP 9) softfork deployments - "rulename" : bitnumber (numeric) identifies the bit number as indicating acceptance and readiness for the named softfork rule + "version" : n, (numeric) The preferred block version + "rules" : [ "rulename", ... ], (array of strings) specific block rules that are to be enforced + "vbavailable" : { (json object) set of pending, supported versionbit (BIP 9) softfork deployments + "rulename" : bitnumber (numeric) identifies the bit number as indicating acceptance and readiness for the named softfork rule ,... }, - "vbrequired" : n, (numeric) bit mask of versionbits the server requires set in submissions - "previousblockhash" : "xxxx", (string) The hash of current highest block - "transactions" : [ (array) contents of non-coinbase transactions that should be included in the next block + "vbrequired" : n, (numeric) bit mask of versionbits the server requires set in submissions + "previousblockhash" : "xxxx", (string) The hash of current highest block + "transactions" : [ (array) contents of non-coinbase transactions that should be included in the next block { - "data" : "xxxx", (string) transaction data encoded in hexadecimal (byte-for-byte) - "txid" : "xxxx", (string) transaction id encoded in little-endian hexadecimal - "hash" : "xxxx", (string) hash encoded in little-endian hexadecimal (including witness data) - "depends" : [ (array) array of numbers - n (numeric) transactions before this one (by 1-based index in 'transactions' list) that must be present in the final block if this one is + "data" : "xxxx", (string) transaction data encoded in hexadecimal (byte-for-byte) + "txid" : "xxxx", (string) transaction id encoded in little-endian hexadecimal + "hash" : "xxxx", (string) hash encoded in little-endian hexadecimal (including witness data) + "depends" : [ (array) array of numbers + n (numeric) transactions before this one (by 1-based index in 'transactions' list) that must be present in the final block if this one is ,... ], - "fee": n, (numeric) difference in value between transaction inputs and outputs (in satoshis); for coinbase transactions, this is a negative Number of the total collected block fees (ie, not including the block subsidy); if key is not present, fee is unknown and clients MUST NOT assume there isn't one - "sigops" : n, (numeric) total SigOps cost, as counted for purposes of block limits; if key is not present, sigop cost is unknown and clients MUST NOT assume it is zero - "weight" : n, (numeric) total transaction weight, as counted for purposes of block limits - "required" : true|false (boolean) if provided and true, this transaction must be in the final block + "fee": n, (numeric) difference in value between transaction inputs and outputs (in satoshis); for coinbase transactions, this is a negative Number of the total collected block fees (ie, not including the block subsidy); if key is not present, fee is unknown and clients MUST NOT assume there isn't one + "sigops" : n, (numeric) total SigOps cost, as counted for purposes of block limits; if key is not present, sigop cost is unknown and clients MUST NOT assume it is zero + "weight" : n, (numeric) total transaction weight, as counted for purposes of block limits + "required" : true|false (boolean) if provided and true, this transaction must be in the final block } ,... ], - "coinbaseaux" : { (json object) data that should be included in the coinbase's scriptSig content - "flags" : "xx" (string) key name is to be ignored, and value included in scriptSig + "coinbaseaux" : { (json object) data that should be included in the coinbase's scriptSig content + "flags" : "xx" (string) key name is to be ignored, and value included in scriptSig }, - "coinbasevalue" : n, (numeric) maximum allowable input to coinbase transaction, including the generation award and transaction fees (in satoshis) - "coinbasetxn" : { ... }, (json object) information for coinbase transaction - "target" : "xxxx", (string) The hash target - "mintime" : xxx, (numeric) The minimum timestamp appropriate for next block time in seconds since epoch (Jan 1 1970 GMT) - "mutable" : [ (array of string) list of ways the block template may be changed - "value" (string) A way the block template may be changed, e.g. 'time', 'transactions', 'prevblock' + "coinbasevalue" : n, (numeric) maximum allowable input to coinbase transaction, including the generation award and transaction fees (in satoshis) + "coinbasetxn" : { ... }, (json object) information for coinbase transaction + "target" : "xxxx", (string) The hash target + "mintime" : xxx, (numeric) The minimum timestamp appropriate for next block time in seconds since epoch (Jan 1 1970 GMT) + "mutable" : [ (array of string) list of ways the block template may be changed + "value" (string) A way the block template may be changed, e.g. 'time', 'transactions', 'prevblock' ,... ], - "noncerange" : "00000000ffffffff",(string) A range of valid nonces - "sigoplimit" : n, (numeric) limit of sigops in blocks - "sizelimit" : n, (numeric) limit of block size - "weightlimit" : n, (numeric) limit of block weight - "curtime" : ttt, (numeric) current timestamp in seconds since epoch (Jan 1 1970 GMT) - "bits" : "xxxxxxxx", (string) compressed target of next block - "height" : n (numeric) The height of the next block + "noncerange" : "00000000ffffffff",(string) A range of valid nonces + "sigoplimit" : n, (numeric) limit of sigops in blocks + "sizelimit" : n, (numeric) limit of block size + "weightlimit" : n, (numeric) limit of block weight + "curtime" : ttt, (numeric) current timestamp in seconds since epoch (Jan 1 1970 GMT) + "bits" : "xxxxxxxx", (string) compressed target of next block + "height" : n (numeric) The height of the next block } Examples: -> bitcoin-cli getblocktemplate -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblocktemplate", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli getblocktemplate +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblocktemplate", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-getmemoryinfo ("mode") +getmemoryinfo ("mode") Returns an object containing information about memory usage. Arguments: -1. "mode" determines what kind of information is returned. This argument is optional, the default mode is "stats". - - "stats" returns general statistics about memory usage in the daemon. - - "mallocinfo" returns an XML string describing low-level heap state (only available if compiled with glibc 2.10+). +1. "mode" determines what kind of information is returned. This argument is optional, the default mode is "stats". + - "stats" returns general statistics about memory usage in the daemon. + - "mallocinfo" returns an XML string describing low-level heap state (only available if compiled with glibc 2.10+). -Result (mode "stats"): +Result (mode "stats"): { - "locked": { (json object) Information about locked memory manager - "used": xxxxx, (numeric) Number of bytes used - "free": xxxxx, (numeric) Number of bytes available in current arenas - "total": xxxxxxx, (numeric) Total number of bytes managed - "locked": xxxxxx, (numeric) Amount of bytes that succeeded locking. If this number is smaller than total, locking pages failed at some point and key data could be swapped to disk. - "chunks_used": xxxxx, (numeric) Number allocated chunks - "chunks_free": xxxxx, (numeric) Number unused chunks + "locked": { (json object) Information about locked memory manager + "used": xxxxx, (numeric) Number of bytes used + "free": xxxxx, (numeric) Number of bytes available in current arenas + "total": xxxxxxx, (numeric) Total number of bytes managed + "locked": xxxxxx, (numeric) Amount of bytes that succeeded locking. If this number is smaller than total, locking pages failed at some point and key data could be swapped to disk. + "chunks_used": xxxxx, (numeric) Number allocated chunks + "chunks_free": xxxxx, (numeric) Number unused chunks } } -Result (mode "mallocinfo"): -"..." +Result (mode "mallocinfo"): +"<malloc version="1">..." Examples: -> bitcoin-cli getmemoryinfo -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getmemoryinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli getmemoryinfo +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getmemoryinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-getnewaddress ( "account" "address_type" ) +getnewaddress ( "account" "address_type" ) Returns a new Bitcoin address for receiving payments. -If 'account' is specified (DEPRECATED), it is added to the address book -so payments received with the address will be credited to 'account'. +If 'account' is specified (DEPRECATED), it is added to the address book +so payments received with the address will be credited to 'account'. Arguments: -1. "account" (string, optional) DEPRECATED. The account name for the address to be linked to. If not provided, the default account "" is used. It can also be set to the empty string "" to represent the default account. The account does not need to exist, it will be created if there is no account by the given name. -2. "address_type" (string, optional) The address type to use. Options are "legacy", "p2sh-segwit", and "bech32". Default is set by -addresstype. +1. "account" (string, optional) DEPRECATED. The account name for the address to be linked to. If not provided, the default account "" is used. It can also be set to the empty string "" to represent the default account. The account does not need to exist, it will be created if there is no account by the given name. +2. "address_type" (string, optional) The address type to use. Options are "legacy", "p2sh-segwit", and "bech32". Default is set by -addresstype. Result: -"address" (string) The new bitcoin address +"address" (string) The new bitcoin address Examples: -> bitcoin-cli getnewaddress -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getnewaddress", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli getnewaddress +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getnewaddress", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-getrawchangeaddress ( "address_type" ) +getrawchangeaddress ( "address_type" ) Returns a new Bitcoin address, for receiving change. This is for use with raw transactions, NOT normal use. Arguments: -1. "address_type" (string, optional) The address type to use. Options are "legacy", "p2sh-segwit", and "bech32". Default is set by -changetype. +1. "address_type" (string, optional) The address type to use. Options are "legacy", "p2sh-segwit", and "bech32". Default is set by -changetype. Result: -"address" (string) The address +"address" (string) The address Examples: -> bitcoin-cli getrawchangeaddress -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getrawchangeaddress", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli getrawchangeaddress +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getrawchangeaddress", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-getrawtransaction "txid" ( verbose "blockhash" ) +getrawtransaction "txid" ( verbose "blockhash" ) NOTE: By default this function only works for mempool transactions. If the -txindex option is enabled, it also works for blockchain transactions. If the block which contains the transaction @@ -46,69 +46,69 @@ DEPRECATED: for now, it also works for transactions with unspent outputs. Return the raw transaction data. -If verbose is 'true', returns an Object with information about 'txid'. -If verbose is 'false' or omitted, returns a string that is serialized, hex-encoded data for 'txid'. +If verbose is 'true', returns an Object with information about 'txid'. +If verbose is 'false' or omitted, returns a string that is serialized, hex-encoded data for 'txid'. Arguments: -1. "txid" (string, required) The transaction id +1. "txid" (string, required) The transaction id 2. verbose (bool, optional, default=false) If false, return a string, otherwise return a json object -3. "blockhash" (string, optional) The block in which to look for the transaction +3. "blockhash" (string, optional) The block in which to look for the transaction Result (if verbose is not set or set to false): -"data" (string) The serialized, hex-encoded data for 'txid' +"data" (string) The serialized, hex-encoded data for 'txid' Result (if verbose is set to true): { - "in_active_chain": b, (bool) Whether specified block is in the active chain or not (only present with explicit "blockhash" argument) - "hex" : "data", (string) The serialized, hex-encoded data for 'txid' - "txid" : "id", (string) The transaction id (same as provided) - "hash" : "id", (string) The transaction hash (differs from txid for witness transactions) - "size" : n, (numeric) The serialized transaction size - "vsize" : n, (numeric) The virtual transaction size (differs from size for witness transactions) - "version" : n, (numeric) The version - "locktime" : ttt, (numeric) The lock time - "vin" : [ (array of json objects) + "in_active_chain": b, (bool) Whether specified block is in the active chain or not (only present with explicit "blockhash" argument) + "hex" : "data", (string) The serialized, hex-encoded data for 'txid' + "txid" : "id", (string) The transaction id (same as provided) + "hash" : "id", (string) The transaction hash (differs from txid for witness transactions) + "size" : n, (numeric) The serialized transaction size + "vsize" : n, (numeric) The virtual transaction size (differs from size for witness transactions) + "version" : n, (numeric) The version + "locktime" : ttt, (numeric) The lock time + "vin" : [ (array of json objects) { - "txid": "id", (string) The transaction id - "vout": n, (numeric) - "scriptSig": { (json object) The script - "asm": "asm", (string) asm - "hex": "hex" (string) hex + "txid": "id", (string) The transaction id + "vout": n, (numeric) + "scriptSig": { (json object) The script + "asm": "asm", (string) asm + "hex": "hex" (string) hex }, - "sequence": n (numeric) The script sequence number - "txinwitness": ["hex", ...] (array of string) hex-encoded witness data (if any) + "sequence": n (numeric) The script sequence number + "txinwitness": ["hex", ...] (array of string) hex-encoded witness data (if any) } ,... ], - "vout" : [ (array of json objects) + "vout" : [ (array of json objects) { - "value" : x.xxx, (numeric) The value in BTC - "n" : n, (numeric) index - "scriptPubKey" : { (json object) - "asm" : "asm", (string) the asm - "hex" : "hex", (string) the hex - "reqSigs" : n, (numeric) The required sigs - "type" : "pubkeyhash", (string) The type, eg 'pubkeyhash' - "addresses" : [ (json array of string) - "address" (string) bitcoin address + "value" : x.xxx, (numeric) The value in BTC + "n" : n, (numeric) index + "scriptPubKey" : { (json object) + "asm" : "asm", (string) the asm + "hex" : "hex", (string) the hex + "reqSigs" : n, (numeric) The required sigs + "type" : "pubkeyhash", (string) The type, eg 'pubkeyhash' + "addresses" : [ (json array of string) + "address" (string) bitcoin address ,... ] } } ,... ], - "blockhash" : "hash", (string) the block hash - "confirmations" : n, (numeric) The confirmations - "time" : ttt, (numeric) The transaction time in seconds since epoch (Jan 1 1970 GMT) - "blocktime" : ttt (numeric) The block time in seconds since epoch (Jan 1 1970 GMT) + "blockhash" : "hash", (string) the block hash + "confirmations" : n, (numeric) The confirmations + "time" : ttt, (numeric) The transaction time in seconds since epoch (Jan 1 1970 GMT) + "blocktime" : ttt (numeric) The block time in seconds since epoch (Jan 1 1970 GMT) } Examples: -> bitcoin-cli getrawtransaction "mytxid" -> bitcoin-cli getrawtransaction "mytxid" true -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getrawtransaction", "params": ["mytxid", true] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ -> bitcoin-cli getrawtransaction "mytxid" false "myblockhash" -> bitcoin-cli getrawtransaction "mytxid" true "myblockhash" +> bitcoin-cli getrawtransaction "mytxid" +> bitcoin-cli getrawtransaction "mytxid" true +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getrawtransaction", "params": ["mytxid", true] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli getrawtransaction "mytxid" false "myblockhash" +> bitcoin-cli getrawtransaction "mytxid" true "myblockhash"
-getreceivedbyaccount "account" ( minconf ) +getreceivedbyaccount "account" ( minconf ) -DEPRECATED. Returns the total amount received by addresses within transactions with at least [minconf] confirmations. +DEPRECATED. Returns the total amount received by addresses with <account> in transactions with at least [minconf] confirmations. Arguments: -1. "account" (string, required) The selected account, may be the default account using "". +1. "account" (string, required) The selected account, may be the default account using "". 2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times. Result: @@ -49,16 +49,16 @@ amount (numeric) The total amount in BTC received for this account. Examples: Amount received by the default account with at least 1 confirmation -> bitcoin-cli getreceivedbyaccount "" +> bitcoin-cli getreceivedbyaccount "" Amount received at the tabby account including unconfirmed amounts with zero confirmations -> bitcoin-cli getreceivedbyaccount "tabby" 0 +> bitcoin-cli getreceivedbyaccount "tabby" 0 The amount with at least 6 confirmations -> bitcoin-cli getreceivedbyaccount "tabby" 6 +> bitcoin-cli getreceivedbyaccount "tabby" 6 As a json rpc call -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getreceivedbyaccount", "params": ["tabby", 6] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getreceivedbyaccount", "params": ["tabby", 6] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-getreceivedbyaddress "address" ( minconf ) +getreceivedbyaddress "address" ( minconf ) Returns the total amount received by the given address in transactions with at least minconf confirmations. Arguments: -1. "address" (string, required) The bitcoin address for transactions. +1. "address" (string, required) The bitcoin address for transactions. 2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times. Result: @@ -49,16 +49,16 @@ amount (numeric) The total amount in BTC received at this address. Examples: The amount from transactions with at least 1 confirmation -> bitcoin-cli getreceivedbyaddress "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" +> bitcoin-cli getreceivedbyaddress "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" The amount including unconfirmed transactions, zero confirmations -> bitcoin-cli getreceivedbyaddress "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" 0 +> bitcoin-cli getreceivedbyaddress "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" 0 The amount with at least 6 confirmations -> bitcoin-cli getreceivedbyaddress "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" 6 +> bitcoin-cli getreceivedbyaddress "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" 6 As a json rpc call -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getreceivedbyaddress", "params": ["1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX", 6] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getreceivedbyaddress", "params": ["1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX", 6] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-gettransaction "txid" ( include_watchonly ) +gettransaction "txid" ( include_watchonly ) -Get detailed information about in-wallet transaction+Get detailed information about in-wallet transaction <txid> Arguments: -1. "txid" (string, required) The transaction id -2. "include_watchonly" (bool, optional, default=false) Whether to include watch-only addresses in balance calculation and details[] +1. "txid" (string, required) The transaction id +2. "include_watchonly" (bool, optional, default=false) Whether to include watch-only addresses in balance calculation and details[] Result: { - "amount" : x.xxx, (numeric) The transaction amount in BTC - "fee": x.xxx, (numeric) The amount of the fee in BTC. This is negative and only available for the - 'send' category of transactions. - "confirmations" : n, (numeric) The number of confirmations - "blockhash" : "hash", (string) The block hash - "blockindex" : xx, (numeric) The index of the transaction in the block that includes it - "blocktime" : ttt, (numeric) The time in seconds since epoch (1 Jan 1970 GMT) - "txid" : "transactionid", (string) The transaction id. - "time" : ttt, (numeric) The transaction time in seconds since epoch (1 Jan 1970 GMT) - "timereceived" : ttt, (numeric) The time received in seconds since epoch (1 Jan 1970 GMT) - "bip125-replaceable": "yes|no|unknown", (string) Whether this transaction could be replaced due to BIP125 (replace-by-fee); + "amount" : x.xxx, (numeric) The transaction amount in BTC + "fee": x.xxx, (numeric) The amount of the fee in BTC. This is negative and only available for the + 'send' category of transactions. + "confirmations" : n, (numeric) The number of confirmations + "blockhash" : "hash", (string) The block hash + "blockindex" : xx, (numeric) The index of the transaction in the block that includes it + "blocktime" : ttt, (numeric) The time in seconds since epoch (1 Jan 1970 GMT) + "txid" : "transactionid", (string) The transaction id. + "time" : ttt, (numeric) The transaction time in seconds since epoch (1 Jan 1970 GMT) + "timereceived" : ttt, (numeric) The time received in seconds since epoch (1 Jan 1970 GMT) + "bip125-replaceable": "yes|no|unknown", (string) Whether this transaction could be replaced due to BIP125 (replace-by-fee); may be unknown for unconfirmed transactions not in the mempool - "details" : [ + "details" : [ { - "account" : "accountname", (string) DEPRECATED. The account name involved in the transaction, can be "" for the default account. - "address" : "address", (string) The bitcoin address involved in the transaction - "category" : "send|receive", (string) The category, either 'send' or 'receive' - "amount" : x.xxx, (numeric) The amount in BTC - "label" : "label", (string) A comment for the address/transaction, if any - "vout" : n, (numeric) the vout value - "fee": x.xxx, (numeric) The amount of the fee in BTC. This is negative and only available for the - 'send' category of transactions. - "abandoned": xxx (bool) 'true' if the transaction has been abandoned (inputs are respendable). Only available for the - 'send' category of transactions. + "account" : "accountname", (string) DEPRECATED. The account name involved in the transaction, can be "" for the default account. + "address" : "address", (string) The bitcoin address involved in the transaction + "category" : "send|receive", (string) The category, either 'send' or 'receive' + "amount" : x.xxx, (numeric) The amount in BTC + "label" : "label", (string) A comment for the address/transaction, if any + "vout" : n, (numeric) the vout value + "fee": x.xxx, (numeric) The amount of the fee in BTC. This is negative and only available for the + 'send' category of transactions. + "abandoned": xxx (bool) 'true' if the transaction has been abandoned (inputs are respendable). Only available for the + 'send' category of transactions. } ,... ], - "hex" : "data" (string) Raw data for transaction + "hex" : "data" (string) Raw data for transaction } Examples: -> bitcoin-cli gettransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" -> bitcoin-cli gettransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" true -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "gettransaction", "params": ["1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> bitcoin-cli gettransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" +> bitcoin-cli gettransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" true +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "gettransaction", "params": ["1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-gettxout "txid" n ( include_mempool ) +gettxout "txid" n ( include_mempool ) Returns details about an unspent transaction output. Arguments: -1. "txid" (string, required) The transaction id -2. "n" (numeric, required) vout number -3. "include_mempool" (boolean, optional) Whether to include the mempool. Default: true. Note that an unspent output that is spent in the mempool won't appear. +1. "txid" (string, required) The transaction id +2. "n" (numeric, required) vout number +3. "include_mempool" (boolean, optional) Whether to include the mempool. Default: true. Note that an unspent output that is spent in the mempool won't appear. Result: { - "bestblock" : "hash", (string) the block hash - "confirmations" : n, (numeric) The number of confirmations - "value" : x.xxx, (numeric) The transaction value in BTC - "scriptPubKey" : { (json object) - "asm" : "code", (string) - "hex" : "hex", (string) - "reqSigs" : n, (numeric) Number of required signatures - "type" : "pubkeyhash", (string) The type, eg pubkeyhash - "addresses" : [ (array of string) array of bitcoin addresses - "address" (string) bitcoin address + "bestblock" : "hash", (string) the block hash + "confirmations" : n, (numeric) The number of confirmations + "value" : x.xxx, (numeric) The transaction value in BTC + "scriptPubKey" : { (json object) + "asm" : "code", (string) + "hex" : "hex", (string) + "reqSigs" : n, (numeric) Number of required signatures + "type" : "pubkeyhash", (string) The type, eg pubkeyhash + "addresses" : [ (array of string) array of bitcoin addresses + "address" (string) bitcoin address ,... ] }, - "coinbase" : true|false (boolean) Coinbase or not + "coinbase" : true|false (boolean) Coinbase or not } Examples: Get unspent transactions -> bitcoin-cli listunspent +> bitcoin-cli listunspent View the details -> bitcoin-cli gettxout "txid" 1 +> bitcoin-cli gettxout "txid" 1 As a json rpc call -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "gettxout", "params": ["txid", 1] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "gettxout", "params": ["txid", 1] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-gettxoutproof ["txid",...] ( blockhash ) +gettxoutproof ["txid",...] ( blockhash ) -Returns a hex-encoded proof that "txid" was included in a block. +Returns a hex-encoded proof that "txid" was included in a block. NOTE: By default this function only works sometimes. This is when there is an unspent output in the utxo for this transaction. To make it always work, @@ -45,15 +45,15 @@ you need to maintain a transaction index, using the -txindex command line option specify the block in which the transaction is included manually (by blockhash). Arguments: -1. "txids" (string) A json array of txids to filter +1. "txids" (string) A json array of txids to filter [ - "txid" (string) A transaction hash + "txid" (string) A transaction hash ,... ] -2. "blockhash" (string, optional) If specified, looks for txid in the block with this hash +2. "blockhash" (string, optional) If specified, looks for txid in the block with this hash Result: -"data" (string) A string that is a serialized, hex-encoded data for the proof. +"data" (string) A string that is a serialized, hex-encoded data for the proof.
getunconfirmedbalance -Returns the server's total unconfirmed balance +Returns the server's total unconfirmed balance
-help ( "command" ) +help ( "command" ) List all commands, or get help for a specified command. Arguments: -1. "command" (string, optional) The command to get help on +1. "command" (string, optional) The command to get help on Result: -"text" (string) The help text +"text" (string) The help text
-importaddress "address" ( "label" rescan p2sh ) +importaddress "address" ( "label" rescan p2sh ) Adds a script (in hex) or address that can be watched as if it were in your wallet but cannot be used to spend. Requires a new wallet backup. Arguments: -1. "script" (string, required) The hex-encoded script (or address) -2. "label" (string, optional, default="") An optional label +1. "script" (string, required) The hex-encoded script (or address) +2. "label" (string, optional, default="") An optional label 3. rescan (boolean, optional, default=true) Rescan the wallet for transactions 4. p2sh (boolean, optional, default=false) Add the P2SH version of the script as well @@ -55,13 +55,13 @@ as change, and not show up in many RPCs. Examples: Import a script with rescan -> bitcoin-cli importaddress "myscript" +> bitcoin-cli importaddress "myscript" Import using a label without rescan -> bitcoin-cli importaddress "myscript" "testing" false +> bitcoin-cli importaddress "myscript" "testing" false As a JSON-RPC call -> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "importaddress", "params": ["myscript", "testing", false] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "importaddress", "params": ["myscript", "testing", false] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
-importmulti "requests" ( "options" ) +importmulti "requests" ( "options" ) Import addresses/scripts (with private or public keys, redeem script (P2SH)), rescanning all addresses in one-shot-only (rescan can be disabled via options). Requires a new wallet backup. @@ -43,36 +43,36 @@ Arguments: 1. requests (array, required) Data to be imported [ (array of json objects) { - "scriptPubKey": "