gethdkeys

Back to wallet

Wallet

Summary

List all BIP 32 HD keys in the wallet and which descriptors use them.

Description

List all BIP 32 HD keys in the wallet and which descriptors use them. Unavailable on P2MR-only chains because BIP32 extended public keys cannot derive SPHINCS+/P2MR public keys.

Arguments

• options (OBJ_NAMED_PARAMS): No description.
• active_only (BOOL): Show the keys for only active descriptors
• private (BOOL): Show private keys

Results

• value (ARR): No description.
• value (OBJ): No description.
  • xpub (STR): The extended public key
  • has_private (BOOL): Whether the wallet has the private key for this xpub
  • xprv (STR, optional): The extended private key if "private" is true
  • descriptors (ARR): Array of descriptor objects that use this HD key
  • value (OBJ): No description.
    • desc (STR): Descriptor string representation
    • active (BOOL): Whether this descriptor is currently used to generate new addresses

Examples

qbit-cli gethdkeys

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

qbit-cli -named gethdkeys active_only=true private=true

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "gethdkeys", "params": {"active_only":"true","private":"true"}}' -H 'content-type: application/json' http://127.0.0.1:8352/