orda 0.1.0

Rust client library for the aoe4guides.com API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

# orda


Rust client library for the [aoe4guides.com](https://aoe4guides.com) API.

Orda provides a simple and type-safe interface for fetching build orders,
favorites, and other data from aoe4guides.com.

Internally, it wraps the public REST API using `reqwest` and `serde`.

## Features


- Optional civilization and sort filters
- Async-first API powered by `reqwest`
- Lightweight - no global runtime, compatible with any Tokio environment

## Install


Add **Orda** to your project using Cargo:

```bash
cargo add orda
```

Or manually in your `Cargo.toml`:

```toml
[dependencies]
orda = "0.1"
```

## Usage


```rust
use orda::{OrdaClient, Civilization, SortBy};

#[tokio::main]

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = OrdaClient::new();

    // Fetch API status
    let status = client.get_status().await?;

    println!("API status: {}", status.status);

    // Fetch the 10 most popular French builds
    let builds = client
        .get_builds(Civilization::Fre, Some(SortBy::Score), false)
        .await?;

    println!("Fetched {} builds", builds.len());

    // Fetch a single build by ID
    let build = client.get_build("00I7J47dv26cPbKmXYkO", false).await?;

    println!("Build title: {:?}", build.title);

    Ok(())
}

```

## Api overview


- `get_status()` => Returns the API status (always "running")
- `get_builds(civ, order_by, overlay)` => Fetches up to 10 build orders
- `get_build(id, overlay)` => Fetches a single build order by ID
- `get_favorites(user_id, civ, order_by, overlay)` => Fetches user favorites

## License


Licensed under the Apache 2.0 license.

See the [LICENSE](./LICENSE) file for details