mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-07-09 18:18:14 -07:00
global: snapshot
This commit is contained in:
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"schema_version": "v1",
|
||||
"name_for_human": "Bitcoin Research Kit",
|
||||
"name_for_model": "bitcoin_research_kit",
|
||||
"description_for_human": "Query Bitcoin on-chain analytics: thousands of metrics, block explorer, address index.",
|
||||
"description_for_model": "Bitcoin on-chain analytics API. Search metrics via /api/metrics/search/{query}, fetch data via /api/metric/{metric}/{index}. No auth required.",
|
||||
"auth": { "type": "none" },
|
||||
"api": {
|
||||
"type": "openapi",
|
||||
"url": "https://bitview.space/openapi.json"
|
||||
},
|
||||
"logo_url": "https://bitview.space/assets/favicon-196.png",
|
||||
"contact_email": "hello@bitcoinresearchkit.org",
|
||||
"legal_info_url": "https://github.com/bitcoinresearchkit/brk/blob/main/docs/LICENSE.md"
|
||||
}
|
||||
@@ -0,0 +1,72 @@
|
||||
# Bitcoin Research Kit (BRK)
|
||||
|
||||
> Open-source Bitcoin on-chain analytics API. Thousands of metrics, block explorer, address index — all computed from a Bitcoin Core node, including the price.
|
||||
|
||||
Base URL: https://bitview.space
|
||||
|
||||
## API
|
||||
|
||||
Free, no auth required. JSON and CSV output. Mempool.space compatible for block/tx/address endpoints.
|
||||
|
||||
- [Interactive docs](https://bitview.space/api)
|
||||
- [OpenAPI spec (compact, LLM-optimized)](https://bitview.space/api.json)
|
||||
- [OpenAPI spec (full)](https://bitview.space/openapi.json)
|
||||
|
||||
## Discover
|
||||
|
||||
Search for metrics by keyword:
|
||||
|
||||
GET /api/metrics/search/{query}
|
||||
|
||||
Browse all available metrics:
|
||||
|
||||
GET /api/metrics/list
|
||||
|
||||
List available indexes (date, height, etc.):
|
||||
|
||||
GET /api/metrics/indexes
|
||||
|
||||
Browse the full metric catalog as a tree:
|
||||
|
||||
GET /api/metrics
|
||||
|
||||
## Query
|
||||
|
||||
Get a metric by name and index:
|
||||
|
||||
GET /api/metric/{metric}/{index}
|
||||
GET /api/metric/{metric}/{index}?start=-30
|
||||
|
||||
Fetch multiple metrics at once:
|
||||
|
||||
GET /api/metrics/bulk?index={index}&metrics={metric1},{metric2}
|
||||
|
||||
See the `MetricData` schema and query parameters (`start`, `end`, `limit`) in the [OpenAPI spec](https://bitview.space/api.json).
|
||||
|
||||
## Block Explorer
|
||||
|
||||
GET /api/block-height/{height}
|
||||
GET /api/block/{hash}
|
||||
GET /api/tx/{txid}
|
||||
GET /api/address/{address}
|
||||
|
||||
## Mempool
|
||||
|
||||
GET /api/mempool/price
|
||||
GET /api/mempool/info
|
||||
GET /api/v1/fees/recommended
|
||||
|
||||
## Client Libraries
|
||||
|
||||
- JavaScript: https://www.npmjs.com/package/brk-client
|
||||
- Python: https://pypi.org/project/brk-client/
|
||||
- Rust: https://crates.io/crates/brk_client
|
||||
|
||||
## Metric Categories
|
||||
|
||||
Market, supply, mining, network activity, UTXO age bands, cointime economics, holder cohorts, cost basis distributions, and more. Use the discovery endpoints above to explore.
|
||||
|
||||
## Source
|
||||
|
||||
- GitHub: https://github.com/bitcoinresearchkit/brk
|
||||
- License: MIT
|
||||
+6
-1
@@ -1,2 +1,7 @@
|
||||
User-agent: *
|
||||
Allow: /
|
||||
Allow: /
|
||||
|
||||
# LLM-friendly resources
|
||||
# llms.txt: https://llmstxt.org/
|
||||
# api.json: Compact OpenAPI spec optimized for LLM consumption
|
||||
Sitemap: https://bitview.space/llms.txt
|
||||
Reference in New Issue
Block a user