https://github.com/khrome/xbox-live
An NPM for pulling xbox live gamer data
https://github.com/khrome/xbox-live
gamercard xbox xbox-live
Last synced: about 2 months ago
JSON representation
An NPM for pulling xbox live gamer data
- Host: GitHub
- URL: https://github.com/khrome/xbox-live
- Owner: khrome
- License: mit
- Created: 2013-01-27T21:34:14.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2016-11-01T02:19:18.000Z (over 8 years ago)
- Last Synced: 2024-05-09T17:46:36.085Z (about 1 year ago)
- Topics: gamercard, xbox, xbox-live
- Language: JavaScript
- Size: 22.5 KB
- Stars: 20
- Watchers: 11
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
xbox-live.js
==============
An NPM for fetching xbox live player data.
This supports requesting status directly from Microsoft's GamerCard endpoints(which will never fail as long as xbox-live is up) as well as supporting plugins to external services. In addition you can also fetch game data from [Destiny](docs/destiny.md), [Overwatch](docs/overwatch.md), with more on the way.
If you would like to implement a plugin for your own player stats tracker, check out the [developer docs](docs/developers.md).
Usage
-----
First include the module and instantiate the object:
var XBoxLive = require('xbox-live');
var api = new XBoxLive.Source.GamerCard();
Then you need to call:
api.profile({
gamertag : ''
}, function(err, user){
//do something
});
It also indexes any games it's seen allowing it to subsequently return them:
api.games({
id : ''
}, function(err, game){
//do something
});
Because GamerCard is currently the only source, there are no other working calls(`.friends()`, `.achievements()`, etc.) yet.
Games
-------
Some games have official APIs of their own, and we provide wrappers for these.
###[Destiny](docs/destiny.md)
Destiny Provides a full range of queries across the entire game engine. Currently there is only full coverage around the user, player and inventory calls.
###[Overwatch](docs/overwatch.md)
Destiny provides combat summaries on a per-character basis (as well as including global totals)
Testing
-------
Run the tests at the project root with:
mocha
Run a specific suite (one of `gamer-card`, `overwatch` or `destiny`) with:
mocha test/
If you want to run the destiny tests, you must set `DESTINY_API_KEY` in your environment.
Enjoy,
-Abbey Hawk Sparrow