Skip to main content

Overview

Ordhook enables you to build Ordinals event streams, so you can create accurate databases that gracefully handle Bitcoin forks and reorgs.

Ordhook is a reorg-aware indexer that automatically handles chain forks, so you don’t need to waste time or resources reindexing your database. With a familiar event-driven framework, you can customize what Ordinals data you index in order to create lightweight databases for faster query responses and a better user experience.

Install Ordhook​

Clone the Ordhook Repo:

git clone https://github.com/hirosystems/ordhook.git

Navigate to the root directory and run cargo ordhook-install to install:

cd ordhook && cargo ordhook-install

Create Event Streams​

Scan past Ordinals activity

→

Fetch historical ordinals activity, whether for a range of blocks or for a particular inscription.

Stream Ordinals activity

→

Create webhook-like triggers that listen for ordinals activity and post that activity to a local server or file.

Run Ordhook as a Service

→

Spin up an ongoing service that listens for future ordinals activity and posts that data to a local server.

Ordinals API: Skip the infrastructure setup and get the ordinals data you need from our Ordinals API, which is powered by Ordhook.

Ordinals Explorer: Explore ordinals inscriptions and BRC-20 tokens rapidly in our Ordinals Explorer.

Need help building with Ordhook? Reach out to us on the #chainhook channel on Discord under Hiro Developer Tools section. We also host a weekly office hours on Discord every Monday at 11am ET.