6 releases
new 0.0.6 | Mar 4, 2025 |
---|---|
0.0.5 | Mar 3, 2025 |
0.0.2 | Feb 27, 2025 |
#342 in Magic Beans
210 downloads per month
92KB
2K
SLoC
Bitcoin Research Kit
The Bitcoin Research Kit is a suite of tools designed to parse, index, compute, serve and display data stored on a Bitcoin Core node.
In other words it's an alternative to Glassnode, mempool.space and electrs all in one package with a particular focus on the self-hosting experience.
The toolkit can be used in various ways to accommodate as many needs as possible.
- Website
Anyone can go to kibo.money website which is the official instance and showcases very well what the suite is capable of
Completely free including the API which is also auth-less
Powered by BRK using thekibo.money
front-end and all features enabled - CLI
Node runners can self-host their own instance usingbrk_cli
- Crates
Rust developers have a wide range crates available (which can be found below) for maximum flexibility
So whether you're an enthusiast, a researcher, a miner, an analyst, or just curious, there should be something for everyone !
Crates
brk
: Wrapper around all otherbrk-*
cratesbrk_cli
: A standalone command line interface to interact with the Bitcoin Research Kitbrk_computer
: A Bitcoin dataset computer, built on top of brk_indexerbrk_core
: The Core (Structs and Errors) of the Bitcoin Research Kitbrk_exit
: An exit blocker built on top of ctrlcbrk_fetcher
: A Bitcoin price fetcherbrk_indexer
: A Bitcoin Core indexer built on top of brk_parserbrk_logger
: A clean logger used in the Bitcoin Research Kit.brk_parser
: A very fast Bitcoin Core block parser and iterator built on top of bitcoin-rustbrk_query
: A library that finds requested datasets.brk_server
: A server that serves Bitcoin data and swappable front-ends, built on top ofbrk_indexer
,brk_fetcher
andbrk_computer
brk_vec
: A very small, fast, efficient and simple storable Vec.
Acknowledgments
Deepest gratitude to the Open Sats public charity. Their grant — from December 2024 to the present — has been critical in sustaining this project.
Heartfelt thanks go out to every donor on Nostr and Geyser.fund whose support has ensured the availability of the kibō.money public instance.
Hosting as a service
Soon™
If you'd like to have your own instance hosted for you please contact tranche.dent-9o@icloud.com.
- Separate dedicated servers using different ISPs and Cloudflare for maximum availability
- Optional
*.bitcoinresearchkit.org
,*.kibo.money
and*.satonomics.xyz
subdomains - A very generous
2 * 1 GB/s
API limit - Direct contact and feature requests
Pricing: 0.01 BTC / month
or 0.1 BTC / year
Donate
bc1q950q4ukpxxm6wjjkv6cpq8jzpazaxrrwftctkt
Old README
Endpoints
If you running locally, you can replace
https://kibo.money
byhttp://localhost:3110
- /: Website
- /api: A JSON with all available datasets, with their respective id and endpoint, better viewed in a Firefox based browser
- /api/TIMESCALE-to-ID:
TIMESCALE
can bedate
orheight
, andID
is the id with_
replaced by-
, let's takedate-to-close
(price at the end of each day) as an example- /api/date-to-close: current year's values in a json format
- /api/date-to-close?chunk=2009: values from the year 2009 in a json format
- /api/date-to-close?all=true: all values in a json format
- You can also specify the extension to download a file, either
.json
or.csv
to get the dataset in a CSV format; like so:
Dependencies
~0–15MB
~202K SLoC