Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Builder for Client.

Implementations

impl ClientBuilder

pub fn base_url(self, url: impl Into<String>) -> Self

Override the API origin (default https://bitculator.com).

Examples found in repository

examples/quickstart.rs (line 15)

fn main() -> Result<(), Error> {
    let key = std::env::var("BITCULATOR_API_KEY").unwrap_or_default();
    let base =
        std::env::var("BITCULATOR_BASE_URL").unwrap_or_else(|_| "https://bitculator.com".into());
    let client = Client::builder(key).base_url(base).build();

    client.meta().ping::<Value>()?;

    // Single resource, decoded as generic JSON (or bring your own type).
    let bitcoin: Value = client.coins().get("bitcoin", Params::new())?;
    println!("BTC price: {}", bitcoin["price"]); // decimal string, never rounded

    // Top 5 coins by marketcap.
    let page: Page<Value> = client
        .coins()
        .list(Params::new().set("per_page", 5).set("sort", "-marketcap"))?;
    for coin in &page.data {
        println!("#{} {} {}", coin["rank"], coin["symbol"], coin["price"]);
    }

    // Auto-paginate the first ~40 gainers.
    let gainers: Page<Value> = client.coins().gainers(Params::new().set("per_page", 20))?;
    for (i, item) in gainers.auto_paging().enumerate() {
        let coin = item?;
        println!("gainer: {}", coin["symbol"]);
        if i >= 39 {
            break;
        }
    }

    println!("quota: {:?}", client.quota());
    Ok(())
}

pub fn timeout(self, timeout: Duration) -> Self

Set the per-request timeout (default 30s).

pub fn max_retries(self, retries: u32) -> Self

Set the number of automatic retries for 429/5xx/network errors (default 2).

pub fn user_agent(self, ua: impl Into<String>) -> Self

Override the User-Agent header.

pub fn build(self) -> Client

Build the client.

Panics

Panics if the API key is empty — a misconfigured key should fail at construction, not on the first request.

Examples found in repository

examples/quickstart.rs (line 15)

fn main() -> Result<(), Error> {
    let key = std::env::var("BITCULATOR_API_KEY").unwrap_or_default();
    let base =
        std::env::var("BITCULATOR_BASE_URL").unwrap_or_else(|_| "https://bitculator.com".into());
    let client = Client::builder(key).base_url(base).build();

    client.meta().ping::<Value>()?;

    // Single resource, decoded as generic JSON (or bring your own type).
    let bitcoin: Value = client.coins().get("bitcoin", Params::new())?;
    println!("BTC price: {}", bitcoin["price"]); // decimal string, never rounded

    // Top 5 coins by marketcap.
    let page: Page<Value> = client
        .coins()
        .list(Params::new().set("per_page", 5).set("sort", "-marketcap"))?;
    for coin in &page.data {
        println!("#{} {} {}", coin["rank"], coin["symbol"], coin["price"]);
    }

    // Auto-paginate the first ~40 gainers.
    let gainers: Page<Value> = client.coins().gainers(Params::new().set("per_page", 20))?;
    for (i, item) in gainers.auto_paging().enumerate() {
        let coin = item?;
        println!("gainer: {}", coin["symbol"]);
        if i >= 39 {
            break;
        }
    }

    println!("quota: {:?}", client.quota());
    Ok(())
}