| title | Bitcoin Indexer |
|---|---|
| sidebarTitle | Overview |
| description | 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. |
| llm | false |
The Bitcoin Indexer connects to your Bitcoin node, processes blocks in real-time, stores metaprotocol data in PostgreSQL, and serves REST APIs for each protocol.
:::callout
Ongoing maintainence and updates to the Bitcoin Indexer will stop on March 1st, 2026. The Bitcoin Indexer repo will continue to be open-sourced. :::
- 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
$ git clone https://github.com/hirosystems/bitcoin-indexer.git
$ cd bitcoin-indexer && cargo build --release
Docker images are also available:
$ docker pull hirosystems/bitcoin-indexer:latest
:::next-steps
- Node installation: Configure and sync a Bitcoin Core node optimized for the Bitcoin Indexer.
- Full sync: Run the indexer from scratch :::
:::callout type: help
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. :::