hypixel/lib.rs
1//! Asynchronous Rust client for the [Hypixel Public API](https://api.hypixel.net),
2//! with a focus on SkyBlock.
3//!
4//! # Example
5//!
6//! ```no_run
7//! # async fn run() -> hypixel::Result<()> {
8//! let client = hypixel::HypixelClient::new("YOUR-API-KEY");
9//! let bazaar = client.skyblock_bazaar().await?;
10//! println!("{} products", bazaar.products.len());
11//! # Ok(())
12//! # }
13//! ```
14//!
15//! Keyed endpoints require an API key from the
16//! [Developer Dashboard](https://developer.hypixel.net); the keyless endpoints
17//! (`resources/*` and the SkyBlock `auctions`, `auctions_ended`, `bazaar`,
18//! `firesales`, and `news` endpoints) work with
19//! [`HypixelClient::unauthenticated`].
20
21mod client;
22mod endpoints;
23mod error;
24pub mod models;
25mod ratelimit;
26pub mod util;
27
28pub use client::{ClientBuilder, HypixelClient};
29pub use error::{Error, Result};
30pub use ratelimit::RateLimit;