Original Bitcoin client/API calls list: Difference between revisions
Jump to navigation
Jump to search
Line 90: | Line 90: | ||
==See Also== | ==See Also== | ||
* [[Bitcoin client]] | * [[Original Bitcoin client]] | ||
* [[API reference (JSON-RPC)]] | * [[API reference (JSON-RPC)]] | ||
* [[Lazy_API]] | * [[Lazy_API]] | ||
Line 96: | Line 96: | ||
[[Category:Technical]] | [[Category:Technical]] | ||
[[Category:Developer]] | [[Category:Developer]] | ||
Revision as of 04:43, 30 April 2011
Bitcoin API call list (as of version 0.3.20.2)
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
Required arguments are denoted inside < and > Optional arguments are inside [ and ].
Command | Parameters | Description |
---|---|---|
backupwallet | <destination> | Safely copies wallet.dat to destination, which can be a directory or a path with filename. |
getaccount | <bitcoinaddress> | Returns the account associated with the given address. |
getaccountaddress | <account> | Returns the current bitcoin address for receiving payments to this account. |
getaddressesbyaccount | <account> | Returns the list of addresses for the given account. |
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. |
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. | |
getblocknumber | Returns the block number of the latest block in the longest block chain. | |
getconnectioncount | Returns the number of connections to other nodes. | |
getdifficulty | Returns the proof-of-work difficulty as a multiple of the minimum difficulty. | |
getgenerate | Returns true or false whether bitcoind is currently generating hashes | |
gethashespersec | Returns a recent hashes per second performance measurement while generating. | |
getinfo | Returns an object containing various state info. | |
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]. |
getreceivedbyaccount | <account> [minconf=1] | Returns the total amount received by addresses with <account> in transactions with at least [minconf] confirmations. |
getreceivedbyaddress | <bitcoinaddress> [minconf=1] | Returns the total amount received by <bitcoinaddress> in transactions with at least [minconf] confirmations. |
gettransaction | <txid> | Get detailed information about <txid> |
getwork | [data] | If [data] is not specified, returns formatted hash data to work on:
If [data] is specified, tries to solve the block and returns true if it was successful. |
help | [command] | List commands, or get help for a command. |
listaccounts | [minconf=1] | Returns Object that has account names as keys, account balances as values. |
listreceivedbyaccount | [minconf=1] [includeempty=false] | Returns an array of objects containing:
|
listreceivedbyaddress | [minconf=1] [includeempty=false] | Returns an array of objects containing:
To get a list of accounts on the system, execute bitcoind listreceivedbyaddress 0 true |
listtransactions | <account> [count=10] | Returns up to [count] most recent transactions for account <account>. |
move | <fromaccount> <toaccount> <amount> [minconf=1] [comment] | Move from one account in your wallet to another. |
sendfrom | <fromaccount> <tobitcoinaddress> <amount> [minconf=1] [comment] [comment-to] | <amount> is a real and is rounded to the nearest 0.01 |
sendtoaddress | <bitcoinaddress> <amount> [comment] [comment-to] | <amount> is a real and is rounded to the nearest 0.01 |
setaccount | <bitcoinaddress> <account> | Sets the account associated with the given address. |
setgenerate | <generate> [genproclimit] | <generate> is true or false to turn generation on or off. Generation is limited to [genproclimit] processors, -1 is unlimited. |
stop | Stop bitcoin server. | |
validateaddress | <bitcoinaddress> | Return information about <bitcoinaddress>. |