Bitcoin Indexer

In this quickstart guide, you will set up the Bitcoin Indexer to index Ordinals or Runes activity on the Bitcoin blockchain.

Clone the repository and install the indexer:

Terminal

$ git clone https://github.com/hirosystems/bitcoin-indexer.git
$ cd bitcoin-indexer
$ cargo bitcoin-indexer-install

Generate a new configuration file:

Terminal

$ bitcoin-indexer config new

Configure your Postgres database in the generated TOML file:

[ordinals.db]
database = "metaprotocols"
host = "localhost"
port = 5432
username = "postgres"
password = "postgres"

Run the following command to start indexing Ordinals activity:

Terminal

$ bitcoin-indexer ordinals service start --config-path <path>

For Runes indexing, use:

Terminal

$ bitcoin-indexer runes service start --config-path <path>

A fully synced Bitcoin node is required for indexing to start.

Next steps

Explore the Ordinals Explorer to view inscriptions and transfers.

Learn how to interact with Ordinals data using our API.

Explore our Runes blockchain API documentation.