Wallet RPCs

60 methods in this category, with 4 new, 9 params/results changed, 0 behavior changed, and 47 unchanged since v30.2.

abandontransaction

Mark in-wallet transaction <txid> as abandoned

wallet / wallet

Wallet

abortrescan

Stops current wallet rescan triggered by an RPC call, e.g. by a rescanblockchain call.

wallet / wallet

Wallet

backupwallet

Safely copies the current wallet file to the specified destination, which can either be a directory or a path with a filename.

wallet / wallet

Wallet

bumpfee

Bumps the fee of a transaction T, replacing it with a new transaction B.

wallet / wallet

Wallet

createwallet

Creates and loads a new wallet.

wallet / wallet

Wallet

createwalletdescriptor

Creates the wallet's descriptor for the given address type. The address type must be one that the wallet does not already have a descriptor for. On P2MR-only chains, public P2MR descriptors are omitted from the result; use exportpubkeydb for watch-only P2MR exports.

wallet / wallet

Changed params/results since v30.2 Wallet

encryptwallet

Encrypts the wallet with 'passphrase'. This is for first time encryption.

wallet / wallet

Wallet

exportpubkeydb

Exports wallet P2MR pubkeys as an explicit-pubkey JSON database that can be imported into a watch-only wallet.

wallet / wallet

New since v30.2 Wallet

getaddressesbylabel

Returns the list of addresses assigned the specified label.

wallet / wallet

Wallet

getaddressinfo

Return information about the given qbit address.

wallet / wallet

Changed params/results since v30.2 Wallet

getbalance

Returns the total available balance.

wallet / wallet

Wallet

getbalances

Returns an object with all balances in QBT.

wallet / wallet

Wallet

gethdkeys

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

wallet / wallet

Wallet

getnewaddress

Returns a new qbit address for receiving payments.

wallet / wallet

Wallet

getnextpubkeydbaddress

Returns the next allocatable imported P2MR pubkey-pool address for a watch-only wallet.

wallet / wallet

New since v30.2 Wallet

getreceivedbyaddress

Returns the total amount received by the given address in transactions with at least minconf confirmations.

wallet / wallet

Wallet

getreceivedbylabel

Returns the total amount received by addresses with <label> in transactions with at least [minconf] confirmations.

wallet / wallet

Wallet

gettransaction

Get detailed information about in-wallet transaction <txid>

wallet / wallet

Wallet

getwalletinfo

Returns an object containing various wallet state info.

wallet / wallet

Wallet

importdescriptors

Import descriptors. This will trigger a rescan of the blockchain based on the earliest timestamp of all descriptors being imported. Requires a new wallet backup.

wallet / wallet

Wallet

importprunedfunds

Imports funds without rescan. Corresponding address or script must previously be included in wallet. Aimed towards pruned wallets. The end-user is responsible to import additional transactions that subsequently spend the imported outputs or rescan after the point in the blockchain the transaction is included.

wallet / wallet

Wallet

importpubkeydb

Imports a JSON pubkey database into a watch-only wallet as P2MR descriptors.

wallet / wallet

New since v30.2 Wallet

keypoolrefill

Refills each descriptor keypool in the wallet up to the specified number of new keys.

wallet / wallet

Wallet

listaddressgroupings

Lists groups of addresses which have had their common ownership

wallet / wallet

Wallet

listdescriptors

List all descriptors present in a wallet.

wallet / wallet

Changed params/results since v30.2 Wallet

listlabels

Returns the list of all labels, or labels that are assigned to addresses with a specific purpose.

wallet / wallet

Wallet

listlockunspent

Returns list of temporarily unspendable outputs.

wallet / wallet

Wallet

listpubkeydbstatus

Reports imported P2MR pubkey-pool allocation status by account and chain.

wallet / wallet

New since v30.2 Wallet

listsinceblock

Get all transactions in blocks since block [blockhash], or all transactions if omitted.

wallet / wallet

Wallet

listtransactions

If a label name is provided, this will return only incoming transactions paying to addresses with the specified label.

wallet / wallet

Wallet

listunspent

Returns array of unspent transaction outputs

wallet / wallet

Wallet

listwalletdir

Returns a list of wallets in the wallet directory.

wallet / wallet

Wallet

listwallets

Returns a list of currently loaded wallets.

wallet / wallet

Wallet

loadwallet

Loads a wallet from a wallet file or directory.

wallet / wallet

Wallet

lockunspent

Updates list of temporarily unspendable outputs.

wallet / wallet

Wallet

migratewallet

Migrate the wallet to a descriptor wallet.

wallet / wallet

Wallet

psbtbumpfee

Bumps the fee of a transaction T, replacing it with a new transaction B.

wallet / wallet

Wallet

removeprunedfunds

Deletes the specified transaction from the wallet. Meant for use with pruned wallets and as a companion to importprunedfunds. This will affect wallet balances.

wallet / wallet

Wallet

rescanblockchain

Rescan the local blockchain for wallet related transactions.

wallet / wallet

Wallet

restorewallet

Restores and loads a wallet from backup.

wallet / wallet

Wallet

send

EXPERIMENTAL warning: this call may be changed in future releases.

wallet / wallet

Changed params/results since v30.2 Wallet

sendall

EXPERIMENTAL warning: this call may be changed in future releases.

wallet / wallet

Changed params/results since v30.2 Wallet

sendmany

Send multiple times. Amounts are double-precision floating point numbers.

wallet / wallet

Changed params/results since v30.2 Wallet

sendtoaddress

Send an amount to a given address.

wallet / wallet

Changed params/results since v30.2 Wallet

setlabel

Sets the label associated with the given address.

wallet / wallet

Wallet

settxfee

(DEPRECATED) Set the transaction fee rate in QBT/kvB for this wallet. Overrides the global -paytxfee command line parameter.

wallet / wallet

Wallet

setwalletflag

Change the state of the given wallet flag for a wallet.

wallet / wallet

Wallet

signmessage

Sign a message with the private key of an address

wallet / wallet

Wallet

signrawtransactionwithwallet

Sign inputs for raw transaction (serialized, hex-encoded).

wallet / wallet

Changed params/results since v30.2 Wallet

simulaterawtransaction

Calculate the balance change resulting in the signing and broadcasting of the given transaction(s).

wallet / wallet

Wallet

unloadwallet

Unloads the wallet referenced by the request endpoint or the wallet_name argument.

wallet / wallet

Wallet

walletcreatefundedpsbt

Creates and funds a transaction in the Partially Signed Transaction format.

wallet / wallet

Wallet

walletdisplayaddress

Display address on an external signer for verification.

wallet / wallet

Wallet Signer

walletlock

Removes the wallet encryption key from memory, locking the wallet.

wallet / wallet

Wallet

walletpassphrase

Stores the wallet decryption key in memory for 'timeout' seconds.

wallet / wallet

Wallet

walletpassphrasechange

Changes the wallet passphrase from 'oldpassphrase' to 'newpassphrase'.

wallet / wallet

Wallet

walletprocesspsbt

Update a PSBT with input information from our wallet and then sign inputs

wallet / wallet

Changed params/results since v30.2 Wallet