Skip to main content

XBOX One API

Project description

Description

This is a Python wrapper for the unofficial Xbox API

Build Status

Installation

For now you will have to install manually, as I didn't upload the initial version to pypi (pip).

  1. Clone this repo
  2. Place the xboxapi directory in your project

The only dependency is requests library.

Usage

This is a basic example of how to create a client and fetch a gamers profile information from their gamertag.

from xboxapi import Client

client = Client(api_key=<api_key>)
gamer = client.gamer('voidpirate')

profile = gamer.get('profile')

Client class constructor takes the following optional arguments except api_key.

Argument Value Short Description
api_key string api token from Xbox API
timeout int how long until the request times out (seconds)
lang string country language code (e.g. for German (de-DE))

Client class public methods.

Method Value Optional Short Description
gamer(gamertag=<string>) string xuid=<string> gamertag to lookup
calls_remaining() n/a n/a Return headers about api rate limits

A note about the gamer method. If you already know the gamers xuid you can use that instead to avoid an additional api call when using only a gamertag.

Gamer class public methods, returned from gamer method in Client.

Method Value Optional Short Description
get(method=<string>) string term=<string> API calls.
send_message(message=<string>) string n/a Send a message to gamer
send_activity(message=<string>) string n/a Update your activity feed with a message

Pagination is supported in this client and all handled through get method. It works by detecting the response header for pagination, any subsequent calls to the same api endpoint will return paged data. If another api call is made to a different endpoint, the pagination token will be cleared and results will not be paged.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xboxapi-2.0.1.tar.gz (6.0 kB view hashes)

Uploaded source

Built Distribution

xboxapi-2.0.1-py3-none-any.whl (6.0 kB view hashes)

Uploaded py3

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