getaddressinfo

Back to wallet

Changed params/results since v30.2 Wallet

Summary

Return information about the given qbit address.

Description

Return information about the given qbit address. Some of the information will only be present if the address is in the active wallet.

Change Buckets

  • Changed params/results since v30.2

Arguments

  • address (STR, required): The qbit address for which to get information.

Results

  • value (OBJ): No description.
  • address (STR): The qbit address validated.
  • scriptPubKey (STR_HEX): The hex-encoded output script generated by the address.
  • ismine (BOOL): If the address is yours.
  • iswatchonly (BOOL): (DEPRECATED) Always false.
  • solvable (BOOL): If we know how to spend coins sent to this address, ignoring the possible lack of private keys.
  • desc (STR, optional): A descriptor for spending coins sent to this address (only when solvable).
  • parent_desc (STR, optional): The descriptor used to derive this address if this is a descriptor wallet
  • isscript (BOOL, optional): If the key is a script.
  • ischange (BOOL): If the address was used for change output.
  • iswitness (BOOL): If the address is a witness address.
  • witness_version (NUM, optional): The version number of the witness program.
  • witness_program (STR_HEX, optional): The hex value of the witness program.
  • script (STR, 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_v1_taproot, witness_v2_p2mr, witness_unknown.
  • hex (STR_HEX, optional): The redeemscript for the p2sh address.
  • pubkeys (ARR, optional): Array of pubkeys associated with the known redeemscript (only if script is multisig).
    • pubkey (STR): No description.
  • sigsrequired (NUM, optional): The number of signatures required to spend multisig output (only if script is multisig).
  • pubkey (STR_HEX, optional): The hex value of the raw public key for single-key addresses (possibly embedded in P2SH or P2WSH).
  • embedded (OBJ, optional): Information about the address embedded in P2SH or P2WSH, if relevant and known.
    • value (ELISION): Includes all getaddressinfo output fields for the embedded address, excluding metadata (timestamp, hdkeypath, hdseedid) and relation to the wallet (ismine).
  • iscompressed (BOOL, optional): If the pubkey is compressed.
  • timestamp (NUM_TIME, optional): The creation time of the key, if available, expressed in UNIX epoch time.
  • hdkeypath (STR, optional): The HD keypath, if the key is HD and available.
  • hdseedid (STR_HEX, optional): The Hash160 of the HD seed.
  • hdmasterfingerprint (STR_HEX, optional): The fingerprint of the master key.
  • labels (ARR): Array of labels associated with the address. Currently limited to one label but returned as an array to keep the API stable if multiple labels are enabled in the future.
    • label name (STR): Label name (defaults to "").
  • pqc_key_states (ARR, optional): PQC usage state for local wallet keys that participated in this response.
    • value (OBJ): No description.
    • pubkey (STR_HEX): The hex-encoded PQC public key.
    • pqc_signature_count (NUM): The number of signatures used by this PQC key.
    • pqc_signature_limit (NUM): The hard signature limit for this PQC key.
    • pqc_signatures_remaining (NUM): The remaining signature budget for this PQC key.
    • pqc_limit_state (STR): The PQC usage state. One of normal, warning, critical, or exhausted.
  • pqc_overall_limit_state (STR, optional): The maximum PQC usage severity across pqc_key_states.
  • pqc_signature_count (NUM, optional): The number of signatures used by the single local PQC key associated with this response.
  • pqc_signature_limit (NUM, optional): The hard signature limit for the single local PQC key associated with this response.
  • pqc_signatures_remaining (NUM, optional): The remaining signature budget for the single local PQC key associated with this response.
  • pqc_limit_state (STR, optional): The PQC usage state for the single local PQC key associated with this response.

Examples

qbit-cli getaddressinfo "qb1zqqqsyqcyq5rqwzqfpg9scrgwpugpzysnzs23v9ccrydpk8qarc0sjq57mw"

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getaddressinfo", "params": ["qb1zqqqsyqcyq5rqwzqfpg9scrgwpugpzysnzs23v9ccrydpk8qarc0sjq57mw"]}' -H 'content-type: application/json' http://127.0.0.1:8352/