Skip to content
Xbox One SmartGlass RESTful server
Branch: master
Clone or download
Latest commit f51ae29 Nov 24, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
tests Add App Type and Fix Media Status (#9) Aug 15, 2018
xbox/rest Fix /media/seek/<int:seek_position> Nov 24, 2018
.gitignore
.travis.yml
CONTRIBUTING.rst Initial commit Aug 4, 2018
Dockerfile
FAQ.md
HISTORY.rst Update for python3.7 Nov 14, 2018
LICENSE Initial commit Aug 4, 2018
MANIFEST.in
Makefile Initial commit Aug 4, 2018
README.rst Add docker badge Nov 24, 2018
setup.cfg Remove Dockerfile section from setup.cfg Nov 24, 2018
setup.py
tox.ini

README.rst

Xbox-Smartglass-REST

Latest Version https://travis-ci.com/OpenXbox/xbox-smartglass-rest-python.svg?branch=master Docker Build Status Discord chat channel

Open-Source Xbox One Smartglass REST server.

For in-depth information, check out the documentation: (https://openxbox.github.io)

Dependencies

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.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.