Skip to content

Strafer14/xbox-live-api---node

Repository files navigation

Typescript Node Xbox-Live API

I've written this project because I couldn't find a modern Nodejs library that can access xbox live resources via API calls.

Requires a valid microsoft account

Functionality:

Get:

  • Xbox user id by username.
  • A player's:
    1. Settings and xuid.
    2. Clips (with pagination).
    3. Screenshots (with pagination).
    4. Achievements per title (with pagination).
    5. Latest activity.

How to use:

npm install async-xbox-live-api

Then:

pre-es6:
const xla = require('async-xbox-live-api');
es6:
import * as xla from 'async-xbox-live-api';

Next you should insert your credentials via the environment variables:

XBL_USERNAME=
XBL_PASSWORD=

NOTE:
This library supports .env files, an .env.example file is included

Methods:

getXuid

xla.getXuid('Ninja').then(console.log).catch(console.error);

getClipsForGamer

xla.getClipsForGamer('Ninja').then(console.log).catch(console.error);

getScreenshotsForGamer

xla.getScreenshotsForGamer('Ninja').then(console.log).catch(console.error);

getAchievementsForGamer

xla.getAchievementsForGamer('Ninja').then(console.log).catch(console.error);

getActivityForGamer

xla.getActivityForGamer('Ninja').then(console.log).catch(console.error);

Types:

Response types for API requests are included

About

Typescriot Nodejs library to interact with microsoft's xbox live api

Resources

Stars

Watchers

Forks

Packages

No packages published