readwhitepaper 0.1.0

Rust client for ReadWhitepaper — blockchain whitepaper database with 30 whitepapers, 163 glossary terms, and 15-language translations
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

# readwhitepaper

[![Crates.io](https://img.shields.io/crates/v/readwhitepaper)](https://crates.io/crates/readwhitepaper)
[![docs.rs](https://docs.rs/readwhitepaper/badge.svg)](https://docs.rs/readwhitepaper)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

Rust client for the [ReadWhitepaper](https://readwhitepaper.com) API — a blockchain whitepaper database hosting 30 cryptocurrency whitepapers with section-level content, 163 glossary terms, full-text search, and 3,458 translations across 15 languages. Async, fully typed, powered by reqwest + serde.

> **Explore the whitepapers at [readwhitepaper.com](https://readwhitepaper.com)** — [Bitcoin Whitepaper](https://readwhitepaper.com/bitcoin/), [Ethereum Whitepaper](https://readwhitepaper.com/ethereum/), [API Docs](https://readwhitepaper.com/developers/)

## Install

```toml
[dependencies]
readwhitepaper = "0.1"
tokio = { version = "1", features = ["full"] }
```

## Quick Start

```rust
use readwhitepaper::ReadWhitepaperClient;

#[tokio::main]
async fn main() -> Result<(), readwhitepaper::Error> {
    let client = ReadWhitepaperClient::new();

    // List all 30 cryptocurrency whitepapers
    let whitepapers = client.list_whitepapers(None, None, None).await?;
    for wp in &whitepapers.results {
        println!("{} — {} ({})", wp.crypto.ticker, wp.authors[0], wp.year);
        // BTC — Satoshi Nakamoto (2008)
        // ETH — Vitalik Buterin (2013)
    }

    // Read Bitcoin's whitepaper section by section
    let bitcoin = client.get_whitepaper("bitcoin", None).await?;
    for section in &bitcoin.sections {
        println!("§{}: {}", section.section_number, section.heading_text);
    }

    // Search across all whitepapers for a concept
    let results = client.search("proof of work", None, None).await?;
    for r in &results {
        println!("{} — {}: {}", r.slug, r.heading, r.snippet);
    }

    // Get the blockchain glossary
    let glossary = client.list_glossary(Some(5), None, None).await?;
    for term in &glossary.results {
        println!("{} [{}] — appears {}x", term.term, term.category, term.occurrence_count);
    }

    Ok(())
}
```

## What You'll Find on ReadWhitepaper

ReadWhitepaper hosts the foundational documents of 30 major cryptocurrencies. A cryptocurrency whitepaper is the primary technical document describing a blockchain protocol's design, consensus mechanism, and economic model. The tradition began with Satoshi Nakamoto's 2008 Bitcoin whitepaper.

| Rank | Ticker | Author(s) | Year | Sections |
|------|--------|-----------|------|----------|
| 1 | BTC | Satoshi Nakamoto | 2008 | 14 |
| 2 | ETH | Vitalik Buterin | 2013 | 23 |
| 3 | USDT | J.R. Willett | 2016 | 10 |
| 4 | XRP | D. Schwartz, N. Youngs, A. Britto | 2014 | 11 |
| 5 | SOL | Anatoly Yakovenko | 2017 | 12 |

163 blockchain glossary terms across 12 categories, 15-language translations with 3,458 individual translations, and a whitepaper relationship graph.

## API Methods

| Method | Description |
|--------|-------------|
| `list_whitepapers(limit, page, language)` | List all 30 whitepapers |
| `get_whitepaper(slug, language)` | Get whitepaper detail with sections |
| `get_sections(slug, language)` | Get sections only |
| `get_toc(slug, language)` | Get table of contents |
| `get_coverage(slug)` | Get translation coverage |
| `list_glossary(limit, page, language)` | List 163 glossary terms |
| `get_glossary_term(slug, language)` | Get term detail |
| `search(query, slug, language)` | Full-text search |
| `get_stats()` | Platform statistics |
| `get_languages()` | Supported languages |
| `get_graph()` | Relationship graph |

## Learn More About Blockchain Whitepapers

- **Read**: [Bitcoin Whitepaper](https://readwhitepaper.com/bitcoin/) . [Ethereum Whitepaper](https://readwhitepaper.com/ethereum/) . [All Whitepapers](https://readwhitepaper.com/)
- **Explore**: [Blockchain Glossary](https://readwhitepaper.com/glossary/) . [Whitepaper Graph](https://readwhitepaper.com/graph/)
- **API**: [REST API Docs](https://readwhitepaper.com/developers/)

## Also Available

| Platform | Package | Install |
|----------|---------|---------|
| **PyPI** | [readwhitepaper](https://pypi.org/project/readwhitepaper/) | `pip install readwhitepaper` |
| **npm** | [readwhitepaper](https://www.npmjs.com/package/readwhitepaper) | `npm install readwhitepaper` |
| **Go** | [readwhitepaper-go](https://github.com/dobestan/readwhitepaper-go) | `go get github.com/dobestan/readwhitepaper-go` |
| **Ruby** | [readwhitepaper](https://rubygems.org/gems/readwhitepaper) | `gem install readwhitepaper` |

## License

MIT