Original Bitcoin client/API calls list

From Bitcoin Wiki
Revision as of 20:09, 10 April 2012 by Sgornick (talk | contribs) (→‎See Also: Fix link.)
Jump to navigation Jump to search

Bitcoin API call list (as of version 0.6.0)

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] 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
backupwallet <destination> Safely copies wallet.dat to destination, which can be a directory or a path with filename. N
dumpprivkey <bitcoinaddress> Reveals the private key corresponding to <bitcoinaddress> 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. 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
getblockcount Returns the number of blocks in the longest block chain. N
getblockhash <index> Returns hash of block in best-block-chain at <index> N
getblocknumber Deprecated. Use getblockcount. 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] If [data] is not specified, returns data needed to construct a block to work on:
  • "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:
  • 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 (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". 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 the transaction occurred
  • "details" - An array of objects containing:
    • "account"
    • "address"
    • "category"
    • "amount"
 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] Adds a private key (as returned by dumpprivkey) to your wallet. Y
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
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 [blockid] [target-confirmations] Get all transactions in blocks since block [blockid], or all transactions if omitted. 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. N
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
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
signmessage <bitcoinaddress> <message> Sign a message with the private key of an address. Y
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
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

See Also

Retrieved from "https://en.bitcoin.it/w/index.php?title=Original_Bitcoin_client/API_calls_list&oldid=25213"