Mirror/brk
1
0
Fork 0
mirror of https://github.com/bitcoinresearchkit/brk.git synced 2026-04-24 06:39:58 -07:00
Code Issues Packages Projects Releases Wiki Activity

global: snapshot

Browse Source
This commit is contained in:
nym21
2026-01-16 23:49:49 +01:00
parent 3b00a92fa4
commit 6bb1a2a311
34 changed files with 2600 additions and 5071 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
crates/brk_server/README.md
View File

@@ -4,8 +4,8 @@ HTTP API server for Bitcoin on-chain analytics.
## Features
- **OpenAPI spec**: Auto-generated docs at `/api` with full spec at `/api.json`
- **LLM-optimized**: Compact spec at `/api.trimmed.json` for AI tools
- **OpenAPI spec**: Auto-generated docs at `/api` with full spec at `/openapi.json`
- **LLM-optimized**: Compact spec at `/api.json` for AI tools
- **Response caching**: ETag-based with LRU cache (5000 entries)
- **Compression**: Brotli, gzip, deflate, zstd
- **Static files**: Optional web interface hosting
@@ -23,8 +23,8 @@ server.serve().await?;
| Path | Description |
|------|-------------|
| `/api` | Interactive API documentation |
| `/api.json` | Full OpenAPI specification |
| `/api.trimmed.json` | Compact OpenAPI for LLMs |
| `/openapi.json` | Full OpenAPI specification |
| `/api.json` | Compact OpenAPI for LLMs |
| `/api/address/{address}` | Address stats, transactions, UTXOs |
| `/api/block/{hash}` | Block info, transactions, status |
| `/api/block-height/{height}` | Block by height |