Struct Meta 

pub struct Meta { /* private fields */ }

Service metadata: spec, health, and key usage.

Implementations

impl Meta

pub fn openapi<T: DeserializeOwned>(&self) -> Result<T, Error>

The raw OpenAPI specification for the API.

pub fn ping<T: DeserializeOwned>(&self) -> Result<T, Error>

Health check.

Examples found in repository

examples/quickstart.rs (line 17)

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 usage<T: DeserializeOwned>(&self) -> Result<T, Error>

Current key usage and quota.