Skip to content

Latest commit

 

History

1,540 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NBXplorer

NuGet Docker pulls CI

NBXplorer is a minimalist Bitcoin UTXO tracker for HD wallets. It connects to a trusted full node, watches only the wallets and addresses you register, and exposes their transactions, UTXOs, and balances through a REST API.

NBXplorer supports P2PKH, P2SH, SegWit, Taproot, multisig, and wallet policies. It works with pruned nodes, stores its index in PostgreSQL, and can track many wallets without importing them into Bitcoin Core.

Warning

NBXplorer is an infrastructure service and is not intended to be exposed directly to the internet. Keep it on a trusted network and place authentication and transport security at your application boundary.

Documentation

Start at the documentation index, or go directly to:

Typical workflow

  1. Track a wallet derivation scheme, a standalone address, or a group of tracked sources.
  2. Request the next unused address when receiving a payment.
  3. Consume transaction and block events through polling, long polling, or WebSockets.
  4. Query transactions, balances, and UTXOs.
  5. Create a PSBT for your application to sign, then broadcast the signed transaction.

The API integrator guide explains these concepts, and the REST API reference documents the individual operations.

When to use NBXplorer

NBXplorer is designed for services that need private, self-hosted wallet tracking without indexing the entire blockchain.

Compared with an Electrum server, NBXplorer can run on a pruned node, supports many wallets, and provides wallet-oriented APIs without requiring the Electrum protocol. Compared with Bitcoin Core wallets, it keeps wallet tracking separate from the node and is designed to handle large numbers of addresses and wallets. Unlike a hosted API, it does not require sharing financial activity with a third party.

Bitcoin is the primary supported chain. NBXplorer can also index Liquid and several Bitcoin-derived networks; see the operator guide.

License

NBXplorer is licensed under the MIT License.

About

NBitcoin Explorer

Resources

Contributing

Stars

369 stars

Watchers

28 watching

Forks

Releases

Packages

Used by

Contributors

Languages