{"id":17347353,"url":"https://github.com/janasunrise/hypixelio","last_synced_at":"2025-04-13T11:52:03.717Z","repository":{"id":37086531,"uuid":"305100532","full_name":"janaSunrise/HypixelIO","owner":"janaSunrise","description":"A Modern Efficient and Easy way of interacting with the Hypixel API!","archived":false,"fork":false,"pushed_at":"2024-08-30T14:20:20.000Z","size":1660,"stargazers_count":16,"open_issues_count":8,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-10T19:47:35.328Z","etag":null,"topics":["hacktoberfest","hypixel","hypixel-api","hypixel-stats","minecraft","pypi","python","python3"],"latest_commit_sha":null,"homepage":"https://hypixelio.rtfd.io","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/janaSunrise.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2020-10-18T12:49:50.000Z","updated_at":"2024-01-24T22:10:49.000Z","dependencies_parsed_at":"2024-10-31T20:02:37.942Z","dependency_job_id":"2ca5666e-8b6d-40e0-9aaf-0b61f93ac850","html_url":"https://github.com/janaSunrise/HypixelIO","commit_stats":{"total_commits":675,"total_committers":4,"mean_commits":168.75,"dds":0.4444444444444444,"last_synced_commit":"388ebcc145e754639daafb0811d709c87b2ef3e6"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/janaSunrise%2FHypixelIO","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/janaSunrise%2FHypixelIO/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/janaSunrise%2FHypixelIO/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/janaSunrise%2FHypixelIO/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/janaSunrise","download_url":"https://codeload.github.com/janaSunrise/HypixelIO/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248710438,"owners_count":21149188,"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":["hacktoberfest","hypixel","hypixel-api","hypixel-stats","minecraft","pypi","python","python3"],"created_at":"2024-10-15T16:48:28.176Z","updated_at":"2025-04-13T11:52:03.695Z","avatar_url":"https://github.com/janaSunrise.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"```\n                      __  __            _           __   ________\n                     / / / /_  ______  (_)  _____  / /  /  _/ __ \\\n                    / /_/ / / / / __ \\/ / |/_/ _ \\/ /   / // / / /\n                   / __  / /_/ / /_/ / /\u003e  \u003c/  __/ /  _/ // /_/ /\n                  /_/ /_/\\__, / .___/_/_/|_|\\___/_/  /___/\\____/\n                        /____/_/\n```\n\n\u003ch1 align=\"center\"\u003eHypixelIO\u003c/h1\u003e\n\n\u003ch3 align=\"center\"\u003eA Modern, Efficient and Easy way of interacting with the Hypixel API!\u003c/h3\u003e\n\n\u003cp align=\"center\"\u003e\n\n\u003ca href=\"https://www.python.org/\"\u003e\n    \u003cimg src=\"http://ForTheBadge.com/images/badges/made-with-python.svg\" alt=\"Made with Python\" /\u003e\n\u003c/a\u003e\n\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\n\u003ca href=\"https://pypi.org/project/HypixelIO\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/l/HypixelIO\" alt=\"PYPI - License\" /\u003e\n\u003c/a\u003e\n\n\u003ca href=\"https://pypi.org/project/HypixelIO\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/dm/ansicolortags.svg\" alt=\"PYPI Download per Month\" /\u003e\n\u003c/a\u003e\n\n\u003ca href=\"https://pypi.org/project/HypixelIO\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/v/HypixelIO\" alt=\"PYPI\" /\u003e\n\u003c/a\u003e\n\n\u003ca href=\"https://pypi.org/project/HypixelIO\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/pyversions/HypixelIO\" alt=\"PYPI Python Version\" /\u003e\n\u003c/a\u003e\n\n\u003ca href=\"https://GitHub.com/janaSunrise/HypixelIO/graphs/commit-activity\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Maintained%3F-yes-green.svg\" alt=\"Maintenance\" /\u003e\n\u003c/a\u003e\n\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\n\u003ca href=\"https://github.com/janaSunrise/HypixelIO\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/languages/code-size/janaSunrise/HypixelIO\" alt=\"Code Size\" /\u003e\n\u003c/a\u003e\n\n\u003ca href=\"https://discord.gg/MKC4qna4Gz\"\u003e\n    \u003cimg src=\"https://discordapp.com/api/guilds/835940276869791816/widget.png?style=shield\" alt=\"Discord\" /\u003e\n\u003c/a\u003e\n\n\u003c/p\u003e\n\n\u003c!-- Links --\u003e\n\u003ch3 align=\"center\"\u003e\n  \u003ca href=\"https://hypixelio.readthedocs.org\"\u003eDocs\u003c/a\u003e\n  \u003cspan\u003e · \u003c/span\u003e\n  \u003ca href=\"https://github.com/janaSunrise/HypixelIO/issues\"\u003eReport a bug\u003c/a\u003e\n  \u003cspan\u003e · \u003c/span\u003e\n  \u003ca href=\"https://github.com/janaSunrise/HypixelIO/discussions\"\u003eDiscussions\u003c/a\u003e\n  \u003cspan\u003e · \u003c/span\u003e\n  \u003ca href=\"https://discord.gg/MKC4qna4Gz\"\u003eDiscord\u003c/a\u003e\n\u003c/h3\u003e\n\n## ✨ Why choose HypixelIO?\n\n- Modern way of handling requests\n- Modern OOP based structure\n- Both Async and blocking support\n- Simple ratelimit handling and caching\n- Elegant design with complete optimization\n- Easy to use with a modern and simple design\n- Complete API coverage\n\n## 🚀 Installing\n\n**Python 3.7 or above is required!**\n\n```sh\n# Windows\npy -3 -m pip install -U HypixelIO\n\n# Linux or MacOS\npython3 -m pip install -U HypixelIO\n\n# Install the nightly build\npython3 -m pip install -U git+https://github.com/janaSunrise/HypixelIO\n```\n\nYou can also get extra features with this library. Here's how:\n\n```sh\n# Use [speedups] to speed up only for async API\npython3 -m pip install -U \"HypixelIO[speedups]\"\n```\n\n## Usage\n\n```python\nfrom hypixelio import Client, Converters\n\nclient = Client(api_key=\"your-api-key\")\n\nboosters = client.get_boosters()  # Get the boosters object\n\nfriends = client.get_friends(uuid=\"user's-uuid\")  # Returns the Friends object\n# Or, if you don't know the UUID\nfriends = client.get_friends(name=\"user's-username\")\n\nprint(boosters[0].id)\nprint(friends.friends[0].receiver_id)\n```\n\n### Async API usage\n\n```python\nimport asyncio\n\nfrom hypixelio import AsyncClient, AsyncConverters\n\nclient = AsyncClient(api_key=\"your-api-key\")\n\n# Async function to fetch info\nasync def fetch_from_hypixel():\n    boosters = await client.get_boosters()  # Get the boosters object\n\n    friends = await client.get_friends(uuid=\"user's-uuid\")  # Returns the Friends object\n    # Or, if you don't know the UUID\n    friends = await client.get_friends(name=\"user's-username\")\n\n    # Safely close the connection\n    await client.close()\n\n    return boosters, friends\n\n# Run the coroutine using `asyncio`\nboosters, friends = asyncio.run(fetch_from_hypixel())\n\nprint(boosters[0].id)\nprint(friends.friends[0].receiver_id)\n```\n\n**Find more examples [here](https://github.com/janaSunrise/HypixelIO/tree/main/examples)!**\n\n## 📢 Changelog\n\nIf you're interested in seeing the **Changelog**, Go [here!](https://github.com/janaSunrise/HypixelIO/blob/main/CHANGELOG.md)\n\n## 🤝 Contributing\n\nContributions, issues and feature requests are welcome. After cloning \u0026 setting up project locally, you can just submit\na PR to this repo and it will be deployed once it's accepted.\n\n⚠️ It’s good to have descriptive commit messages, or PR titles so that other contributors can understand about your\ncommit or the PR Created. Read [conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.3/) before\nmaking the commit message. You can find our contributing guidelines\n[here](https://github.com/janaSunrise/HypixelIO/blob/main/CONTRIBUTING.md)\n\nWe have a branch called `dev` containing development code. If you're contributing, Remember to contribute to\n`dev` branch, instead of `main`.\n\n## 💬 Get in touch\n\nIf you have various suggestions, questions or want to discuss things with our community, Have a look at\n[Github discussions](https://github.com/janaSunrise/HypixelIO/discussions) or join our Discord server!\n\n[![Discord](https://discordapp.com/api/guilds/835940276869791816/widget.png?style=shield)](https://discord.gg/MKC4qna4Gz)\n\n## 👋 Show your support\n\nBe sure to drop a 🌟 if you like the project!\n\n## ▶ Links\n\n- [Official Documentation](http://hypixelio.rtfd.io/)\n- [Raise an Issue](https://github.com/janaSunrise/HypixelIO/issues)\n- [Discussions](https://github.com/janaSunrise/HypixelIO/discussions)\n- [Hypixel API Documentation](https://api.hypixel.net)\n\n\u003cdiv align=\"center\"\u003eMade by Sunrit Jana with ❤\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjanasunrise%2Fhypixelio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjanasunrise%2Fhypixelio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjanasunrise%2Fhypixelio/lists"}