Bitview and the Bitcoin Research Kit

Bitview turns a Bitcoin Core node into a local Bitcoin data platform for chain exploration, mempool data, and on-chain research. The official free hosted instance is bitview.space.

• Bitcoin Research Kit (BRK): reusable Rust primitives for reading Bitcoin Core data, RPC, mempool tracking, storage, domain types, and the on-chain price oracle.
• Bitview: the self-hostable application that composes BRK with a typed indexer and analytics plugin graph, query layer, REST server, showcases, and generated clients.

Used by

See Architecture for the component and data-flow details.

Repository map

Path	Purpose
crates/brk_*	Reusable Bitcoin primitives
crates/bitview_plugin_*	Official indexing and analytics plugins
crates/bitview*	Plugin contract, runtime, composition, query/server stack, daemon, code generation, and Rust clients
crates/{vecdb,rawdb,byteview,fjall,lsm-tree}	Storage and data infrastructure
examples/custom_plugin	Runnable external-plugin and custom-composition example
modules/bitview-client	JavaScript/TypeScript client
packages/bitview_client	Python client
showcases	Showcase pages, served by the server, and Studio
docs, benches, docker, and scripts	Project documentation, measurements, packaging, and maintenance tooling

Use Bitview

The hosted showcases, API, and MCP endpoint require no account or authentication:

• Bitview, its front page, Studio and showcases
• Interactive API
• OpenAPI
• MCP client endpoint: https://mcp.bitview.space/
• CLI
• JavaScript
• Python
• Rust

curl https://bitview.space/api/mempool/price
curl https://bitview.space/api/series/count

Find series identifiers with /api/series/search?q=<concept>.

Self-host Bitview

rustup update && RUSTFLAGS="-C target-cpu=native" cargo install --locked bitviewd
bitviewd

The default composition needs Linux or macOS, a mainnet Bitcoin Core node with RPC and complete blk*.dat files from genesis, about 290 GiB for Bitview plus Bitcoin Core storage and growth headroom, and 16 GB of RAM recommended for a full sync. The showcases and API are served at localhost:3110, to this machine only unless serverbind says otherwise.

See the bitviewd guide for requirements, disk usage, installation, configuration, initial sync, and custom compositions.

Build with BRK

[dependencies]
brk_reader = "0.12"
brk_rpc = "0.12"
brk_types = "0.12"

For a new Bitview metric or composition, start with the custom plugin example and the bitview_plugin contract.

Develop

The repository pins its Rust toolchain in rust-toolchain.toml.

cargo check --workspace
cargo api   # records the API snapshots
cargo bindgen   # regenerates the clients

Documentation

• Changelog
• Professional hosting

Support and community

BRK is supported by OpenSats from December 2024 through June 2027.

Discord · X · Issues · Support

Donations

bc1pkqvzn3pepug695xtvwmpm0sjd6n9j55v792cwfruzkqzrf2jn47s3hq0ts

License

MIT