Documentation exported from Bitcoin Core 0.17.99

getaddressinfo (0.17.99 RPC)

blockchain

control

generating

mining

network

rawtransactions

util

wallet

getaddressinfo "address"

Return information about the given bitcoin address. Some information requires the address to be in the wallet.

Arguments

1. "address"

string

required

The bitcoin address to get the information of.

Result

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

If the key is a script

  "iswitness" : true|false,

boolean

If the address is a witness address

  "witness_version" : version

numeric

optional

The version number of the witness program

  "witness_program" : "hex"

string

optional

The hex value of the witness program

  "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 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 getaddressinfo output fields for the embedded address, excluding metadata (“timestamp”, “hdkeypath”, “hdseedid”) and relation to the wallet (“ismine”, “iswatchonly”).

  "iscompressed" : true|false,

boolean

If the address is compressed

  "label" : "label"

string

The label associated with the address, “” is the default label

  "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

  "hdseedid" : ""

string

optional

The Hash160 of the HD seed

  "hdmasterkeyid" : ""

string

optional

alias for hdseedid maintained for backwards compatibility. Will be removed in V0.18.

  "labels"

object

Array of labels associated with the address.

    [
      {

json object of label data

        "name": "labelname"

string

The label

        "purpose": "string"

string

Purpose of address (“send” for sending address, “receive” for receiving address)

      },...
    ]
}

Examples

Examples:

bitcoin-cli getaddressinfo "1PSSGeFHDnKNxiEyFrD1wcEaHr9hrQDDWc"
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaddressinfo", "params": ["1PSSGeFHDnKNxiEyFrD1wcEaHr9hrQDDWc"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/