Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 1.76 KB

README.md

File metadata and controls

53 lines (41 loc) · 1.76 KB

helium-api

An async library to access the public Helium blockchain REST API.

Crates.io docs.rs Build Status Discord chat

Overview

The Helium API is a REST API service as defined by the blockhain-http service. This library attempts to wrap this API in an async, easy to use library that supports the conventions as exposed by the API. This includes:

  • Modular access to each of the main areas of the Helium API
  • Support for lazily fetched paged responses

Contributions and helpful suggestions are always welcome

Example

Create a client to the default api.helium.io endpoint and ask for a given account.

use helium_api::*;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::default();
    let account = accounts::get(
        &client,
        "13buBykFQf5VaQtv7mWj2PBY9Lq4i1DeXhg7C4Vbu3ppzqqNkTH",
    )
    .await?;
    println!("Account: {:?}", account);
    Ok(())
}

See the examples folder and unit tests for more examples.