279 lines
12 KiB
HTML
279 lines
12 KiB
HTML
|
<!doctype html>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta name="viewport" content="width=1200px, shrink-to-fit=yes">
|
||
|
|
<meta name="description" content="Bitcoin Core RPC Docs - validateaddress">
|
||
|
|
<meta name="author" content="">
|
||
|
|
|
||
|
|
<title>validateaddress - Bitcoin Core RPC Docs</title>
|
||
|
|
|
||
|
|
<!-- Bootstrap core CSS -->
|
||
|
|
<link href="./bootstrap.min.css" rel="stylesheet">
|
||
|
|
</head>
|
||
|
|
<style>
|
||
|
|
.card-body {
|
||
|
|
font-size:80%;
|
||
|
|
padding-top: 0.5em;
|
||
|
|
}
|
||
|
|
pre {
|
||
|
|
word-break: break-word;
|
||
|
|
white-space: pre-wrap;
|
||
|
|
}
|
||
|
|
</style>
|
||
|
|
|
||
|
|
<body>
|
||
|
|
|
||
|
|
|
||
|
|
<nav class="navbar navbar-dark bg-dark ">
|
||
|
|
<a class="navbar-brand" href="/">Bitcoin Core RPC docs</a>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<main role="main" class="container-fluid" style="margin-top: 1pc;">
|
||
|
|
|
||
|
|
<div class="row">
|
||
|
|
<div class="col-8">
|
||
|
|
<h1>validateaddress - Bitcoin RPC</h1>
|
||
|
|
<pre>
|
||
|
|
validateaddress "address"
|
||
|
|
|
||
|
|
Return information about the given bitcoin address.
|
||
|
|
|
||
|
|
Arguments:
|
||
|
|
1. "address" (string, required) The bitcoin address to validate
|
||
|
|
|
||
|
|
Result:
|
||
|
|
{
|
||
|
|
"isvalid" : true|false, (boolean) If the address is valid or not. If not, this is the only property returned.
|
||
|
|
"address" : "address", (string) The bitcoin address validated
|
||
|
|
"scriptPubKey" : "hex", (string) The hex encoded scriptPubKey generated by the address
|
||
|
|
"ismine" : true|false, (boolean) If the address is yours or not
|
||
|
|
"iswatchonly" : true|false, (boolean) If the address is watchonly
|
||
|
|
"isscript" : true|false, (boolean, optional) If the address is P2SH or P2WSH. Not included for unknown witness types.
|
||
|
|
"iswitness" : true|false, (boolean) If the address is P2WPKH, P2WSH, or an unknown witness version
|
||
|
|
"witness_version" : version (number, optional) For all witness output types, gives the version number.
|
||
|
|
"witness_program" : "hex" (string, optional) For all witness output types, gives the script or key hash present in the address.
|
||
|
|
"script" : "type" (string, optional) The output script type. Only if "isscript" is true and the redeemscript is known. Possible types: nonstandard, pubkey, pubkeyhash, scripthash, multisig, nulldata, witness_v0_keyhash, witness_v0_scripthash, witness_unknown
|
||
|
|
"hex" : "hex", (string, optional) The redeemscript for the P2SH or P2WSH address
|
||
|
|
"addresses" (string, optional) Array of addresses associated with the known redeemscript (only if "iswitness" is false). This field is superseded by the "pubkeys" field and the address inside "embedded".
|
||
|
|
[
|
||
|
|
"address"
|
||
|
|
,...
|
||
|
|
]
|
||
|
|
"pubkeys" (string, optional) Array of pubkeys associated with the known redeemscript (only if "script" is "multisig")
|
||
|
|
[
|
||
|
|
"pubkey"
|
||
|
|
,...
|
||
|
|
]
|
||
|
|
"sigsrequired" : xxxxx (numeric, optional) Number of signatures required to spend multisig output (only if "script" is "multisig")
|
||
|
|
"pubkey" : "publickeyhex", (string, optional) The hex value of the raw public key, for single-key addresses (possibly embedded in P2SH or P2WSH)
|
||
|
|
"embedded" : {...}, (object, optional) information about the address embedded in P2SH or P2WSH, if relevant and known. It includes all validateaddress output fields for the embedded address, excluding "isvalid", metadata ("timestamp", "hdkeypath", "hdmasterkeyid") and relation to the wallet ("ismine", "iswatchonly", "account").
|
||
|
|
"iscompressed" : true|false, (boolean) If the address is compressed
|
||
|
|
"account" : "account" (string) DEPRECATED. The account associated with the address, "" is the default account
|
||
|
|
"timestamp" : timestamp, (number, optional) The creation time of the key if available in seconds since epoch (Jan 1 1970 GMT)
|
||
|
|
"hdkeypath" : "keypath" (string, optional) The HD keypath if the key is HD and available
|
||
|
|
"hdmasterkeyid" : "<hash160>" (string, optional) The Hash160 of the HD master pubkey
|
||
|
|
}
|
||
|
|
|
||
|
|
Examples:
|
||
|
|
> bitcoin-cli validateaddress "1PSSGeFHDnKNxiEyFrD1wcEaHr9hrQDDWc"
|
||
|
|
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "validateaddress", "params": ["1PSSGeFHDnKNxiEyFrD1wcEaHr9hrQDDWc"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
|
||
|
|
|
||
|
|
</pre>
|
||
|
|
<hr>
|
||
|
|
<p>
|
||
|
|
This is a website, created out of frustration with uncomplete and outdated Bitcoin Core RPC documentation online.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
It was inspired by <a href="http://chainquery.com/bitcoin-api">ChainQuery</a>, which seems to be abandoned. These docs are even simplier, so they can be regenerated by anyone.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
Made by <a href="https://twitter.com/karel_3d">@karel_3d</a>; license of the docs is MIT (see <a href="https://github.com/bitcoin/bitcoin/">bitcoin repo</a>), license of the scripts and webpage is also MIT ((C) 2018 Karel Bilek) (<a href="https://github.com/bitcoin-rpc/bitcoin-rpc.github.io">github repo</a>)
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
Bitcoin version: 0.16.0.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
Note that the RPC is from a regtest node (for completeness), so it includes some additional calls that a regular node doesn't have.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<div class="col-4">
|
||
|
|
|
||
|
|
|
||
|
|
<div class="card">
|
||
|
|
<div class="card-header">
|
||
|
|
Blockchain
|
||
|
|
</div>
|
||
|
|
<div class="card-body">
|
||
|
|
<a href="getbestblockhash.html">getbestblockhash</a><br>
|
||
|
|
<a href="getblock.html">getblock</a><br>
|
||
|
|
<a href="getblockchaininfo.html">getblockchaininfo</a><br>
|
||
|
|
<a href="getblockcount.html">getblockcount</a><br>
|
||
|
|
<a href="getblockhash.html">getblockhash</a><br>
|
||
|
|
<a href="getblockheader.html">getblockheader</a><br>
|
||
|
|
<a href="getchaintips.html">getchaintips</a><br>
|
||
|
|
<a href="getchaintxstats.html">getchaintxstats</a><br>
|
||
|
|
<a href="getdifficulty.html">getdifficulty</a><br>
|
||
|
|
<a href="getmempoolancestors.html">getmempoolancestors</a><br>
|
||
|
|
<a href="getmempooldescendants.html">getmempooldescendants</a><br>
|
||
|
|
<a href="getmempoolentry.html">getmempoolentry</a><br>
|
||
|
|
<a href="getmempoolinfo.html">getmempoolinfo</a><br>
|
||
|
|
<a href="getrawmempool.html">getrawmempool</a><br>
|
||
|
|
<a href="gettxout.html">gettxout</a><br>
|
||
|
|
<a href="gettxoutproof.html">gettxoutproof</a><br>
|
||
|
|
<a href="gettxoutsetinfo.html">gettxoutsetinfo</a><br>
|
||
|
|
<a href="preciousblock.html">preciousblock</a><br>
|
||
|
|
<a href="pruneblockchain.html">pruneblockchain</a><br>
|
||
|
|
<a href="savemempool.html">savemempool</a><br>
|
||
|
|
<a href="verifychain.html">verifychain</a><br>
|
||
|
|
<a href="verifytxoutproof.html">verifytxoutproof</a><br>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<br>
|
||
|
|
<div class="card">
|
||
|
|
<div class="card-header">
|
||
|
|
Control
|
||
|
|
</div>
|
||
|
|
<div class="card-body">
|
||
|
|
<a href="getmemoryinfo.html">getmemoryinfo</a><br>
|
||
|
|
<a href="help.html">help</a><br>
|
||
|
|
<a href="logging.html">logging</a><br>
|
||
|
|
<a href="stop.html">stop</a><br>
|
||
|
|
<a href="uptime.html">uptime</a><br>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<br>
|
||
|
|
<div class="card">
|
||
|
|
<div class="card-header">
|
||
|
|
Generating
|
||
|
|
</div>
|
||
|
|
<div class="card-body">
|
||
|
|
<a href="generate.html">generate</a><br>
|
||
|
|
<a href="generatetoaddress.html">generatetoaddress</a><br>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<br>
|
||
|
|
<div class="card">
|
||
|
|
<div class="card-header">
|
||
|
|
Mining
|
||
|
|
</div>
|
||
|
|
<div class="card-body">
|
||
|
|
<a href="getblocktemplate.html">getblocktemplate</a><br>
|
||
|
|
<a href="getmininginfo.html">getmininginfo</a><br>
|
||
|
|
<a href="getnetworkhashps.html">getnetworkhashps</a><br>
|
||
|
|
<a href="prioritisetransaction.html">prioritisetransaction</a><br>
|
||
|
|
<a href="submitblock.html">submitblock</a><br>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<br>
|
||
|
|
<div class="card">
|
||
|
|
<div class="card-header">
|
||
|
|
Network
|
||
|
|
</div>
|
||
|
|
<div class="card-body">
|
||
|
|
<a href="addnode.html">addnode</a><br>
|
||
|
|
<a href="clearbanned.html">clearbanned</a><br>
|
||
|
|
<a href="disconnectnode.html">disconnectnode</a><br>
|
||
|
|
<a href="getaddednodeinfo.html">getaddednodeinfo</a><br>
|
||
|
|
<a href="getconnectioncount.html">getconnectioncount</a><br>
|
||
|
|
<a href="getnettotals.html">getnettotals</a><br>
|
||
|
|
<a href="getnetworkinfo.html">getnetworkinfo</a><br>
|
||
|
|
<a href="getpeerinfo.html">getpeerinfo</a><br>
|
||
|
|
<a href="listbanned.html">listbanned</a><br>
|
||
|
|
<a href="ping.html">ping</a><br>
|
||
|
|
<a href="setban.html">setban</a><br>
|
||
|
|
<a href="setnetworkactive.html">setnetworkactive</a><br>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<br>
|
||
|
|
<div class="card">
|
||
|
|
<div class="card-header">
|
||
|
|
Rawtransactions
|
||
|
|
</div>
|
||
|
|
<div class="card-body">
|
||
|
|
<a href="combinerawtransaction.html">combinerawtransaction</a><br>
|
||
|
|
<a href="createrawtransaction.html">createrawtransaction</a><br>
|
||
|
|
<a href="decoderawtransaction.html">decoderawtransaction</a><br>
|
||
|
|
<a href="decodescript.html">decodescript</a><br>
|
||
|
|
<a href="fundrawtransaction.html">fundrawtransaction</a><br>
|
||
|
|
<a href="getrawtransaction.html">getrawtransaction</a><br>
|
||
|
|
<a href="sendrawtransaction.html">sendrawtransaction</a><br>
|
||
|
|
<a href="signrawtransaction.html">signrawtransaction</a><br>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<br>
|
||
|
|
<div class="card">
|
||
|
|
<div class="card-header">
|
||
|
|
Util
|
||
|
|
</div>
|
||
|
|
<div class="card-body">
|
||
|
|
<a href="createmultisig.html">createmultisig</a><br>
|
||
|
|
<a href="estimatefee.html">estimatefee</a><br>
|
||
|
|
<a href="estimatesmartfee.html">estimatesmartfee</a><br>
|
||
|
|
<a href="signmessagewithprivkey.html">signmessagewithprivkey</a><br>
|
||
|
|
<a href="validateaddress.html">validateaddress</a><br>
|
||
|
|
<a href="verifymessage.html">verifymessage</a><br>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<br>
|
||
|
|
<div class="card">
|
||
|
|
<div class="card-header">
|
||
|
|
Wallet
|
||
|
|
</div>
|
||
|
|
<div class="card-body">
|
||
|
|
<a href="abandontransaction.html">abandontransaction</a><br>
|
||
|
|
<a href="abortrescan.html">abortrescan</a><br>
|
||
|
|
<a href="addmultisigaddress.html">addmultisigaddress</a><br>
|
||
|
|
<a href="backupwallet.html">backupwallet</a><br>
|
||
|
|
<a href="bumpfee.html">bumpfee</a><br>
|
||
|
|
<a href="dumpprivkey.html">dumpprivkey</a><br>
|
||
|
|
<a href="dumpwallet.html">dumpwallet</a><br>
|
||
|
|
<a href="encryptwallet.html">encryptwallet</a><br>
|
||
|
|
<a href="getaccount.html">getaccount</a><br>
|
||
|
|
<a href="getaccountaddress.html">getaccountaddress</a><br>
|
||
|
|
<a href="getaddressesbyaccount.html">getaddressesbyaccount</a><br>
|
||
|
|
<a href="getbalance.html">getbalance</a><br>
|
||
|
|
<a href="getnewaddress.html">getnewaddress</a><br>
|
||
|
|
<a href="getrawchangeaddress.html">getrawchangeaddress</a><br>
|
||
|
|
<a href="getreceivedbyaccount.html">getreceivedbyaccount</a><br>
|
||
|
|
<a href="getreceivedbyaddress.html">getreceivedbyaddress</a><br>
|
||
|
|
<a href="gettransaction.html">gettransaction</a><br>
|
||
|
|
<a href="getunconfirmedbalance.html">getunconfirmedbalance</a><br>
|
||
|
|
<a href="getwalletinfo.html">getwalletinfo</a><br>
|
||
|
|
<a href="importaddress.html">importaddress</a><br>
|
||
|
|
<a href="importmulti.html">importmulti</a><br>
|
||
|
|
<a href="importprivkey.html">importprivkey</a><br>
|
||
|
|
<a href="importprunedfunds.html">importprunedfunds</a><br>
|
||
|
|
<a href="importpubkey.html">importpubkey</a><br>
|
||
|
|
<a href="importwallet.html">importwallet</a><br>
|
||
|
|
<a href="keypoolrefill.html">keypoolrefill</a><br>
|
||
|
|
<a href="listaccounts.html">listaccounts</a><br>
|
||
|
|
<a href="listaddressgroupings.html">listaddressgroupings</a><br>
|
||
|
|
<a href="listlockunspent.html">listlockunspent</a><br>
|
||
|
|
<a href="listreceivedbyaccount.html">listreceivedbyaccount</a><br>
|
||
|
|
<a href="listreceivedbyaddress.html">listreceivedbyaddress</a><br>
|
||
|
|
<a href="listsinceblock.html">listsinceblock</a><br>
|
||
|
|
<a href="listtransactions.html">listtransactions</a><br>
|
||
|
|
<a href="listunspent.html">listunspent</a><br>
|
||
|
|
<a href="listwallets.html">listwallets</a><br>
|
||
|
|
<a href="lockunspent.html">lockunspent</a><br>
|
||
|
|
<a href="move.html">move</a><br>
|
||
|
|
<a href="removeprunedfunds.html">removeprunedfunds</a><br>
|
||
|
|
<a href="rescanblockchain.html">rescanblockchain</a><br>
|
||
|
|
<a href="sendfrom.html">sendfrom</a><br>
|
||
|
|
<a href="sendmany.html">sendmany</a><br>
|
||
|
|
<a href="sendtoaddress.html">sendtoaddress</a><br>
|
||
|
|
<a href="setaccount.html">setaccount</a><br>
|
||
|
|
<a href="settxfee.html">settxfee</a><br>
|
||
|
|
<a href="signmessage.html">signmessage</a><br>
|
||
|
|
<a href="walletlock.html">walletlock</a><br>
|
||
|
|
<a href="walletpassphrase.html">walletpassphrase</a><br>
|
||
|
|
<a href="walletpassphrasechange.html">walletpassphrasechange</a><br>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<br> </div>
|
||
|
|
</div>
|
||
|
|
</main> <!-- /container -->
|
||
|
|
</body>
|
||
|
|
</html>
|