brk_client 0.1.0-alpha.3

Rust client for the Bitcoin Research Kit API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

# brk_client

Rust client for the [Bitcoin Research Kit](https://github.com/bitcoinresearchkit/brk) API.

[crates.io](https://crates.io/crates/brk_client) | [docs.rs](https://docs.rs/brk_client)

## Installation

```toml
[dependencies]
brk_client = "0.1"
```

## Quick Start

```rust
use brk_client::{BrkClient, Index};

fn main() -> brk_client::Result<()> {
    let client = BrkClient::new("http://localhost:3110");

    // Blockchain data (mempool.space compatible)
    let block = client.get_block_by_height(800000)?;
    let tx = client.get_tx("abc123...")?;
    let address = client.get_address("bc1q...")?;

    // Metrics API - typed, chainable
    let prices = client.metrics()
        .price.usd.split.close
        .by.dateindex()
        .range(Some(-30), None)?; // Last 30 days

    // Generic metric fetching
    let data = client.get_metric(
        "price_close".into(),
        Index::DateIndex,
        Some(-30), None, None, None,
    )?;

    Ok(())
}
```

## Configuration

```rust
use brk_client::{BrkClient, BrkClientOptions};

let client = BrkClient::with_options(BrkClientOptions {
    base_url: "http://localhost:3110".to_string(),
    timeout_secs: 60,
});
```