Overview
The Bitcoin Indexer enables you to build ordinals event streams, so you can create accurate, lightweight databases that gracefully handle Bitcoin forks and reorgs.
The Bitcoin Indexer is a reorg-aware indexer that automatically handles chain forks, so you don't need to waste time or resources reindexing your database yourself.
You can customize what ordinals data you index in order to create lightweight databases for faster query responses and a better user experience.
Installation
$git clone https://github.com/hirosystems/bitcoin-indexer.git$cd bitcoin-indexer$cargo bitcoin-indexer-install
Alternatively, you can use Docker images from Docker Hub.
Get started
System Requirements
Before running the indexer, ensure your system meets these requirements:
- CPU: Multi-core support for parallel processing
- Memory: Minimum 16GB RAM
- Storage: SSD or NVMe recommended
- OS: Support for 4096+ open file descriptors
- Postgres: Version 17+ recommended
Related tools
- Ordinals API: Skip the infrastructure setup and get the ordinals data you need from our Ordinals API, which is powered by the Bitcoin Indexer.
- Ordinals Explorer: Explore ordinals inscriptions and BRC-20 tokens rapidly in our Ordinals Explorer.
Reach out to us on the #indexer channel on Discord under the Hiro Developer Tools section. There's also a weekly office hours call every Wednesday at 1pm ET.