Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ignoremyburger/hypixel-wrapper
A Hypixel API wrapper to simplify getting data from Hypixel.
https://github.com/ignoremyburger/hypixel-wrapper
Last synced: 5 days ago
JSON representation
A Hypixel API wrapper to simplify getting data from Hypixel.
- Host: GitHub
- URL: https://github.com/ignoremyburger/hypixel-wrapper
- Owner: ignoremyburger
- Created: 2022-07-11T02:26:11.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-08-20T16:55:23.000Z (about 2 years ago)
- Last Synced: 2023-12-04T14:24:41.405Z (12 months ago)
- Language: Python
- Size: 15.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hypixel API Wrapper (HAW)
HAW is writen to simplify the process of gathering data from Hypixel
Installation
Step 1: Clone the repository. [ git clone https://github.com/buibaohoang06/hypixel-wrapper ]
Step 2: Move haw.py to your project folder.
Step 3: Go on to Hypixel to get your API Key by using command /api
Step 4: Import HypixelWrapper into your code and initialize it.
```python
from haw import HypixelWrapper
haw = HypixelWrapper(key="your Hypixel API Key", ign="your in-game name")
```
Modules
General Information | general_stat()
The General Information module returns a JSON string that contains the player's display name, rank, Hypixel level and total wins.
Example:
```python
from haw import HypixelWrapper
hw = HypixelWrapper("My API Key", "_Heartbr0ken_")
general_stat = hw.general_stat()
print(general_stat)
```
returns
```
{'name': '_Heartbr0ken_', 'rank': 'MVP++', 'level': 96, 'all_wins': 1136}
```
Bedwars | bedwars_stat()
The Bedwars module returns a JSON string that contains winstreak, losses, wins, beds_broken, total_kills.
Example:
```python
from haw import HypixelWrapper
hw = HypixelWrapper("My API Key", "_Heartbr0ken_")
bw_stat = hw.bedwars_stat()
print(bw_stat)
```
returns
```
{'status': 'success', 'game_mode': 'Bedwars', 'level': 145, 'total_games_played': 4100, 'details': [{'mode': 'solo', 'winstreak': 0, 'loses': 1160, 'wins': 176, 'beds_broken': 1509, 'total_kills': 2143}, {'mode': 'doubles', 'winstreak': 0, 'loses': 619, 'wins': 33, 'beds_broken': 254, 'total_kills': 1222}, {'mode': '3v3v3v3', 'winstreak': 0, 'loses': 232, 'wins': 27, 'beds_broken': 53, 'total_kills': 631}, {'mode': '4v4v4v4', 'winstreak': 0, 'loses': 1291, 'wins': 218, 'beds_broken': 375, 'total_kills': 4003}], 'beds_destroyed': 2218, 'wins': 486}
```
Skywars | skywars_stat()
The Skywars module returns a JSON string that contains the player's skywars level, number of cages owned, wins (solo and doubles), kits available (solo and doubles) and kills (solo and doubles)
Example:
```python
from haw import HypixelWrapper
hw = HypixelWrapper("My API Key", "_Heartbr0ken_")
sw_stat = hw.skywars_stat()
print(sw_stat)
```
returns
```
{'status': 'success', 'game_mode': 'Skywars', 'level': 9, 'cages_owned': 12, 'skywars_wins_solo': 135, 'skywars_kills_solo': 2493, 'skywars_kits_solo': 37, 'skywars_wins_team': 38, 'skywars_kills_team': 435, 'skywars_kits_team': 37}
```
Duels | duels_stat()
The Duels module returns a JSON string that contains the player's total games played, highest winstreak, wins, losses, current winstreak, total kills and coins.
Example:
```python
from haw import HypixelWrapper
hw = HypixelWrapper("My API Key", "_Heartbr0ken_")
duels_stat = hw.duels_stat()
print(duels_stat)
```
returns
```
{'status': 'success', 'game_mode': 'Duels', 'total_games_played': 2616, 'highest_winstreak': 10, 'wins': 834, 'loses': 1213, 'current_winstreak': 1, 'total_kills': 708, 'coins': 32242}
```
Further remarks
This project is still being developed, more modules will be added in the future. Feel free to contribute.
Contact Info
- Discord: affogato#2605
- E-Mail: [email protected]