Mirror/brk
1
0
Fork 0
mirror of https://github.com/bitcoinresearchkit/brk.git synced 2026-06-08 14:11:56 -07:00
Code Issues Packages Projects Releases Wiki Activity

readme: updated

Browse Source
This commit is contained in:
nym21
2026-01-14 20:35:07 +01:00
parent 1c7434ff83
commit 5661735f3e
1 changed files with 16 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README.md
+16 -8
View File
@@ -1,12 +1,10 @@
# Bitcoin Research Kit
Open-source on-chain analytics for Bitcoin.
[![MIT Licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/bitcoinresearchkit/brk/blob/main/docs/LICENSE.md)
[![Crates.io](https://img.shields.io/crates/v/brk.svg)](https://crates.io/crates/brk)
[![docs.rs](https://img.shields.io/docsrs/brk)](https://docs.rs/brk)
Combines functionality of [Glassnode](https://glassnode.com) (on-chain metrics), [mempool.space](https://mempool.space) (block explorer), and [electrs](https://github.com/romanz/electrs) (address index) into a single self-hostable package. See [Bitview](https://bitview.space) for a live example.
Open-source on-chain analytics for Bitcoin. Combines functionality of [Glassnode](https://glassnode.com) (on-chain metrics), [mempool.space](https://mempool.space) (block explorer), and [electrs](https://github.com/romanz/electrs) (address index) into a single self-hostable package. [Bitview](https://bitview.space) is an analytics interface built entirely on BRK.
## Data
@@ -14,19 +12,29 @@ Combines functionality of [Glassnode](https://glassnode.com) (on-chain metrics),
**Metrics** — Supply distributions, holder cohorts, network activity, fee markets, mining, and market indicators (realized cap, MVRV, SOPR, NVT).
**Indexes** — Query by date, height, halving epoch, address type, UTXO age.
**Indexes** — Date, height, halving epoch, address type, UTXO age.
**Mempool** — Fee estimation, projected blocks, unconfirmed transactions.
## Usage
**API** — REST with JSON/CSV. [Documentation](https://bitcoinresearchkit.org/api). Clients: [JavaScript](https://www.npmjs.com/package/brk-client), [Python](https://pypi.org/project/brk-client), [Rust](https://crates.io/crates/brk_client).
### API
**Self-host** — Requires Bitcoin Core. [Guide](./HOSTING.md). [Docker](https://github.com/bitcoinresearchkit/brk/tree/main/docker).
Query thousands of metrics and blockchain data in JSON or CSV. Use it free at [Bitview](https://bitview.space/api), no signup required.
**Library** — [docs.rs/brk](https://docs.rs/brk). [Architecture](./ARCHITECTURE.md).
[Documentation](https://bitview.space/api) · Clients: [JavaScript](https://www.npmjs.com/package/brk-client), [Python](https://pypi.org/project/brk-client), [Rust](https://crates.io/crates/brk_client) · [MCP](https://modelcontextprotocol.io)
**MCP** — Model Context Protocol server for LLMs.
### Self-host
Compute all metrics locally. Private, verifiable, self-sovereign. Runs alongside Bitcoin Core.
[Guide](./HOSTING.md)
### Library
Build custom applications in Rust. Use the full stack or individual components (parser, indexer, computer, server).
[Reference](https://docs.rs/brk) · [Architecture](./ARCHITECTURE.md)
## Links