rs-pixel 
A complete, rate-limiting, asynchronous Rust implementation of the Hypixel Public API with extensive SkyBlock support.
[dependencies]
rs-pixel = "0.1.0"
Getting started
You will need a Hypixel Api Key to access most endpoints (official documentation).
Creating an Instance
Use the default configuration
let mut api = RsPixel::new("API KEY").await.unwrap();
Or configure the client, Minecraft username/UUID API type, and the rate limit strategy
let config = ConfigBuilder::default()
.client(surf::Config::new().try_into().unwrap())
.minecraft_api_type(ApiType::PlayerDb)
.rate_limit_strategy(RateLimitStrategy::Error)
.into();
let mut api = RsPixel::from_config("API KEY", config).await.unwrap();
Examples
Print a player's name and rank
let response = api.get_player_by_username("USERNAME").await.unwrap();
println!(
"{} has the {} rank",
response.get_name().unwrap(),
response.get_rank()
);
Print a skyblock player's statistics
let response = api.get_skyblock_profiles_by_name("USERNAME").await.unwrap();
let profile = response.get_last_played_profile().unwrap();
println!(
"Enderman Slayer XP: {}\nCombat Skill Level: {}\nCatacombs LeveL: {}",
profile.get_slayer("enderman").unwrap().current_exp,
profile.get_skill("combat").unwrap().level,
profile.get_catacombs().unwrap().level
);
Print a skyblock player's inventory contents (NBT parsed to JSON)
let response = api.get_skyblock_profiles_by_uuid("uuid").await.unwrap();
let profile = response.get_last_played_profile().unwrap();
println!("Inventory Contents: {}", profile.get_inventory().unwrap());
Get the first page and print the first auction
let response = api.get_skyblock_auctions(0).await.unwrap();
let auction = response.auctions.get(0).unwrap();
println!(
"The starting bid for a {} is {} coins",
auction.item_name, auction.starting_bid
);
Todo
- Documentation
- More examples
License & Contributing
Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
5 Jan 2, 2023
5 Nov 3, 2022
5 Mar 2, 2023
264 Dec 9, 2022
3.5k Jan 9, 2023
1.2k Dec 30, 2022
79 Dec 9, 2022
32 Nov 17, 2021
258 Dec 5, 2022
1.7k Dec 31, 2022
323 Dec 27, 2022
429 Dec 29, 2022
42 Dec 29, 2022
20 Jul 7, 2022
246 Jan 8, 2023
14 Dec 30, 2022
3 Sep 23, 2021
22 Dec 6, 2022
2.3k Dec 27, 2022