Skip to main content

A wrapper around Microsoft's undocumented Xbox One APIs

Project description

# Python Xbox API client

This is unreleased software. As such things are may be broken
and APIs are likely to change. Use at your own risk.

[![Documentation](https://readthedocs.org/projects/xbox/badge/?version=latest)](http://xbox.readthedocs.org/en/latest/)
[![Build Status](http://img.shields.io/travis/buttscicles/xbox.svg)](https://travis-ci.org/buttscicles/xbox)
[![Coverage Status](https://img.shields.io/coveralls/buttscicles/xbox.svg)](https://coveralls.io/r/buttscicles/xbox)

### About

This project is a wrapper around Microsoft's set of private APIs
in use by the Xbox One and related apps.

### Goals

The main goals of this project are to achieve a decent, usable API,
everything else is secondary.

### Usage

```python
>>> import xbox

>>> xbox.client.authenticate(login='joe@example.org', password='hunter2')

>>> # get a gamer
>>> gt = xbox.GamerProfile.from_gamertag('JoeAlcorn')
>>> gt.gamerscore
22056
>>> gt.gamerpic
'http://images-eds.xboxlive.com/image?url=z951ykn43p4FqWbbFvR2Ec.8vbDhj8G2Xe7JngaTToBrrCmIEEXHC9UNrdJ6P7KIFXxmxGDtE9Vkd62rOpb7JcGvME9LzjeruYo3cC50qVYelz5LjucMJtB5xOqvr7WR'

>>> # get iterator of recorded clips
>>> clips = gt.clips()
>>> # convert iterator to a list so we can index it
>>> clips = list(clips)
>>> clip = clips[0]
>>> clip.media_url
'http://gameclipscontent-d2005.xboxlive.com/asset-886c5b78-8876-4823-b31b-fbc77d8caa67/GameClip-Original.MP4?sv=2012-02-12&st=2014-09-03T22%3A40%3A58Z&se=2014-09-03T23%3A45%3A58Z&sr=c&sp=r&sig=Q5qvyDvFRM2Bn2tztJ%2F%2BEf9%2FQOpkTPuFniByvE%2Bc9cc%3D&__gda__=1409787958_f22b516f9d29da56911b7cac03f15d05'
>>> clip.views
4
>>> clip.state
'Published'
>>> clip.duration
54
>>> clip.thumbnails.large
'http://gameclipscontent-t2005.xboxlive.com/00090000014d6bae-7638b9fd-2a19-4ef1-b621-505a6ac93488/Thumbnail_Large.PNG'
```


### Links

- [Code](https://github.com/buttscicles/xbox/)
- [Issues & Bugs](https://github.com/buttscicles/xbox/issues)
- [Documentation](http://xbox.readthedocs.org/en/latest/)
- [PyPI](https://pypi.python.org/pypi/python-xbox)
- [Roadmap](https://trello.com/b/onAwDz0V/python-xbox)

Project details


Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page