node-uxla

Wrapper for xboxleaders.com and xboxapi.com API.

node-uxla

Unofficial Xbox Live API wrapper written in JavaScript for NodeJS. With this wrapper you can choose to use xboxleaders.com or xboxapi.com API.

IMPORTANT:

The guys behind XboxLeaders decided to shut down xboxleaders API (here -- maybe the link is dead). You can still use this module. You will need to configured your XboxLeaders instance.

$ npm install [--save] node-uxla
  • Entire module
var uxla = require('node-uxla');
  • One of the available classes
var XboxLeaders = require('node-uxla').XboxLeaders;
/**
    Defaults
        - baseUrl: "https://www.xboxleaders.com/api"
        - version: "2.0"
        - format: "json"
        - gamertagRequests: "5"
*/
var xlDefault = new XboxLeaders();
var xlConfigured = new XboxLeaders({
    "base_url": "https://mydomain.com/api" // don't set the "/" at the end of the url 
    "version": "2.0",
    "format": "json"
});
 
xlConfigured.gamertagRequests = 10;
 
// or 
 
var XboxApi = require('node-uxla').XboxApi;
/**
    Defaults:
        - baseUrl: "https://xboxapi.com"
        - version: "v1"
        - format: "json"
*/
var xaDefault = new XboxApi();
var xaConfigured = new XboxApi({
    "version": "v1",
    "format": "json"
});
Method Description Required parameters Optional parameters Response format

profile

Returns information about the requested gamertag that would be displayed on their Xbox.com profile. gamertag region (only for XboxLeaders) JSON, XML (mostly used)

games

Returns a list of all games the requested gamertag has played, as well as data pertaining to those games, such as achievements, gamerscore, and boxart. gamertag region (only for XboxLeaders) JSON, XML (mostly used)

friends

Returns a list of all of the requested gamertag's friends as well as their online status. gamertag region (only for XboxLeaders) JSON, XML (mostly used)

achievements

Returns a list of all achievements for the requested gamertag and game. Secret achievements cannot be revealed through this endpoint. gamertag, gameid region (only for XboxLeaders) JSON, XML (mostly used)
Method Description Required parameters Optional parameters Response format

search

Return a list of results for the queried search. Searches the Xbox Marketplace. query region JSON, XML (mostly used)
Method Description Required parameters Optional parameters Response format

catalog

Return some information about a particular game. Information such as genre, description, lots of images. gameId JSON, XML (mostly used)

You will find 2 scripts in the scripts folder at root project to test the supported API.

$ npm run-script xbox-api
 
// or
 
$ npm run-script xbox-leaders