🔲runes_getBalance

You can use the runes_getBalance method to retrieve all your user's Runes balances, i.e. each Rune token that their connected wallet address owns, and in which amount.

Your app must have first connected to the wallet and obtained account read permissions. No query parameters are required for the method:

import { request } from 'sats-connect';

const response = await request('runes_getBalance', null);

if (response.status === 'success') {
  console.log(response.result);
} else {
  console.error(response.error);
}

The runes_getBalance method will not trigger any operation or prompt your user to sign any transaction. It will return an array of balance objects, each representing the connected wallet's holdings of a rune token:

balance	Description
runeName	a string representing the name of the Rune for which the balance is returned.
amount	the amount of Rune tokens which the address owns, based on confirmed Runes transactions only.
spendableBalance	the amount of Rune tokens which the address can spend. The spendable balance excludes rune utxos which are waiting transfer confirmation in the mempool.
symbol ℹ️ optional	a string representing the rune's currency symbol as a single Unicode code point. If a rune does not have a symbol, the generic currency sign ¤, also called a scarab, will be used
divisibility ℹ️ optional	a number representing the rune's divisibility, i.e. how finely it may be divided into its atomic units. Divisibility is expressed as the number of digits permissible after the decimal point in an amount of runes. The default value is 0.
inscriptionId ℹ️ optional	a string representing the ID of the inscription linked to the rune, which marketplaces and apps can use as logo