Original Bitcoin client/API calls list

提供: tezos-wiki
移動先: 案内検索

Bitcoin API呼び出しリスト(バージョン0.8.0以降)

注:最新のAPIリファレンスはここにあります


一般的な操作[編集]

私のビットコインアドレスをリストする[編集]

あなたのウォレットのbitcoin アドレスをリストすることは、 listreceivedbyaddress で簡単に行えます。通常、トランザクションを受け取ったアドレスだけをリストしますが、最初の引数を0に設定し、2番目の引数をtrueに設定すると、すべてのアドレスをリストすることができます。

アカウントは、アドレスを整理するために使用されます。

完全リスト[編集]

必要な引数は < and > オプションの引数は[and]の中にあります。

コマンド パラメーター 説明 ロックされていないウォレットが必要ですか?(v0.4.0+)
addmultisigaddress <nrequired> <'["key","key"]'> [account] ウォレットに必須ではない署名のマルチアドレス・アドレスを追加します。各キーはビットコインアドレスまたは16進エンコードの公開鍵です。 [account]が指定されている場合は、[account]にアドレスを割り当てます。アドレスを含む文字列を返します。 N
addnode <node> <add/remove/onetry> version 0.8addnodeリストに<node>を追加または削除しようとするか、<node>への接続を1回試行してください。 N
backupwallet <destination> 安全にwallet.datをコピー先のディレクトリにコピーします。これは、ディレクトリまたはファイル名のあるパスにすることができます。 N
createmultisig <nrequired> <'["key,"key"]'> マルチサインアドレスを作成し、jsonオブジェクトを返す
createrawtransaction [{"txid":txid,"vout":n},...] {address:amount,...} version 0.7 与えられた生のトランザクション支出を作成します。 N
decoderawtransaction <hex string> version 0.7 生のトランザクション用に人間が読めるJSONオブジェクトを生成します。 N
dumpprivkey <bitcoinaddress> Yに対応する秘密鍵を表示します。 <bitcoinaddress> Y
dumpwallet <filename> version 0.13.0すべてのウォレットの秘密鍵をファイルYにエクスポートします Y
encryptwallet <passphrase> を使用してウォレットを暗号化します。 <passphrase>. N
getaccount <bitcoinaddress> 指定されたアドレスに関連付けられたアカウントを返します。 N
getaccountaddress <account> このアカウントへの支払いを受け取るための現在のビットコインアドレスを返します。 <account>が存在しない場合、返される関連する新しいアドレスとともに作成されます。 N
getaddednodeinfo <dns> [node] version 0.8 与えられた追加されたノード、または追加されたすべてのノードに関する情報を返します

(onetry addnodesはここには記載されていません)dnsがfalseの場合、追加されたノードのリストのみが提供されます。そうでない場合は、接続された情報も利用可能になります。

getaddressesbyaccount <account> 指定されたアカウントのアドレスのリストを返します。 N
getbalance [account] [minconf=1] [account]が指定されていない場合、サーバーの使用可能な合計残高が返されます。[account]を指定すると、アカウントの残高が返されます。 N
getbestblockhash version 0.9 最も長いブロックチェーン内の最良(ヒント)ブロックのハッシュを返します。 N
getblock <hash> 指定されたハッシュを持つブロックに関する情報を返します。 N
getblockcount 最も長いブロックチェーンのブロック数を返します。 N
getblockhash <index> 最善のブロックチェーンのブロックのハッシュを<index>に返します。インデックス0は起源ブロック N
getblocknumber 推奨されていません。バージョン0.7で削除されました。 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

エラーコード[編集]

エラーコードとその意味のリストについては、rpcprotocol.hを参照してください。

関連項目[編集]

参考文献[編集]

  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