hypixel-sdk 0.1.0

Async client for the Hypixel Public API with typed models and SkyBlock helpers
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
74
75
76
77
78
79
80
81
82
83
84

use std::collections::HashMap;

use serde::{Deserialize, Serialize};
use serde_json::Value;

use crate::models::common::JsonObject;

/// A SkyBlock profile, as returned by `skyblock/profile` and `skyblock/profiles`.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct SkyBlockProfile {
    pub profile_id: String,
    #[serde(default)]
    pub cute_name: Option<String>,
    #[serde(default)]
    pub selected: bool,
    #[serde(default)]
    pub game_mode: Option<String>,
    #[serde(default)]
    pub members: HashMap<String, SkyBlockMember>,
    #[serde(default)]
    pub banking: Option<Banking>,
    #[serde(default)]
    pub community_upgrades: Option<Value>,
    #[serde(flatten)]
    pub extra: JsonObject,
}

/// Co-op banking information for a [`SkyBlockProfile`].
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct Banking {
    #[serde(default)]
    pub balance: f64,
    #[serde(default)]
    pub transactions: Vec<Value>,
    #[serde(flatten)]
    pub extra: JsonObject,
}

/// A single member's data within a [`SkyBlockProfile`].
///
/// The member object is the deepest and most volatile part of the API. The
/// well-known top-level sections are exposed as raw JSON values (so callers can
/// navigate them without the SDK breaking on Hypixel's frequent additions), and
/// any further sections are preserved in [`extra`](Self::extra). Helpers in the
/// [`util`](crate::util) module operate on these sections, e.g. decoding the
/// base64+gzip NBT inventory blobs.
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct SkyBlockMember {
    #[serde(default)]
    pub player_id: Option<String>,
    #[serde(default)]
    pub player_data: Option<Value>,
    #[serde(default)]
    pub profile: Option<Value>,
    #[serde(default)]
    pub leveling: Option<Value>,
    #[serde(default)]
    pub currencies: Option<Value>,
    #[serde(default)]
    pub inventory: Option<Value>,
    #[serde(default)]
    pub pets_data: Option<Value>,
    #[serde(default)]
    pub dungeons: Option<Value>,
    #[serde(default)]
    pub slayer: Option<Value>,
    #[serde(default)]
    pub mining_core: Option<Value>,
    #[serde(default)]
    pub jacobs_contest: Option<Value>,
    #[serde(flatten)]
    pub extra: JsonObject,
}

#[derive(Debug, Clone, Deserialize)]
pub(crate) struct ProfileResponse {
    pub profile: Option<SkyBlockProfile>,
}

#[derive(Debug, Clone, Deserialize)]
pub(crate) struct ProfilesResponse {
    #[serde(default)]
    pub profiles: Option<Vec<SkyBlockProfile>>,
}