Xbox One Smartglass REST API
Project description
Xbox-Smartglass-REST
Open-Source Xbox One Smartglass REST server.
For in-depth information, check out the documentation: (https://openxbox.github.io)
Dependencies
Python >= 3.5
xbox-smartglass-stump (https://pypi.org/project/xbox-smartglass-stump/)
Flask (https://pypi.org/project/Flask/)
Install
Via pip:
pip install xbox-smartglass-rest
How to use
Start the server:
$ xbox-rest-server
Authentication
Authenticate from scratch
For non-2FA enabled account: http://localhost:5557/auth/login For 2FA: http://localhost:5557/auth/oauth # Store tokens on valid authentication http://localhost:5557/auth/store
Load tokens from disk
http://localhost:5557/auth/load http://localhost:5557/auth/refresh
2FA OAuth - POST
# Get authorize url GET http://localhost:5557/auth/url Response-Parameters (JSON): authorization_url # Submit redirect url POST http://localhost:5557/auth/oauth Request-Parameters: redirect_uri
Regular (non-2FA) login - POST
POST http://localhost:5557/auth/login Request-Parameters: email, password
General usage
To see all API endpoints:
http://localhost:5557
Usual usage:
# (Optional) Poweron console http://localhost:5557/device/<liveid>/poweron # NOTE: You can specify device by ip: /device/<liveid>/poweron?addr=192.168.0.123 # Enumerate devices on network # NOTE: You can enumerate device by specific ip: /device?addr=192.168.0.123 http://localhost:5557/device # Connect to console # NOTE: You can connect anonymously: /connect?anonymous=true # .. if console allows it .. http://localhost:5557/device/<liveid>/connect # Use other API endpoints ...
Known issues
Find, report and/or fix them ;)
Bugreporting
When reporting bugs, please make sure to provide the output of the following endpoint
http://localhost:5557/versions
Contribute
Report bugs/suggest features
Improve / add endpoints
Credits
This package uses parts of Cookiecutter and the audreyr/cookiecutter-pypackage project template.
History
0.9.8 (2018-11-14)
Python 3.7 compatibility
0.9.7 (2018-11-05)
Pin xbox-smartglass-core requirement
Filter returned consoles when addr-query is supplied
Expose last_error in console status
0.9.6 (2018-10-04)
Return unique index endpoint
Create FAQ
Always refresh XBL Client with new tokens and implement IP in /device
Expose IP addr discovery through /devices?addr=192.168.0.123
Always refresh XBL Client with new tokens
Add GameDVR endpoint
0.9.5 (2018-08-16)
Add App Type and Fix Media Status
0.9.4 (2018-08-14)
Add /web/titlehistory endpoint
Enable logfile cmdline argument
Parse proper parameter from /launch/<app_id> and /media/seek/<seek_position>
Standardize media commands and input keys casing
Clean up status codes and auth routes
Add friendly name and display image from titlehub to console_status response if authenticated
Do a best effort token load and refresh on startup, auto dump tokens file on successful auth
Simplify auth url endpoint
Restructure app to be more modular
Add XboxLiveClient and endpoint /web/title/<title_id> for downloading friendly name and displayImage
Allow connecting anonymously when supplying anonymous=true via POST to /connect
Pin xbox-smartglass-stump version
Adding /media/seek endpoint
Add /versions endpoint
Rewrite authentication endpoints, OAUTH and regular auth supported
Rename endpoint /authentication to /auth
0.9.3 (2018-08-08)
Rename /status to /console_status
0.9.2 (2018-08-04)
Stump <headend, livetv, tuner lineups> endpoints
Add console flags
Preparing NANO endpoints
Adjusting authentication endpoint slightly
Allow anonymous connection
0.9.1 (2018-08-04)
Small fixup
0.9.0 (2018-08-04)
First commit on github
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for xbox-smartglass-rest-0.9.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 53addf613ae5083b96685e28de176322b5c45e0a76f04ab7e8ce1a58d25e1241 |
|
MD5 | 0588a39736031a6335e4fdea53c60f39 |
|
BLAKE2b-256 | 5319799a4e522f06932af968cb169fe825beb9b86fe154eed787d0a5c92e5b29 |
Hashes for xbox_smartglass_rest-0.9.8-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f76130a6a3bb6018e6d22b7938d830507391d11f7c2fcaebf2a3d21250834338 |
|
MD5 | 23077728c865dbfdc754a749dda595dc |
|
BLAKE2b-256 | 4d4ff035df8a2ec5742b9e772071e006ea21aae3fc3bd0963753cfc1045d6fda |