Bitcoin Indexer

Run your own Bitcoin metaprotocol indexer with built-in support for Ordinals, Runes, and BRC-20 tokens.

Overview

The Bitcoin Indexer is a high-performance, reorg-aware indexing engine that tracks Bitcoin metaprotocols and serves API endpoints for Ordinals, Runes, and BRC-20 tokens. Unlike basic indexers, it automatically handles blockchain reorganizations, ensuring your data stays accurate without manual intervention.

The indexer connects to your Bitcoin node, processes blocks in real-time, stores metaprotocol data in PostgreSQL, and serves REST APIs for each protocol.

Key features

✓ Metaprotocol indexing - Built-in support for Ordinals, Runes, and BRC-20 with extensible architecture
✓ Reorg-aware processing - Automatically handles chain forks and reorganizations
✓ REST API endpoints - Production-ready APIs for Ordinals and Runes
✓ Archive bootstrapping - Quick sync from Hiro archives instead of full indexing

Installation

Terminal

$ git clone https://github.com/hirosystems/bitcoin-indexer.git
$ cd bitcoin-indexer
$ cargo build --release
[32m✓[0m [1mBuilt bitcoin-indexer[0m

Docker images are also available:

Terminal

$ docker pull hirosystems/bitcoin-indexer:latest

Next steps

Quickstart

Set up your indexer using Hiro archives in 30 minutes

Core concepts

Understand metaprotocols, reorgs, and indexing architecture

Detailed setup

Complete guide to production deployment

Need help with the Bitcoin Indexer?

Reach out to us on the #ordinals channel on Discord under the Hiro Developer Tools section. There's also a weekly office hours call every Wednesday at 1pm ET.