Difference between revisions of "Original Bitcoin client/API calls list"

From Bitcoin Wiki
Jump to: navigation, search
(add missing getblock)
(Full list)
 
(48 intermediate revisions by 25 users not shown)
Line 1: Line 1:
Bitcoin API call list (as of version 0.6.0)
+
Bitcoin API call list (as of version 0.8.0)
 +
 
 +
Note: up-to-date API reference can be [https://bitcoin.org/en/developer-reference#bitcoin-core-apis found here].
  
 
== Common operations ==
 
== Common operations ==
Line 16: Line 18:
 
! Command !! Parameters !! Description !! Requires unlocked wallet? (v0.4.0+)
 
! Command !! Parameters !! Description !! Requires unlocked wallet? (v0.4.0+)
 
|-
 
|-
| addmultisigaddress || <nrequired> <'["key","key"]'> [account] || '''Currently only available on testnet''' Add a nrequired-to-sign multisignature address to the wallet. Each key is a bitcoin address or hex-encoded public key. If [account] is specified, assign address to [account]. || N
+
| <code>addmultisigaddress</code> || <nrequired> <'["key","key"]'> [account] || Add a nrequired-to-sign multisignature address to the wallet. Each key is a bitcoin address or hex-encoded public key. If [account] is specified, assign address to [account]. Returns a string containing the address. || N
 +
|-
 +
| <code>addnode</code> || <node> <add/remove/onetry> || '''version 0.8''' Attempts add or remove <node> from the addnode list or try a connection to <node> once. || N
 +
|-
 +
| <code>backupwallet</code> || <destination> || Safely copies wallet.dat to destination, which can be a directory or a path with filename. || N
 +
|-
 +
| <code>createmultisig</code> || <nrequired> <'["key,"key"]'> || Creates a multi-signature address and returns a json object ||
 +
|-
 +
| <code>createrawtransaction</code> || [{"txid":txid,"vout":n},...] {address:amount,...} || '''version 0.7'''  Creates a [[Raw Transactions|raw transaction]] spending given inputs. || N
 +
|-
 +
| <code>decoderawtransaction</code> || <hex string> || '''version 0.7'''  Produces a human-readable JSON object for a [[Raw Transactions|raw transaction]]. || N
 +
|-
 +
| <code>dumpprivkey</code> || <bitcoinaddress> || Reveals the private key corresponding to <bitcoinaddress> || Y
 +
|-
 +
| <code>dumpwallet</code> || <filename> || '''version 0.13.0''' Exports all wallet private keys to file || Y
 +
|-
 +
| <code>encryptwallet</code> || <passphrase> || Encrypts the wallet with <passphrase>. || N
 
|-
 
|-
| backupwallet || <destination> || Safely copies wallet.dat to destination, which can be a directory or a path with filename. || N
+
| <code>getaccount</code> || <bitcoinaddress> || Returns the account associated with the given address. || N
 
|-
 
|-
| dumpprivkey || <bitcoinaddress> || Reveals the private key corresponding to <bitcoinaddress> || Y
+
| <code>getaccountaddress</code> || <account> || Returns the current bitcoin address for receiving payments to this account. If <account> does not exist, it will be created along with an associated new address that will be returned. || N
 
|-
 
|-
| encryptwallet || <passphrase> || Encrypts the wallet with <passphrase>. || N
+
| <code>getaddednodeinfo</code> || <dns> [node] || '''version 0.8''' Returns information about the given added node, or all added nodes
 +
(note that onetry addnodes are not listed here)
 +
If dns is false, only a list of added nodes will be provided,
 +
otherwise connected information will also be available.
 
|-
 
|-
| getaccount || <bitcoinaddress> || Returns the account associated with the given address. || N
+
| <code>getaddressesbyaccount</code> || <account> || Returns the list of addresses for the given account. || N
 
|-
 
|-
| getaccountaddress || <account> || Returns the current bitcoin address for receiving payments to this account. || N
+
| <code>getbalance</code> || [account] [minconf=1] || If [account] is not specified, returns the server's total available balance.<br/>If [account] is specified, returns the balance in the account. || N
 
|-
 
|-
| getaddressesbyaccount || <account> || Returns the list of addresses for the given account. || N
+
| <code>getbestblockhash</code> || || '''version 0.9''' Returns the hash of the best (tip) block in the longest block chain. || N
 
|-
 
|-
| getbalance || [account] [minconf=1] || If [account] is not specified, returns the server's total available balance.<br/>If [account] is specified, returns the balance in the account. || N
+
| <code>getblock</code> || <hash> || Returns information about the block with the given hash. || N
 
|-
 
|-
| getblock || <hash> || Returns information about the given block hash. || N
+
| <code>getblockcount</code> || || Returns the number of blocks in the longest block chain. || N
 
|-
 
|-
| getblockcount || || Returns the number of blocks in the longest block chain. || N
+
| <code>getblockhash</code> || <index> || Returns hash of block in best-block-chain at <index>; index 0 is the [[genesis block]] || N
 
|-
 
|-
| getblockhash || <index> || Returns hash of block in best-block-chain at <index> || N
+
| <code>getblocknumber</code> || || '''Deprecated'''. '''Removed in version 0.7'''. Use getblockcount. || N
 
|-
 
|-
| getblocknumber || || '''Deprecated'''. Use getblockcount. || N
+
| <code>getblocktemplate</code> || [params] || Returns data needed to construct a block to work on. See [[ BIP_0022]] for more info on params.|| N
 
|-
 
|-
| getconnectioncount || || Returns the number of connections to other nodes. || N
+
| <code>getconnectioncount</code> || || Returns the number of connections to other nodes. || N
 
|-
 
|-
| getdifficulty || || Returns the proof-of-work difficulty as a multiple of the minimum difficulty. || N
+
| <code>getdifficulty</code> || || Returns the proof-of-work difficulty as a multiple of the minimum difficulty. || N
 
|-
 
|-
| getgenerate || || Returns true or false whether bitcoind is currently generating hashes || N
+
| <code>getgenerate</code> || || Returns true or false whether bitcoind is currently generating hashes || N
 
|-
 
|-
| gethashespersec || || Returns a recent hashes per second performance measurement while generating. || N
+
| <code>gethashespersec</code> || || Returns a recent hashes per second performance measurement while generating. || N
 
|-
 
|-
| getinfo || || Returns an object containing various state info. || N
+
| <code>getinfo</code> || || Returns an object containing various state info. || N
 
|-
 
|-
| getmemorypool || [data] || If [data] is not specified, returns data needed to construct a block to work on:
+
| <code>getmemorypool</code> || [data] || '''Replaced in v0.7.0 with getblocktemplate, submitblock, getrawmempool''' || N
* "version" : block version
 
* "previousblockhash" : hash of current highest block
 
* "transactions" : contents of non-coinbase transactions that should be included in the next block
 
* "coinbasevalue" : maximum allowable input to coinbase transaction, including the generation award and transaction fees
 
* "time" : timestamp appropriate for next block
 
* "bits" : compressed target of next block
 
If [data] is specified, tries to solve the block and returns true if it was successful.
 
|| N
 
 
|-
 
|-
| getmininginfo || || Returns an object containing mining-related information:
+
| <code>getmininginfo</code> || || Returns an object containing mining-related information:
 
* blocks
 
* blocks
 
* currentblocksize
 
* currentblocksize
Line 73: Line 86:
 
|| N
 
|| N
 
|-
 
|-
| getnewaddress || [account] || Returns a new bitcoin address for receiving payments.  If [account] is specified (recommended), it is added to the address book so payments received with the address will be credited to [account]. || N
+
| <code>getnewaddress</code> || [account] || Returns a new bitcoin address for receiving payments.  If [account] is specified payments received with the address will be credited to [account]. || N
 +
|-
 +
| <code>getpeerinfo</code> || || '''version 0.7''' Returns data about each connected node. || N
 +
|-
 +
| <code>getrawchangeaddress</code> || [account]|| '''version 0.9''' Returns a new Bitcoin address, for receiving change.  This is for use with raw transactions, NOT normal use. || N
 +
|-
 +
| <code>getrawmempool</code> || || '''version 0.7''' Returns all transaction ids in memory pool || N
 +
|-
 +
| <code>getrawtransaction</code> || <txid> [verbose=0] || '''version 0.7'''  Returns [[Raw Transactions|raw transaction]] representation for given transaction id. || N
 
|-
 
|-
| getreceivedbyaccount || [account] [minconf=1] || Returns the total amount received by addresses with [account] in transactions with at least [minconf] confirmations. If [account] not provided return will include all transactions to all accounts. (version 0.3.24-beta) || N
+
| <code>getreceivedbyaccount</code> || [account] [minconf=1] || Returns the total amount received by addresses with [account] in transactions with at least [minconf] confirmations. If [account] not provided return will include all transactions to all accounts. (version 0.3.24) || N
 
|-
 
|-
| getreceivedbyaddress || <bitcoinaddress> [minconf=1] || Returns the total amount received by <bitcoinaddress> in transactions with at least [minconf] confirmations. While some might consider this obvious, value reported by this only considers *receiving* transactions. It does not check payments that have been made *from* this address. In other words, this is not "getaddressbalance". Works only for addresses in the local wallet, external addresses will always show 0. || N
+
| <code>getreceivedbyaddress</code> || <bitcoinaddress> [minconf=1] || Returns the amount received by <bitcoinaddress> in transactions with at least [minconf] confirmations. It correctly handles the case where someone has sent to the address in multiple transactions. Keep in mind that addresses are only ever used for receiving transactions. Works only for addresses in the local wallet, external addresses will always show 0. || N
 
|-
 
|-
| gettransaction || <txid> || Returns an object about the given transaction containing:
+
| <code>gettransaction</code> || <txid> || Returns an object about the given transaction containing:
 
* "amount" : total amount of the transaction
 
* "amount" : total amount of the transaction
 
* "confirmations" :  number of confirmations of the transaction
 
* "confirmations" :  number of confirmations of the transaction
 
* "txid" : the transaction ID
 
* "txid" : the transaction ID
* "time" : time the transaction occurred
+
* "time" : time associated with the transaction<ref>From block timestamp, unless transaction was already in memory pool then the local time when the client added the transaction to its memory pool</ref>.
 
* "details" - An array of objects containing:
 
* "details" - An array of objects containing:
 
** "account"
 
** "account"
Line 89: Line 110:
 
** "category"
 
** "category"
 
** "amount"
 
** "amount"
 +
** "fee"
 
|| N
 
|| N
 
|-
 
|-
| [[getwork]] || [data] || If [data] is not specified, returns formatted hash data to work on:
+
| <code>gettxout</code> || <txid> <n> [includemempool=true] || Returns details about an unspent transaction output (UTXO) || N
 +
|-
 +
| <code>gettxoutsetinfo</code> ||  || Returns statistics about the unspent transaction output (UTXO) set || N
 +
|-
 +
| <code>[[getwork]]</code> || [data] || If [data] is not specified, returns formatted hash data to work on:
 
* "midstate" : precomputed hash state after hashing the first half of the data
 
* "midstate" : precomputed hash state after hashing the first half of the data
 
* "data" : block data
 
* "data" : block data
Line 99: Line 125:
 
|| N
 
|| N
 
|-
 
|-
| help || [command] || List commands, or get help for a command. || N
+
| <code>help</code> || [command] || List commands, or get help for a command. || N
 +
|-
 +
| <code>importprivkey</code> || <bitcoinprivkey> [label] [rescan=true]|| Adds a private key (as returned by dumpprivkey) to your wallet. This may take a while, as a [[How_to_import_private_keys#Import_Private_key.28s.29|rescan]] is done, looking for existing transactions. '''Optional [rescan] parameter added in 0.8.0.''' Note: There's no need to import public key, as in [[Elliptic_Curve_Digital_Signature_Algorithm|ECDSA]] (unlike RSA) this can be computed from private key. || Y
 
|-
 
|-
| importprivkey || <bitcoinprivkey> [label] || Adds a private key (as returned by dumpprivkey) to your wallet. || Y
+
| <code>invalidateblock</code> || <hash> || Permanently marks a block as invalid, as if it violated a consensus rule.|| N
 
|-
 
|-
| keypoolrefill || || Fills the keypool, requires wallet passphrase to be set. || Y
+
| <code>keypoolrefill</code> || || Fills the keypool, requires wallet passphrase to be set. || Y
 
|-
 
|-
| listaccounts || [minconf=1] || Returns Object that has account names as keys, account balances as values. || N
+
| <code>listaccounts</code> || [minconf=1] || Returns Object that has account names as keys, account balances as values. || N
 
|-
 
|-
| listreceivedbyaccount || [minconf=1] [includeempty=false] || Returns an array of objects containing:
+
| <code>listaddressgroupings</code> || || '''version 0.7''' Returns all addresses in the wallet and info used for coincontrol. || N
 +
|-
 +
| <code>listreceivedbyaccount</code> || [minconf=1] [includeempty=false] || Returns an array of objects containing:
 
* "account" : the account of the receiving addresses
 
* "account" : the account of the receiving addresses
 
* "amount" : total amount received by addresses with this account
 
* "amount" : total amount received by addresses with this account
Line 113: Line 143:
 
|| N
 
|| N
 
|-
 
|-
| listreceivedbyaddress || [minconf=1] [includeempty=false] || Returns an array of objects containing:
+
| <code>listreceivedbyaddress</code> || [minconf=1] [includeempty=false] || Returns an array of objects containing:
 
* "address" : receiving address
 
* "address" : receiving address
 
* "account" : the account of the receiving address
 
* "account" : the account of the receiving address
Line 121: Line 151:
 
|| N
 
|| N
 
|-
 
|-
| listsinceblock|| [blockid] [target-confirmations] || Get all transactions in blocks since block [blockid], or all transactions if omitted. || N
+
| <code>listsinceblock</code> || [blockhash] [target-confirmations] || Get all transactions in blocks since block [blockhash], or all transactions if omitted. [target-confirmations] intentionally '''does not''' affect the list of returned transactions, but only affects the returned "lastblock" value.[https://github.com/bitcoin/bitcoin/pull/199#issuecomment-1514952] || N
 
|-
 
|-
| listtransactions || [account] [count=10] [from=0] || Returns up to [count] most recent transactions skipping the first [from] transactions for account [account]. If [account] not provided will return recent transaction from all accounts.
+
| <code>listtransactions</code> || [account] [count=10] [from=0] || Returns up to [count] most recent transactions skipping the first [from] transactions for account [account]. If [account] not provided it'll return recent transactions from all accounts.
 
|| N
 
|| N
 
|-
 
|-
| move || <fromaccount> <toaccount> <amount> [minconf=1] [comment] || Move from one account in your wallet to another || N
+
| <code>listunspent</code> || [minconf=1] [maxconf=999999] || '''version 0.7'''  Returns array of unspent transaction inputs in the wallet. || N
 +
|-
 +
| <code>listlockunspent</code> || || '''version 0.8''' Returns list of temporarily unspendable outputs
 +
|-
 +
| <code>lockunspent</code> || <unlock?> [array-of-objects] || '''version 0.8''' Updates list of temporarily unspendable outputs
 +
|-
 +
| <code>move</code> || <fromaccount> <toaccount> <amount> [minconf=1] [comment] || Move from one account in your wallet to another || N
 +
|-
 +
| <code>sendfrom</code> || <fromaccount> <tobitcoinaddress> <amount> [minconf=1] [comment] [comment-to] || <amount> is a real and is rounded to 8 decimal places. Will send the given amount to the given address, ensuring the account has a valid balance using [minconf] confirmations. Returns the transaction ID if successful (not in JSON object). || Y
 +
|-
 +
| <code>sendmany</code> || <fromaccount> {address:amount,...} [minconf=1] [comment] || amounts are double-precision floating point numbers || Y
 +
|-
 +
| <code>sendrawtransaction</code> || <hexstring> || '''version 0.7''' Submits [[Raw Transactions|raw transaction]] (serialized, hex-encoded) to local node and network. || N
 
|-
 
|-
| sendfrom || <fromaccount> <tobitcoinaddress> <amount> [minconf=1] [comment] [comment-to] || <amount> is a real and is rounded to 8 decimal places. Will send the given amount to the given address, ensuring the account has a valid balance using [minconf] confirmations. Returns the transaction ID if successful (not in JSON object). || Y
+
| <code>sendtoaddress</code> || <bitcoinaddress> <amount> [comment] [comment-to] || <amount> is a real and is rounded to 8 decimal places. Returns the transaction ID <txid> if successful. || Y
 
|-
 
|-
| sendmany || <fromaccount> {address:amount,...} [minconf=1] [comment] || amounts are double-precision floating point numbers || Y
+
| <code>setaccount</code> || <bitcoinaddress> <account> || Sets the account associated with the given address. Assigning address that is already assigned to the same account will create a new address associated with that account. || N
 
|-
 
|-
| sendtoaddress || <bitcoinaddress> <amount> [comment] [comment-to] || <amount> is a real and is rounded to 8 decimal places. Returns the transaction ID <txid> if successful. || Y
+
| <code>setgenerate</code> || <generate> [genproclimit] || <generate> is true or false to turn generation on or off.<br/>Generation is limited to [genproclimit] processors, -1 is unlimited. || N
 
|-
 
|-
| setaccount || <bitcoinaddress> <account> || Sets the account associated with the given address. Assigning address that is already assigned to the same account will create a new address associated with that account. || N
+
| <code>settxfee</code> || <amount> || <amount> is a real and is rounded to the nearest 0.00000001 || N
 
|-
 
|-
| setgenerate || <generate> [genproclimit] || <generate> is true or false to turn generation on or off.<br/>Generation is limited to [genproclimit] processors, -1 is unlimited. || N
+
| <code>signmessage</code> || <bitcoinaddress> <message> || Sign a message with the private key of an address. || Y
 
|-
 
|-
| signmessage || <bitcoinaddress> <message> || Sign a message with the private key of an address. || Y
+
| <code>signrawtransaction</code> || <hexstring> [{"txid":txid,"vout":n,"scriptPubKey":hex},...] [<privatekey1>,...] || '''version 0.7''' Adds signatures to a [[Raw Transactions|raw transaction]] and returns the resulting raw transaction. || Y/N
 
|-
 
|-
| settxfee || <amount> || <amount> is a real and is rounded to the nearest 0.00000001 || N
+
| <code>stop</code> || || Stop bitcoin server. || N
 
|-
 
|-
| stop || || Stop bitcoin server. || N
+
| <code>submitblock</code> || <hex data> [optional-params-obj] || Attempts to submit new block to network. || N
 
|-
 
|-
| validateaddress || <bitcoinaddress> || Return information about <bitcoinaddress>. || N
+
| <code>validateaddress</code> || <bitcoinaddress> || Return information about <bitcoinaddress>. || N
 
|-
 
|-
| verifymessage || <bitcoinaddress> <signature> <message> || Verify a signed message. || N
+
| <code>verifymessage</code> || <bitcoinaddress> <signature> <message> || Verify a signed message. || N
 
|-
 
|-
| 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. || N
+
| <code>walletlock</code> ||  || 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. || N
 
|-
 
|-
| walletpassphrase || <passphrase> <timeout> || Stores the wallet decryption key in memory for <timeout> seconds. || N
+
| <code>walletpassphrase</code> || <passphrase> <timeout> || Stores the wallet decryption key in memory for <timeout> seconds. || N
 
|-
 
|-
| walletpassphrasechange || <oldpassphrase> <newpassphrase> || Changes the wallet passphrase from <oldpassphrase> to <newpassphrase>. || N
+
| <code>walletpassphrasechange</code> || <oldpassphrase> <newpassphrase> || Changes the wallet passphrase from <oldpassphrase> to <newpassphrase>. || N
  
 
|}
 
|}
 +
 +
==Error Codes==
 +
 +
See [https://github.com/bitcoin/bitcoin/blob/62f2d769e45043c1f262ed45babb70fe237ad2bb/src/rpc/protocol.h#L30 rpcprotocol.h] for the list of error codes and their meanings.
  
 
==See Also==
 
==See Also==
  
 
* [[Original Bitcoin client]]
 
* [[Original Bitcoin client]]
 +
* [[Running Bitcoin]]
 
* [[Protocol specification]]
 
* [[Protocol specification]]
 
* [[API reference (JSON-RPC)]]
 
* [[API reference (JSON-RPC)]]
Line 164: Line 211:
 
* [[Elis-API]] - A more detailed version of this page - for developers!
 
* [[Elis-API]] - A more detailed version of this page - for developers!
 
* [http://code.gogulski.com/bitcoin-php/class_bitcoin_client.html PHP BitcoinClient Class Reference]
 
* [http://code.gogulski.com/bitcoin-php/class_bitcoin_client.html PHP BitcoinClient Class Reference]
 +
 +
==References==
 +
<references />
  
 
[[Category:Technical]]
 
[[Category:Technical]]
 
[[Category:Developer]]
 
[[Category:Developer]]
 +
 +
{{Bitcoin Core documentation}}

Latest revision as of 00:27, 23 October 2017

Bitcoin API call list (as of version 0.8.0)

Note: up-to-date API reference can be found here.

Common operations

Listing my bitcoin addresses

Listing the bitcoin addresses in your wallet is easily done via listreceivedbyaddress. It normally lists only addresses which already have received transactions, however you can list all the addresses by setting the first argument to 0, and the second one to true.

Accounts are used to organize addresses.

Full list

Required arguments are denoted inside < and > Optional arguments are inside [ and ].

Command Parameters Description Requires unlocked wallet? (v0.4.0+)
addmultisigaddress <nrequired> <'["key","key"]'> [account] Add a nrequired-to-sign multisignature address to the wallet. Each key is a bitcoin address or hex-encoded public key. If [account] is specified, assign address to [account]. Returns a string containing the address. N
addnode <node> <add/remove/onetry> version 0.8 Attempts add or remove <node> from the addnode list or try a connection to <node> once. N
backupwallet <destination> Safely copies wallet.dat to destination, which can be a directory or a path with filename. N
createmultisig <nrequired> <'["key,"key"]'> Creates a multi-signature address and returns a json object
createrawtransaction [{"txid":txid,"vout":n},...] {address:amount,...} version 0.7 Creates a raw transaction spending given inputs. N
decoderawtransaction <hex string> version 0.7 Produces a human-readable JSON object for a raw transaction. N
dumpprivkey <bitcoinaddress> Reveals the private key corresponding to <bitcoinaddress> Y
dumpwallet <filename> version 0.13.0 Exports all wallet private keys to file Y
encryptwallet <passphrase> Encrypts the wallet with <passphrase>. N
getaccount <bitcoinaddress> Returns the account associated with the given address. N
getaccountaddress <account> Returns the current bitcoin address for receiving payments to this account. If <account> does not exist, it will be created along with an associated new address that will be returned. N
getaddednodeinfo <dns> [node] version 0.8 Returns information about the given added node, or all added nodes

(note that onetry addnodes are not listed here) If dns is false, only a list of added nodes will be provided, otherwise connected information will also be available.

getaddressesbyaccount <account> Returns the list of addresses for the given account. N
getbalance [account] [minconf=1] If [account] is not specified, returns the server's total available balance.
If [account] is specified, returns the balance in the account.
N
getbestblockhash version 0.9 Returns the hash of the best (tip) block in the longest block chain. N
getblock <hash> Returns information about the block with the given hash. N
getblockcount Returns the number of blocks in the longest block chain. N
getblockhash <index> Returns hash of block in best-block-chain at <index>; index 0 is the genesis block N
getblocknumber Deprecated. Removed in version 0.7. Use getblockcount. N
getblocktemplate [params] Returns data needed to construct a block to work on. See BIP_0022 for more info on params. N
getconnectioncount Returns the number of connections to other nodes. N
getdifficulty Returns the proof-of-work difficulty as a multiple of the minimum difficulty. N
getgenerate Returns true or false whether bitcoind is currently generating hashes N
gethashespersec Returns a recent hashes per second performance measurement while generating. N
getinfo Returns an object containing various state info. N
getmemorypool [data] Replaced in v0.7.0 with getblocktemplate, submitblock, getrawmempool N
getmininginfo Returns an object containing mining-related information:
  • blocks
  • currentblocksize
  • currentblocktx
  • difficulty
  • errors
  • generate
  • genproclimit
  • hashespersec
  • pooledtx
  • testnet
N
getnewaddress [account] Returns a new bitcoin address for receiving payments. If [account] is specified payments received with the address will be credited to [account]. N
getpeerinfo version 0.7 Returns data about each connected node. N
getrawchangeaddress [account] version 0.9 Returns a new Bitcoin address, for receiving change. This is for use with raw transactions, NOT normal use. N
getrawmempool version 0.7 Returns all transaction ids in memory pool N
getrawtransaction <txid> [verbose=0] version 0.7 Returns raw transaction representation for given transaction id. N
getreceivedbyaccount [account] [minconf=1] Returns the total amount received by addresses with [account] in transactions with at least [minconf] confirmations. If [account] not provided return will include all transactions to all accounts. (version 0.3.24) N
getreceivedbyaddress <bitcoinaddress> [minconf=1] Returns the amount received by <bitcoinaddress> in transactions with at least [minconf] confirmations. It correctly handles the case where someone has sent to the address in multiple transactions. Keep in mind that addresses are only ever used for receiving transactions. Works only for addresses in the local wallet, external addresses will always show 0. N
gettransaction <txid> Returns an object about the given transaction containing:
  • "amount" : total amount of the transaction
  • "confirmations" : number of confirmations of the transaction
  • "txid" : the transaction ID
  • "time" : time associated with the transaction[1].
  • "details" - An array of objects containing:
    • "account"
    • "address"
    • "category"
    • "amount"
    • "fee"
N
gettxout <txid> <n> [includemempool=true] Returns details about an unspent transaction output (UTXO) N
gettxoutsetinfo Returns statistics about the unspent transaction output (UTXO) set N
getwork [data] If [data] is not specified, returns formatted hash data to work on:
  • "midstate" : precomputed hash state after hashing the first half of the data
  • "data" : block data
  • "hash1" : formatted hash buffer for second hash
  • "target" : little endian hash target

If [data] is specified, tries to solve the block and returns true if it was successful.

N
help [command] List commands, or get help for a command. N
importprivkey <bitcoinprivkey> [label] [rescan=true] Adds a private key (as returned by dumpprivkey) to your wallet. This may take a while, as a rescan is done, looking for existing transactions. Optional [rescan] parameter added in 0.8.0. Note: There's no need to import public key, as in ECDSA (unlike RSA) this can be computed from private key. Y
invalidateblock <hash> Permanently marks a block as invalid, as if it violated a consensus rule. N
keypoolrefill Fills the keypool, requires wallet passphrase to be set. Y
listaccounts [minconf=1] Returns Object that has account names as keys, account balances as values. N
listaddressgroupings version 0.7 Returns all addresses in the wallet and info used for coincontrol. N
listreceivedbyaccount [minconf=1] [includeempty=false] Returns an array of objects containing:
  • "account" : the account of the receiving addresses
  • "amount" : total amount received by addresses with this account
  • "confirmations" : number of confirmations of the most recent transaction included
N
listreceivedbyaddress [minconf=1] [includeempty=false] Returns an array of objects containing:
  • "address" : receiving address
  • "account" : the account of the receiving address
  • "amount" : total amount received by the address
  • "confirmations" : number of confirmations of the most recent transaction included

To get a list of accounts on the system, execute bitcoind listreceivedbyaddress 0 true

N
listsinceblock [blockhash] [target-confirmations] Get all transactions in blocks since block [blockhash], or all transactions if omitted. [target-confirmations] intentionally does not affect the list of returned transactions, but only affects the returned "lastblock" value.[1] N
listtransactions [account] [count=10] [from=0] Returns up to [count] most recent transactions skipping the first [from] transactions for account [account]. If [account] not provided it'll return recent transactions from all accounts. N
listunspent [minconf=1] [maxconf=999999] version 0.7 Returns array of unspent transaction inputs in the wallet. N
listlockunspent version 0.8 Returns list of temporarily unspendable outputs
lockunspent <unlock?> [array-of-objects] version 0.8 Updates list of temporarily unspendable outputs
move <fromaccount> <toaccount> <amount> [minconf=1] [comment] Move from one account in your wallet to another N
sendfrom <fromaccount> <tobitcoinaddress> <amount> [minconf=1] [comment] [comment-to] <amount> is a real and is rounded to 8 decimal places. Will send the given amount to the given address, ensuring the account has a valid balance using [minconf] confirmations. Returns the transaction ID if successful (not in JSON object). Y
sendmany <fromaccount> {address:amount,...} [minconf=1] [comment] amounts are double-precision floating point numbers Y
sendrawtransaction <hexstring> version 0.7 Submits raw transaction (serialized, hex-encoded) to local node and network. N
sendtoaddress <bitcoinaddress> <amount> [comment] [comment-to] <amount> is a real and is rounded to 8 decimal places. Returns the transaction ID <txid> if successful. Y
setaccount <bitcoinaddress> <account> Sets the account associated with the given address. Assigning address that is already assigned to the same account will create a new address associated with that account. N
setgenerate <generate> [genproclimit] <generate> is true or false to turn generation on or off.
Generation is limited to [genproclimit] processors, -1 is unlimited.
N
settxfee <amount> <amount> is a real and is rounded to the nearest 0.00000001 N
signmessage <bitcoinaddress> <message> Sign a message with the private key of an address. Y
signrawtransaction <hexstring> [{"txid":txid,"vout":n,"scriptPubKey":hex},...] [<privatekey1>,...] version 0.7 Adds signatures to a raw transaction and returns the resulting raw transaction. Y/N
stop Stop bitcoin server. N
submitblock <hex data> [optional-params-obj] Attempts to submit new block to network. N
validateaddress <bitcoinaddress> Return information about <bitcoinaddress>. N
verifymessage <bitcoinaddress> <signature> <message> Verify a signed message. N
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. N
walletpassphrase <passphrase> <timeout> Stores the wallet decryption key in memory for <timeout> seconds. N
walletpassphrasechange <oldpassphrase> <newpassphrase> Changes the wallet passphrase from <oldpassphrase> to <newpassphrase>. N

Error Codes

See rpcprotocol.h for the list of error codes and their meanings.

See Also

References

  1. From block timestamp, unless transaction was already in memory pool then the local time when the client added the transaction to its memory pool