hypixel-sdk 0.2.1

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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

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

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

/// A SkyBlock auction, as returned by `skyblock/auction` and `skyblock/auctions`.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct SkyBlockAuction {
    #[serde(rename = "_id", default)]
    pub id: String,
    #[serde(default)]
    pub uuid: String,
    #[serde(default)]
    pub auctioneer: String,
    #[serde(default)]
    pub profile_id: String,
    #[serde(default)]
    pub coop: Vec<String>,
    #[serde(default)]
    pub start: i64,
    #[serde(default)]
    pub end: i64,
    #[serde(default)]
    pub item_name: String,
    #[serde(default)]
    pub item_lore: String,
    #[serde(default)]
    pub category: String,
    #[serde(default)]
    pub tier: String,
    #[serde(default)]
    pub starting_bid: i64,
    /// The auctioned item serialized as a base64+gzip NBT blob.
    #[serde(default)]
    pub item_bytes: Value,
    #[serde(default)]
    pub claimed: bool,
    #[serde(default)]
    pub highest_bid_amount: i64,
    #[serde(default)]
    pub bin: bool,
    #[serde(default)]
    pub bids: Vec<Value>,
    #[serde(flatten)]
    pub extra: JsonObject,
}

/// One page of the global active-auctions listing from `skyblock/auctions`.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct AuctionsPage {
    #[serde(default)]
    pub page: i64,
    #[serde(rename = "totalPages", default)]
    pub total_pages: i64,
    #[serde(rename = "totalAuctions", default)]
    pub total_auctions: i64,
    #[serde(rename = "lastUpdated", default)]
    pub last_updated: i64,
    #[serde(default)]
    pub auctions: Vec<SkyBlockAuction>,
}

/// A recently completed auction, as returned by `skyblock/auctions_ended`.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct EndedAuction {
    #[serde(default)]
    pub auction_id: String,
    #[serde(default)]
    pub seller: String,
    #[serde(default)]
    pub seller_profile: String,
    #[serde(default)]
    pub buyer: String,
    #[serde(default)]
    pub buyer_profile: Option<String>,
    #[serde(default)]
    pub timestamp: i64,
    #[serde(default)]
    pub price: i64,
    #[serde(default)]
    pub bin: bool,
    /// The sold item serialized as a base64+gzip NBT blob.
    #[serde(default)]
    pub item_bytes: String,
    #[serde(flatten)]
    pub extra: JsonObject,
}

#[derive(Debug, Clone, Deserialize)]
pub(crate) struct AuctionResponse {
    #[serde(default)]
    pub auctions: Vec<SkyBlockAuction>,
}

#[derive(Debug, Clone, Deserialize)]
pub(crate) struct EndedAuctionsResponse {
    #[serde(default)]
    pub auctions: Vec<EndedAuction>,
}