Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.82 KB

README.md

File metadata and controls

41 lines (29 loc) · 1.82 KB

tankerkoenig-rs

GitHub license Crates.io docs.rs Main codecov

API wrapper for the tankerkoenig-api written in rust.

The API of tankerkoenig gives you realtime fuel prices for germany with Creative Commons License. This rust wrapper provides you ready deserialized structs and an easy to use and strictly typed api.

Installation

This crate is under development. Especially the response parsing needs some more testing. However, if you still want to use it, you can install it by adding this to your Cargo.toml:

[dependencies]
tankerkoenig = "0.2.0"
# If you want to use the latest unreleased version:
tankerkoenig = { git = "https://github.com/jontze/tankerkoenig-rs" }

Requirements

  1. Api Token for the tankerkoenig-api
  2. Async runtime like tokio

Quickstart

use tankerkoenig::Tankerkoenig;
use tankerkoenig::models;

async fn request_station_details() -> Result<models::station::DetailsResponse, tankerkoenig::Error> {
    let tanker = Tankerkoenig::new("<your-api-key>")?;
    let details = tanker.station.fetch_details("id-of-a-fuel-station").await?;
     Ok(details)
}