Skip to main content
Runes3 Logo

runes3

runes3 is a modern Typescript and NodeJS library for Bitcoin Runes. Featuring XVERSE wallet support, rune balance and event indexing, ultra-fast runestone decoders with WASM and much more!

Read docs

1. Install Runes3

npm i runes3
Getting Started →

2. Connect to a Runes RPC provider

const { Runes3 } = require("runes3");

const Runes = new Runes3("https://runes.satsignal.io/v1");

/*
NOTE:
satsignal.io provides this free endpoint for everyone to support the Runes
ecoosystem. If you need higher ratelimits you can create an account there and
get an authed endpoint or run your own runes node with
https://github.com/runeapeslabs/Nana (1tb+ of storage and 16gb of ram required)
*/
Getting Started →

3. Get an accounts balalnce

const { Runes3 } = require("runes3");

const Runes = new Runes3("https://runes.satsignal.io/v1");

const start = async () => {
const balances = await Runes.getAccount(
"bc1pdcy7dw547w8qle3ltc3efulsv2ng66pwy3fwcxpphmn8ghc5sxfsgh72la"
).getBalances();

console.log("This address has the following runes: ", balances.keys());

console.log("The balance for 845769:3964 is: ");
const balance = balances.get("845769:3964").parse();

console.log(balance);
};

start();
Query an address balance →