Welcome to python-xbox’s documentation!

Contents:
Links:

Installation

Install the latest released version using pip

$ pip install xbox

Quickstart

>>> import xbox

>>> # authenticate
>>> xbox.client.authenticate(email_address, password)

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

Base API client object handling authentication and making requests.

A global instance of this is instantiated on import, all you have to do is call the authenticate() method.

Variables:authenticated (bool) – whether client is authed
authenticate(login=None, password=None)

Authenticated this client instance.

login and password default to the environment variables MS_LOGIN and MS_PASSWD respectively.

Parameters:
  • login – Email address associated with a microsoft account
  • password – Matching password
Raises:

AuthenticationException

Returns:

Instance of Client