mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-24 22:59:58 -07:00
101 lines
4.6 KiB
Markdown
101 lines
4.6 KiB
Markdown
# Bitcoin Research Kit
|
|
|
|
[](https://github.com/bitcoinresearchkit/brk/blob/main/docs/LICENSE.md)
|
|
[](https://crates.io/crates/brk)
|
|
[](https://docs.rs/brk)
|
|
[](https://opensats.org/)
|
|
[](https://discord.gg/WACpShCB7M)
|
|
[](https://x.com/_nym21_)
|
|
[](https://primal.net/p/nprofile1qqsfw5dacngjlahye34krvgz7u0yghhjgk7gxzl5ptm9v6n2y3sn03sqxu2e6)
|
|
|
|
> "Shout out to Bitcoin Research Kit. [...] Couldn't recommend them highly enough."
|
|
> — James Check (CheckOnChain), [What Bitcoin Did #1000](https://www.whatbitcoindid.com/episodes/wbd1000-checkmate)
|
|
|
|
Open-source, self-hostable on-chain analytics for Bitcoin. Block explorer, address index, and thousands of metrics, everything computed from your node, even the price.
|
|
|
|
Similar to [Glassnode](https://glassnode.com) + [mempool.space](https://mempool.space) + [UTXO Oracle](https://utxo.live/oracle/) in a single package.
|
|
|
|
[Bitview](https://bitview.space) is a free hosted instance of BRK.
|
|
|
|
## Data
|
|
|
|
**Zero external dependencies.** BRK needs only a Bitcoin Core node. Historical prices are built in, live price from your mempool. Every metric is computed locally from your own copy of the blockchain. Your node, your data.
|
|
|
|
**Blockchain:** Blocks, transactions, addresses, UTXOs.
|
|
|
|
**Metrics:** Supply distributions, holder cohorts, network activity, fee markets, mining, and market indicators (realized cap, MVRV, SOPR, NVT).
|
|
|
|
**Indexes:** Date, height, halving epoch, address type, UTXO age.
|
|
|
|
**Mempool:** Fee estimation, projected blocks, unconfirmed transactions.
|
|
|
|
## Usage
|
|
|
|
### Website
|
|
|
|
Browse metrics and charts at [bitview.space](https://bitview.space), no signup required.
|
|
|
|
### API
|
|
|
|
```bash
|
|
curl https://bitview.space/api/mempool/price
|
|
```
|
|
|
|
Query metrics and blockchain data in JSON or CSV.
|
|
|
|
[Documentation](https://bitview.space/api) · [JavaScript](https://www.npmjs.com/package/brk-client) · [Python](https://pypi.org/project/brk-client) · [Rust](https://crates.io/crates/brk_client) · [llms.txt](https://bitview.space/llms.txt) · [LLM-friendly schema](https://bitview.space/api.json)
|
|
|
|
### Self-host
|
|
|
|
```bash
|
|
cargo install --locked brk_cli && brk
|
|
```
|
|
|
|
Run your own website and API. All you need is Bitcoin Core.
|
|
|
|
> **Note:** BRK uses [sparse files](https://en.wikipedia.org/wiki/Sparse_file). Tools like `ls -l` or Finder report the logical file size (>1 TB), not actual disk usage (~350 GB). Use `du -sh` to see real usage.
|
|
|
|
[Guide](https://github.com/bitcoinresearchkit/brk/blob/main/crates/brk_cli/README.md) · [Professional hosting](./PROFESSIONAL_HOSTING.md)
|
|
|
|
### Library
|
|
|
|
```bash
|
|
cargo add brk
|
|
```
|
|
|
|
Build custom applications in Rust. Use the full stack or individual components (parser, indexer, computer, server).
|
|
|
|
[Reference](https://docs.rs/brk) · [Architecture](./ARCHITECTURE.md)
|
|
|
|
## Supporters
|
|
|
|
- [OpenSats](https://opensats.org/) (December 2024 - June 2026)
|
|
|
|
[Become a supporter](mailto:support@bitcoinresearchkit.org)
|
|
|
|
## Donations
|
|
|
|
<a href="https://x.com/_Checkmatey_"><img src="https://pbs.twimg.com/profile_images/1657255419172253698/ncG0Gt8e_400x400.jpg" width="40" alt="_Checkmatey_" title="_Checkmatey_" style="border-radius:50%" /></a>
|
|
<a href="https://x.com/JohanMBergman"><img src="https://pbs.twimg.com/profile_images/1958587470120988673/7rlY5csu_400x400.jpg" width="40" alt="Johan Bergman" title="Johan Bergman" style="border-radius:50%" /></a>
|
|
<a href="https://x.com/alonshvartsman"><img src="https://pbs.twimg.com/profile_images/2005689891028406272/8Qgmnurs_400x400.jpg" width="40" alt="Alon Shvartsman" title="Alon Shvartsman" style="border-radius:50%" /></a>
|
|
<a href="https://x.com/clearmined1"><img src="https://pbs.twimg.com/profile_images/1657777901830541313/6OAaR8XF_400x400.png" width="40" alt="ClearMined" title="ClearMined" style="border-radius:50%" /></a>
|
|
|
|
<img src="./qr.png" alt="Bitcoin donate QR code" width="120" />
|
|
|
|
[`bc1q09 8zsm89 m7kgyz e338vf ejhpdt 92ua9p 3peuve`](bitcoin:bc1q098zsm89m7kgyze338vfejhpdt92ua9p3peuve)
|
|
|
|
## Links
|
|
|
|
- [Changelog](./CHANGELOG.md)
|
|
- [Contributing](https://github.com/bitcoinresearchkit/brk/issues)
|
|
|
|
## Community
|
|
|
|
- [Discord](https://discord.gg/WACpShCB7M)
|
|
- [X](https://x.com/_nym21_)
|
|
- [Nostr](https://primal.net/p/nprofile1qqsfw5dacngjlahye34krvgz7u0yghhjgk7gxzl5ptm9v6n2y3sn03sqxu2e6)
|
|
|
|
## License
|
|
|
|
[MIT](./LICENSE.md)
|