Revision as of 08:26, 12 January 2012

Contents

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.

Full list

Safely copies wallet.dat to destination, which can be a directory or a path with filename.

N

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.

N

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

getblockbycount

height

Dumps the block existing at specified height. Note: this is not available in the official release

getblockcount

Returns the number of blocks in the longest block chain.

N

getblocknumber

Returns the block number of the latest block in the longest block chain.

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

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

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

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".

<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

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

stop

Stop bitcoin server.

N

validateaddress

<bitcoinaddress>

Return information about <bitcoinaddress>.

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>.