{ "info": { "author": "OpenXbox", "author_email": "xbox-webapi-ex@prouser123.me", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "==============\nXbox-WebAPI-EX\n==============\n\n.. image:: https://img.shields.io/pypi/v/xbox-webapi-ex.svg\n :target: https://pypi.python.org/pypi/xbox-webapi-ex/\n :alt: Latest Version\n\n.. image:: https://img.shields.io/codecov/c/gh/prouser123/xbox-webapi-ex.svg\n :target: https://codecov.io/gh/Prouser123/xbox-webapi-ex\n :alt: Code Coverage\n\n.. image:: https://img.shields.io/travis/com/prouser123/xbox-webapi-ex.svg\n :target: https://travis-ci.com/Prouser123/xbox-webapi-ex\n :alt: Build Status\n\n.. image:: https://img.shields.io/readthedocs/xbox-webapi-ex.svg\n :target: http://xbox-webapi-ex.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\nXbox-WebAPI is a python library to authenticate with Xbox Live via your Microsoft Account and provides Xbox related Web-API.\n\nAuthentication via credentials or tokens is supported, Two-Factor-Authentication ( 2FA ) is also possible.\n\nDependencies\n------------\n* Python >= 3.5\n* Libraries: requests, demjson, appdirs, urwid\n\nHow to use\n----------\nInstall::\n\n pip install xbox-webapi-ex\n\nAuthentication::\n\n # Token save location: If tokenfile is not provided via cmdline, fallback\n # of /tokens.json is used as save-location\n #\n # Specifically:\n # Windows: C:\\\\Users\\\\\\\\AppData\\\\Local\\\\OpenXbox\\\\xbox\n # Mac OSX: /Users//Library/Application Support/xbox/tokens.json\n # Linux: /home//.local/share/xbox\n #\n # For more information, see: https://pypi.org/project/appdirs and module: xbox.webapi.scripts.constants\n\n xbox-authenticate --tokens tokens.json --email no@live.com --password abc123\n\n # NOTE: If no credentials are provided via cmdline, they are requested from stdin\n xbox-authenticate --tokens tokens.json\n\n # If you have a shell compatible with ncurses, you can use the Terminal UI app\n xbox-auth-ui --tokens tokens.json\n\nFallback Authentication::\n\n # In case this authentication flow breaks or you do not trust the code with your credentials..\n # Open the following URL in your web-browser and authenticate\n https://login.live.com/oauth20_authorize.srf?display=touch&scope=service%3A%3Auser.auth.xboxlive.com%3A%3AMBI_SSL&redirect_uri=https%3A%2F%2Flogin.live.com%2Foauth20_desktop.srf&locale=en&response_type=token&client_id=0000000048093EE3\n\n # Once you finished auth and reached a blank page, copy the redirect url from your browser address-field\n # Execute the script with supplied redirect url\n xbox-auth-via-browser 'https://login.live.com/oauth20_desktop.srf?...access_token=...&refresh_token=...'\n\nExample: Search Xbox Live via cmdline tool::\n\n # Search Xbox One Catalog\n xbox-searchlive --tokens tokens.json \"Some game title\"\n\n # Search Xbox 360 Catalog\n xbox-searchlive --tokens tokens.json -l \"Some game title\"\n\nAPI usage::\n\n import sys\n\n from xbox.webapi.api.client import XboxLiveClient\n from xbox.webapi.authentication.manager import AuthenticationManager\n from xbox.webapi.common.exceptions import AuthenticationException\n\n \"\"\"\n For doing authentication in code, see xbox/webapi/scripts/authenticate.py\n or for OAUTH via web-brower, see xbox/webapi/scripts/browserauth.py\n \"\"\"\n\n try:\n auth_mgr = AuthenticationManager.from_file('/path_to/tokens.json')\n except FileNotFoundError as e:\n print(\n 'Failed to load tokens from \\'{}\\'.\\n'\n 'ERROR: {}'.format(e.filename, e.strerror)\n )\n sys.exit(-1)\n\n try:\n auth_mgr.authenticate(do_refresh=True)\n except AuthenticationException as e:\n print('Authentication failed! Err: %s' % e)\n sys.exit(-1)\n\n xbl_client = XboxLiveClient(auth_mgr.userinfo.userhash, auth_mgr.xsts_token.jwt, auth_mgr.userinfo.xuid)\n\n # Some example API calls\n\n # Get friendslist\n friendslist = xbl_client.people.get_friends_own()\n\n # Get presence status (by list of XUID)\n presence = xbl_client.presence.get_presence_batch([12344567687845, 453486346235151])\n\n # Get messages\n messages = xbl_client.message.get_message_inbox()\n\n # Get profile by GT\n profile = xbl_client.profile.get_profile_by_gamertag('SomeGamertag')\n\nScreenshots\n-----------\nHere you can see the Auth TUI (Text user interface):\n\n.. image:: https://raw.githubusercontent.com/OpenXbox/xbox-webapi-python/master/assets/xbox_auth_tui_main.png\n\n.. image:: https://raw.githubusercontent.com/OpenXbox/xbox-webapi-python/master/assets/xbox_auth_tui_2fa.png\n\nKnown issues\n------------\n* There are a lot of missing XBL endpoints\n\nContribute\n----------\n* Report bugs/suggest features\n* Add/update docs\n* Add additional xbox live endpoints\n\nCredits\n-------\nThis package uses parts of Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\nThe authentication code is based on `joealcorn/xbox`_\n\nInformations on endpoints gathered from:\n\n* `XboxLive REST Reference`_\n* `XboxLiveTraceAnalyzer APIMap`_\n* `Xbox Live Service API`_\n\n.. _`joealcorn/xbox`: https://github.com/joealcorn/xbox\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n.. _`XboxLive REST Reference`: https://docs.microsoft.com/en-us/windows/uwp/xbox-live/xbox-live-rest/atoc-xboxlivews-reference\n.. _`XboxLiveTraceAnalyzer APIMap`: https://github.com/Microsoft/xbox-live-trace-analyzer/blob/master/Source/XboxLiveTraceAnalyzer.APIMap.csv\n.. _`Xbox Live Service API`: https://github.com/Microsoft/xbox-live-api\n\nDisclaimer\n----------\nXbox, Xbox One, Smartglass and Xbox Live are trademarks of Microsoft Corporation. Team OpenXbox is in no way endorsed by or affiliated with Microsoft Corporation, or any associated subsidiaries, logos or trademarks.\n\n\n=======\nHistory\n=======\n\n1.1.7 (2018-11-10)\n------------------\n\n* Fix parsing of WindowsLive auth response\n\n1.1.6 (2018-09-30)\n------------------\n\n* Consider (User-)privileges of (XSTS) userinfo optional\n* Fix: Always return bool for @Property AuthenticationManager.authenticated\n\n1.1.5 (2018-08-11)\n------------------\n\n* Make property *authenticated* in AuthenticationManager check token validity\n* Break out of windows live auth early if cookies were cached previously\n\n1.1.4 (2018-07-01)\n------------------\n\n* Implement convenience functions for Partner Service Authentication\n\n1.1.3 (2018-06-16)\n------------------\n\n* Gracefully fail on wrong account password\n* Fix \"ValueError: tui: Unexpected button pressed: Cancel\"\n* provider.lists: Correct headers, GET list works\n* Titlehub: Support getting title history by xuid\n\n1.1.2 (2018-05-06)\n------------------\n\n* Fixing appdir (aka. token save location) creation on windows\n\n1.1.1 (2018-05-03)\n------------------\n\n* Removed python-dateutil dependency\n* Add auth-via-browser fallback script\n* Small changes\n\n1.1.0 (2018-04-17)\n------------------\n\n* Auth: Updated 2FA authentication to meet current windows live auth flow\n* Auth: Redesigned 2FA authentication procedure\n* Auth: Implemented xbox-auth-ui script (xbox.webapi.scripts.tui: urwid terminal ui)\n* Auth: For password masking, getpass instead or raw input() is used\n* Scripts: Default to appdirs.user_data_dir if no tokenfile provided via cmdline argument (see README)\n\n1.0.9 (2018-03-30)\n------------------\n\n* Extend **Gameclips** provider with title id filtering and saved clips\n* Add **Screenshots** provider\n* Add **Titlehub** provider\n\n1.0.8 (2018-03-29)\n------------------\n\n* Added **Userstats** endpoint\n* Updated README\n\n1.0.7 (2018-03-28)\n------------------\n\n* Support supplying auth credentials via stdin\n* Added tests for all endpoints\n* Added tests for authentication\n* Added **QCS** endpoint\n* Added **Profile** endpoint\n* Added **Achievements** endpoint\n* Added **Usersearch** endpoint\n* Added **Gameclips** endpoint\n* Added **People** endpoint\n* Added **Presence** endpoint\n* Added **Message** endpoint\n* Removed **Gamerpics** endpoint\n\n1.0.3 - 1.0.6 (2018-03-17)\n--------------------------\n\n* Metadata changes\n\n1.0.2 (2018-03-17)\n------------------\n\n* More metadata changes, rendering on PyPi is fine now\n\n1.0.1 (2018-03-17)\n------------------\n\n* Metadata changes\n\n1.0.0 (2018-03-17)\n------------------\n\n* First release on PyPI.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Prouser123/xbox-webapi-python", "keywords": "xbox one live api", "license": "GPL", "maintainer": "", "maintainer_email": "", "name": "xbox-webapi-ex", "package_url": "https://pypi.org/project/xbox-webapi-ex/", "platform": "", "project_url": "https://pypi.org/project/xbox-webapi-ex/", "project_urls": { "Homepage": "https://github.com/Prouser123/xbox-webapi-python" }, "release_url": "https://pypi.org/project/xbox-webapi-ex/1.1.9/", "requires_dist": [ "requests", "demjson", "appdirs", "urwid", "pip ; extra == 'dev'", "bumpversion ; extra == 'dev'", "wheel ; extra == 'dev'", "watchdog ; extra == 'dev'", "flake8 ; extra == 'dev'", "tox ; extra == 'dev'", "coverage ; extra == 'dev'", "Sphinx ; extra == 'dev'", "twine ; extra == 'dev'", "betamax ; extra == 'dev'", "pytest ; extra == 'dev'", "pytest-runner ; extra == 'dev'" ], "requires_python": "", "summary": "A library to authenticate with Windows Live/Xbox Live and use their API", "version": "1.1.9" }, "last_serial": 5975474, "releases": { "1.1.8": [ { "comment_text": "", "digests": { "md5": "71cca97209439ed2dc7d3a168115e14e", "sha256": "e8712acae1f4606913492c887ae61385b1e6cde4d32d8c57d6dae0e0b52af45c" }, "downloads": -1, "filename": "xbox_webapi_ex-1.1.8-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "71cca97209439ed2dc7d3a168115e14e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 48063, "upload_time": "2019-09-30T18:01:27", "url": "https://files.pythonhosted.org/packages/ad/28/f361b55a4aebec001d0f63d6fd5a44c1e8a5cdc0da11d286d990c7bbe9b4/xbox_webapi_ex-1.1.8-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2e7ee211413ab820176bf9212cbccf03", "sha256": "213edd49422678083bb2065f62c959ffc1bf6bfece53bbdaa4eada852bc8fe98" }, "downloads": -1, "filename": "xbox-webapi-ex-1.1.8.tar.gz", "has_sig": false, "md5_digest": "2e7ee211413ab820176bf9212cbccf03", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 405382, "upload_time": "2019-09-30T18:01:29", "url": "https://files.pythonhosted.org/packages/01/53/c8777c9afad66338a6465ad17d51894f7545eb1da182285b720e5f206e4e/xbox-webapi-ex-1.1.8.tar.gz" } ], "1.1.9": [ { "comment_text": "", "digests": { "md5": "e8abb22adee9bbe5c45425121fd25d8e", "sha256": "8d5f2989eae343de4fceef5b8654ce8a85213ddb1b753749572f6cf002830b3d" }, "downloads": -1, "filename": "xbox_webapi_ex-1.1.9-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "e8abb22adee9bbe5c45425121fd25d8e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 48164, "upload_time": "2019-10-15T08:11:59", "url": "https://files.pythonhosted.org/packages/99/47/2a34271e511139efc838cfc81a5f651844ff8bbdb2170448d7300c6fc4cc/xbox_webapi_ex-1.1.9-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0f8dc6713627faf5f8bf5c6c6ae6d035", "sha256": "10c0097f8e42c49ec8b94c23b81167cd4d05ec3e228f5a610e40d45ce69ee1a4" }, "downloads": -1, "filename": "xbox-webapi-ex-1.1.9.tar.gz", "has_sig": false, "md5_digest": "0f8dc6713627faf5f8bf5c6c6ae6d035", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 405899, "upload_time": "2019-10-15T08:12:01", "url": "https://files.pythonhosted.org/packages/15/ad/ac1210ca646e8943499d68d5f9878e92412c101cc1e7595de2e7719699a8/xbox-webapi-ex-1.1.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e8abb22adee9bbe5c45425121fd25d8e", "sha256": "8d5f2989eae343de4fceef5b8654ce8a85213ddb1b753749572f6cf002830b3d" }, "downloads": -1, "filename": "xbox_webapi_ex-1.1.9-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "e8abb22adee9bbe5c45425121fd25d8e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 48164, "upload_time": "2019-10-15T08:11:59", "url": "https://files.pythonhosted.org/packages/99/47/2a34271e511139efc838cfc81a5f651844ff8bbdb2170448d7300c6fc4cc/xbox_webapi_ex-1.1.9-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0f8dc6713627faf5f8bf5c6c6ae6d035", "sha256": "10c0097f8e42c49ec8b94c23b81167cd4d05ec3e228f5a610e40d45ce69ee1a4" }, "downloads": -1, "filename": "xbox-webapi-ex-1.1.9.tar.gz", "has_sig": false, "md5_digest": "0f8dc6713627faf5f8bf5c6c6ae6d035", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 405899, "upload_time": "2019-10-15T08:12:01", "url": "https://files.pythonhosted.org/packages/15/ad/ac1210ca646e8943499d68d5f9878e92412c101cc1e7595de2e7719699a8/xbox-webapi-ex-1.1.9.tar.gz" } ] }