brk_query

Query interface for Bitcoin indexed and computed data.

What It Enables

Query blocks, transactions, addresses, and 1000+ on-chain metrics through a unified API. Supports pagination, range queries, and multiple output formats.

Key Features

• Unified access: Single entry point to indexer, computer, and mempool data
• Metric discovery: List metrics, filter by index type, fuzzy search
• Range queries: By height, date, or relative offsets (from=-100)
• Multi-metric bulk queries: Fetch multiple metrics in one call
• Async support: Tokio-compatible with AsyncQuery wrapper
• Format flexibility: JSON, CSV, or raw values

Core API

let query = Query::build(&reader, &indexer, &computer, Some(mempool));

// Current height
let height = query.height();

// Metric queries (two-phase: resolve then format)
let resolved = query.resolve(MetricSelection {
    metrics: vec!["supply".into()],
    index: Index::Height,
    range: DataRangeFormat::default(),
}, usize::MAX)?;
let data = query.format(resolved)?;

// Block queries
let info = query.block_by_height(Height::new(840_000))?;

// Transaction queries
let tx = query.transaction(txid.into())?;

// Address queries
let stats = query.address(address)?;

Query Types

Async Usage

let async_query = AsyncQuery::build(&reader, &indexer, &computer, mempool);

// Run blocking queries in thread pool
let result = async_query.run(|q| q.block_by_height(height)).await;

// Access inner Query
let height = async_query.inner().height();

Recommended: mimalloc v3

Use mimalloc v3 as the global allocator to reduce memory usage.

Built On

• brk_indexer for raw indexed data
• brk_computer for derived metrics
• brk_mempool for mempool queries
• brk_reader for raw block access