{"id":20526071,"url":"https://github.com/feromond/hypixel-api-lib","last_synced_at":"2026-02-14T05:07:07.210Z","repository":{"id":258792905,"uuid":"875386449","full_name":"Feromond/hypixel-api-lib","owner":"Feromond","description":"A python library to easily interact with the hypixel-api (initially sky block focused). ","archived":false,"fork":false,"pushed_at":"2025-01-01T10:21:15.000Z","size":239,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-14T04:14:30.431Z","etag":null,"topics":["api","hypixel","hypixel-api","hypixel-skyblock","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Feromond.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-19T20:46:07.000Z","updated_at":"2025-01-01T10:21:16.000Z","dependencies_parsed_at":"2024-11-13T18:22:27.268Z","dependency_job_id":"63960eed-f1f7-434c-acc1-d1787073947e","html_url":"https://github.com/Feromond/hypixel-api-lib","commit_stats":null,"previous_names":["feromond/hypixel-api-lib"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Feromond%2Fhypixel-api-lib","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Feromond%2Fhypixel-api-lib/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Feromond%2Fhypixel-api-lib/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Feromond%2Fhypixel-api-lib/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Feromond","download_url":"https://codeload.github.com/Feromond/hypixel-api-lib/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248819408,"owners_count":21166477,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","hypixel","hypixel-api","hypixel-skyblock","python"],"created_at":"2024-11-15T23:12:14.097Z","updated_at":"2026-02-14T05:07:02.166Z","avatar_url":"https://github.com/Feromond.png","language":"Python","readme":"\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n\u003cbr /\u003e \n\u003cdiv align=\"center\"\u003e \n\u003ch3 align=\"center\"\u003eHypixel-Api-Lib\u003c/h3\u003e \n\u003cp align=\"center\"\u003e A Python library for interacting with the Hypixel SkyBlock API.\n\u003cbr /\u003e \n\u003ca href=\"https://github.com/Feromond/hypixel-api-lib\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e \u003cbr /\u003e \n\u003cbr /\u003e \n\u003ca href=\"https://github.com/Feromond/hypixel-api-lib/issues\"\u003eReport Bug\u003c/a\u003e · \u003ca href=\"https://github.com/Feromond/hypixel-api-lib/issues\"\u003eRequest Feature\u003c/a\u003e \u003c/p\u003e \u003c/div\u003e \n\u003cdetails\u003e \n\u003csummary\u003eTable of Contents\u003c/summary\u003e \n\u003col\u003e \u003cli\u003e \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e \u003c/li\u003e \u003cli\u003e\n\u003ca href=\"#directory-information\"\u003eDirectory Information\u003c/a\u003e\u003c/li\u003e \u003cul\u003e \u003cli\u003e\n\u003ca href=\"#hypixel-api-lib\"\u003ehypixel-api-lib/\u003c/a\u003e\u003c/li\u003e \n\u003cli\u003e\u003ca href=\"#tests\"\u003etests/\u003c/a\u003e\u003c/li\u003e \n\u003cli\u003e\u003ca href=\"#examples\"\u003eexamples/\u003c/a\u003e\u003c/li\u003e \n\u003cli\u003e\u003ca href=\"#root-files\"\u003eRoot Files\u003c/a\u003e\u003c/li\u003e \u003c/ul\u003e \n\u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt With\u003c/a\u003e\u003c/li\u003e \n\u003cli\u003e \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e \u003cul\u003e \n\u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e \n\u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \n\u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e \n\u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e \n\u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e \u003c/ol\u003e \u003c/details\u003e\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n\n## About The Project\n\n`hypixel-api-lib` is a Python library that provides an easy-to-use interface for interacting with the Hypixel SkyBlock API. It simplifies the process of fetching and processing data from the API, allowing developers to focus on building applications and tools for the Hypixel SkyBlock community.\n\nThe library includes components for accessing player profiles, game statistics, items, skills, and events like the current Bingo event. It handles API requests, data parsing, and provides convenient classes and methods to work with the data.\n\nOur goal with `hypixel-api-lib` is to create a comprehensive and efficient library for developers to build rich applications, bots, or analytics tools related to Hypixel SkyBlock.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## Directory Information\n\n### **hypixel_api_lib/**\n\n```sh\nhypixel_api_lib/\n├── __init__.py\n├── Elections.py\n├── Collections.py\n├── Items.py\n├── Skills.py\n└── etc.... (more in-progress)\n```\n\nThis is the core of the library, containing all the modules and packages that implement the API interactions and data models.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### **tests/**\n\n```sh\ntests/\n├── test_bingo.py\n├── test_items.py\n├── test_skills.py\n└── ... etc ...\n```\n\nThis directory contains all the unit tests for the library modules, ensuring code quality and correctness. Each test file corresponds to a module in the library.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### **examples/**\n\n```sh\nexamples/\n├── bingo_example.py\n├── items_example.py\n├── skills_example.py\n└── ... etc ...\n```\n\nThis directory contains all the example code for this library. Each component has some sample code included that demonstrates how it could be used and some generate structure. Still largely a work in progress.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### **Root Files**\n\n```sh\n.\n├── LICENSE            # None set yet\n├── README.md          # This file\n├── .gitignore         # Files to ignore during our git process\n├── .env               # (Will be gitignored) File to store environment vairables such as API keys for examples.\n├── Makefile           # Commands for building, initializing, and other tasks\n├── requirements.txt   # Lists the Python package dependencies\n├── setup.py           # Setup script for packaging and distribution\n├── examples/\n├── hypixel_api_lib/\n└── tests/\n\n```\n\nThe root directory includes important files for building and managing the project.\n\n- Makefile: Simplifies common tasks such as building the package or installing requirements.\n\n- requirements.txt: Specifies the required Python packages.\n\n- setup.py: Used for packaging and distributing the library.\n\n- LICENSE: Contains the license information for the project.\n\n- README.md: Provides an overview and documentation of the project.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## Built With\n\n![](https://img.shields.io/badge/Code-Python-informational?style=flat\u0026logo=Python\u0026logoColor=white\u0026color=4AB197)\n![](https://img.shields.io/badge/Package-Requests-informational?style=flat\u0026logo=Requests\u0026logoColor=white\u0026color=4AB197)\n![](https://img.shields.io/badge/Package-Pandas-informational?style=flat\u0026logo=Pandas\u0026logoColor=white\u0026color=4AB197)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n\n## Getting Started\n\nTo get a local copy up and running, follow these simple steps.\n\n### Prerequisites\n\nPython 3.12 or higher\n\nGit (for cloning the repository)\n\n### Installation\n\n1. Clone the repository\n\n   ```sh\n   git clone https://github.com/Feromond/hypixel-api-lib.git\n   cd hypixel-api-lib\n   ```\n\n2. Install the required packages and setup venv\n\n   ```make\n   make init\n   ```\n\n3. Install the library\n\n   In editable mode:\n\n   ```make\n   make build_local\n   ```\n\n      \u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- USAGE EXAMPLES --\u003e\n\n## Usage\n\nHere we will describe how to use `Hypixel-Api-Lib`, including examples of how to import and utilize the library's functions in your own projects.\n\n### Fetching the Current Bingo Event\n\n```Python\nfrom hypixel_api_lib import BingoEvents\n\n# Initialize the BingoEvents manager\nbingo_events = BingoEvents()\n\n# Get the current bingo event\ncurrent_event = bingo_events.get_current_event()\n\n# Print event details\nprint(f\"Bingo Event: {current_event.name} (ID: {current_event.id})\")\nprint(f\"Modifier: {current_event.modifier}\")\n\n```\n\n### Retrieving Item Information\n\n```Python\nfrom hypixel_api_lib import Items\n\n# Initialize the Items manager\nitems = Items()\n\n# Get item details by item ID\nitem_id = 'ASPECT_OF_THE_END'\nitem = items.get_item_by_id(item_id)\n\n# Print item information\nprint(f\"Item Name: {item.name}\")\nprint(f\"Description: {item.get_clean_lore()}\")\n\n```\n\nFor more examples and usage instructions, please refer to the documentation or check out the `examples/` folder for more full code examples\n\n\u003c!-- ROADMAP --\u003e\n\n## Roadmap\n\n- [x] Set up project structure and initial modules\n- [ ] Implement core components (Bingo, Items, Skills, Profiles etc...)\n- [ ] Write unit tests for core modules\n- [ ] Expand documentation with examples and tutorials\n- [ ] Publish package to PyPI\n- [ ] Add support for additional API endpoints outside skyblock\n- [ ] Improve existing code to support future developer experiences\n\nSee the [open issues](https://github.com/Feromond/hypixel-api-lib/issues) for a full list of proposed features (and known issues).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTACT --\u003e\n\n## Contact\n\nJacob Mish - [Portfolio](https://jacobmish.com) - [LinkedIn](https://www.linkedin.com/in/jacob-mish-25915722a/) - JacobPMish@gmail.com\n\nDesmond O'Brien- [LinkedIn](https://www.linkedin.com/in/des-ob/) - desmond.obrien@ucalgary.ca\n\nProject Link: [https://github.com/Feromond/hypixel-api-lib](https://github.com/Feromond/hypixel-api-lib)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fferomond%2Fhypixel-api-lib","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fferomond%2Fhypixel-api-lib","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fferomond%2Fhypixel-api-lib/lists"}