{"id":13723239,"url":"https://github.com/hyperevo/mee6-py-api","last_synced_at":"2025-05-07T16:32:29.377Z","repository":{"id":44878443,"uuid":"231155773","full_name":"hyperevo/mee6-py-api","owner":"hyperevo","description":null,"archived":false,"fork":false,"pushed_at":"2022-01-21T03:16:47.000Z","size":6,"stargazers_count":15,"open_issues_count":5,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-21T16:52:51.843Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/hyperevo.png","metadata":{"files":{"readme":"README.rst","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}},"created_at":"2019-12-31T23:16:41.000Z","updated_at":"2025-02-27T23:30:07.000Z","dependencies_parsed_at":"2022-07-21T15:00:17.886Z","dependency_job_id":null,"html_url":"https://github.com/hyperevo/mee6-py-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperevo%2Fmee6-py-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperevo%2Fmee6-py-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperevo%2Fmee6-py-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperevo%2Fmee6-py-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hyperevo","download_url":"https://codeload.github.com/hyperevo/mee6-py-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252915474,"owners_count":21824573,"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":[],"created_at":"2024-08-03T01:01:37.629Z","updated_at":"2025-05-07T16:32:24.359Z","avatar_url":"https://github.com/hyperevo.png","language":"Python","funding_links":[],"categories":["OTHERS"],"sub_categories":[],"readme":"====================\nMee6 Python API\n====================\n\n.. image:: https://img.shields.io/badge/python-3.6-blue.svg\n    :target: https://www.python.org/downloads/release/python-360/\n    :alt: Python3.6\n\n\n\nThis is the unofficial python API for mee6.\n\nThis implements the api as per the Mee6 API docs located here: https://github.com/SilBoydens/Mee6-api-docs\n\nThis API is asynchronous.\n\nInstallation\n============\n\n::\n\n    pip install mee6-py-api\n\nUsage\n=====\n\nFirst, import the package and create the API class. Replace your_guild_id with your guild id.\n\n\n.. code-block:: Python\n\n    from mee6_py_api import API\n    mee6API = API(your_guild_id)\n\nExamples\n~~~~~~~~~~~~~~~~~~~~~~~\n\nSee the tests folder for some functional examples\n\nGet a leaderboard page\n+++++++++++++++++++++++++\n\nLeaderboards are separated into pages of 100 users. Pages start at 0.\n\n.. code-block:: Python\n\n    leaderboard_page = await mee6API.levels.get_leaderboard_page(0)\n    print(leaderboard_page)\n\nExample of what it will return:\n\n::\n\n\n    {'admin': False,\n     'banner_url': None,\n     'guild': {'icon': 'd25eb4a577ab711df2e20b6b15158561',\n               'id': '446075987680165888',\n               'name': 'Helios Protocol',\n               'premium': False},\n     'page': 0,\n     'player': None,\n     'players': [\n                 {'avatar': 'e23737d84c718554c7894e2d3a827051',\n                  'detailed_xp': [1230, 1255, 7005],\n                  'discriminator': '9597',\n                  'guild_id': '446075987680165888',\n                  'id': '300302688346832897',\n                  'level': 11,\n                  'message_count': 350,\n                  'username': 'johnny',\n                  'xp': 7005},\n                 {'avatar': 'e7ec097ad84062ce77211b3393910d62',\n                  'detailed_xp': [832, 1255, 6607],\n                  'discriminator': '0098',\n                  'guild_id': '446075987680165888',\n                  'id': '450024877710245889',\n                  'level': 11,\n                  'message_count': 330,\n                  'username': 'timmy',\n                  'xp': 6607},\n                ...\n                 ],\n     'role_rewards': [{'rank': 10,\n                       'role': {'color': 6323595,\n                                'hoist': False,\n                                'id': '456256644905697283',\n                                'managed': False,\n                                'mentionable': False,\n                                'name': 'Active Community Member',\n                                'permissions': 104189505,\n                                'position': 14}},\n                      {'rank': 17,\n                       'role': {'color': 14051342,\n                                'hoist': True,\n                                'id': '456256766921932802',\n                                'managed': False,\n                                'mentionable': False,\n                                'name': 'Superstar',\n                                'permissions': 104189505,\n                                'position': 18}}],\n     'user_guild_settings': None,\n     'xp_per_message': [15, 25],\n     'xp_rate': 1.0}\n\nGet mee6 details of a user\n+++++++++++++++++++++++++++\n\nReplace user_id with your user id.\n\n.. code-block:: Python\n\n    details = await mee6API.levels.get_user_details(user_id)\n    print(details)\n\nExample of what it will return:\n\n::\n\n\n     {'avatar': 'e7ec097ad84062ce77211b3393910d62',\n      'detailed_xp': [832, 1255, 6607],\n      'discriminator': '0098',\n      'guild_id': '446075987680165888',\n      'id': '450024877710245889',\n      'level': 11,\n      'message_count': 330,\n      'username': 'timmy',\n      'xp': 6607},\n\n\nGet xp of a user\n+++++++++++++++++++++++++++\n\nReplace user_id with your user id.\n\n.. code-block:: Python\n\n    xp = await mee6API.levels.get_user_xp(user_id)\n    print(xp)\n\n\nExample of what it will return:\n\n::\n\n    42\n\nGet the level of a user\n+++++++++++++++++++++++++++\n\nReplace user_id with your user id.\n\n.. code-block:: Python\n\n    level = await mee6API.levels.get_user_level(user_id)\n    print(level)\n\n\nExample of what it will return:\n\n::\n\n    5\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperevo%2Fmee6-py-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhyperevo%2Fmee6-py-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperevo%2Fmee6-py-api/lists"}