readwhitepaper 0.1.1

Rust client for ReadWhitepaper — blockchain whitepaper database with 30 whitepapers, 163 glossary terms, and 15-language translations
Documentation

readwhitepaper

Crates.io docs.rs License: MIT

Rust client for the ReadWhitepaper 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.comBitcoin Whitepaper, Ethereum Whitepaper, API Docs

Install

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

Quick Start

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

Also Available

Platform Package Install
PyPI readwhitepaper pip install readwhitepaper
npm readwhitepaper npm install readwhitepaper
Go readwhitepaper-go go get github.com/dobestan/readwhitepaper-go
Ruby readwhitepaper gem install readwhitepaper

Embed Widget

Embed ReadWhitepaper widgets on any website with readwhitepaper-embed:

<script src="https://cdn.jsdelivr.net/npm/readwhitepaper-embed@1/dist/embed.min.js"></script>
<div data-readwhitepaper="entity" data-slug="example"></div>

Zero dependencies · Shadow DOM · 4 themes (light/dark/sepia/auto) · Widget docs

License

MIT