getwalletinfo

Back to wallet

Wallet

Summary

Returns an object containing various wallet state info.

Description

Returns an object containing various wallet state info.

Arguments

None.

Results

  • value (OBJ): No description.
  • walletname (STR): the wallet name
  • walletversion (NUM): (DEPRECATED) only related to unsupported legacy wallet, returns the latest version 169900 for backwards compatibility
  • format (STR): the database format (only sqlite)
  • txcount (NUM): the total number of transactions in the wallet
  • keypoolsize (NUM): how many new keys are pre-generated (only counts external keys)
  • keypoolsize_hd_internal (NUM, optional): how many new keys are pre-generated for internal use (used for change outputs, only appears if the wallet is using this feature, otherwise external keys are used)
  • unlocked_until (NUM_TIME, optional): the UNIX epoch time until which the wallet is unlocked for transfers, or 0 if the wallet is locked (only present for passphrase-encrypted wallets)
  • paytxfee (STR_AMOUNT): the transaction fee configuration, set in QBT/kvB
  • private_keys_enabled (BOOL): false if privatekeys are disabled for this wallet (enforced watch-only wallet)
  • avoid_reuse (BOOL): whether this wallet tracks clean/dirty coins in terms of reuse
  • scanning (OBJ): current scanning details, or false if no scan is in progress
    • duration (NUM): elapsed seconds since scan start
    • progress (NUM): scanning progress percentage [0.0, 1.0]
  • descriptors (BOOL): whether this wallet uses descriptors for output script management
  • external_signer (BOOL): whether this wallet is configured to use an external signer such as a hardware wallet
  • blank (BOOL): Whether this wallet intentionally does not contain any keys, scripts, or descriptors
  • birthtime (NUM_TIME, optional): The start time for blocks scanning. It could be modified by (re)importing any descriptor with an earlier timestamp.
  • flags (ARR): The flags currently set on the wallet
    • flag (STR): The name of the flag
  • lastprocessedblock (OBJ): hash and height of the block this information was generated on
    • hash (STR_HEX): hash of the block this information was generated on
    • height (NUM): height of the block this information was generated on

Examples

qbit-cli getwalletinfo

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