Giter Club home page Giter Club logo

node-xbox's Introduction

node-xbox NPM

node-xbox is a Node.js module implementation of the https://xboxapi.com/ API. All information returned is straight from the XboxApi.com API.

Installation

npm install node-xbox

API Overview

This API uses the XboxApi.com API to access Xbox Live information.

var xbox = require('node-xbox')("my xboxapi.com api key");
// xbox.{ RESOURCE_NAME }.{ METHOD_NAME }

All methods require a callback as the last argument.

xbox.profile.gameClips("2535473249143795", function(err, gameClips){
    // if an error occured, err will be an object describing the error
    // gameClips is an array of gameClips
});

Available methods

Note: Node-xbox has implement all XboxApi.com API endpoints except http://catalog.xboxapi.com/{game_id}

  • RESOURCE_NAME
    • METHOD_NAME
  • account
    • accountXuid()
    • messages()
    • recentPlayers()
  • game
    • game(product_id)
    • gameHex(product_id_hex)
  • profile
    • xuid(gamertag) - gets the XUID of the specified gamertag
    • gamertag(xuid) - gets the gamertag of the specified XUID
    • profile(xuid)
    • gamercard(xuid)
    • presence(xuid)
    • activity(xuid)
    • activityRecent(xuid)
    • friends(xuid)
    • followers(xuid)
    • gameClips(xuid)
    • gameClipsSaved(xuid)
    • gameStats(xuid, titleid)
    • xbox360Games(xuid)
    • xboxOneGames(xuid)
    • achievements(xuid, titleid)

Todo

  • Clean up and structure data return by the XboxApi.com API.
  • Return structured errors

node-xbox's People

Contributors

bendl avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

jordanhc

node-xbox's Issues

502 Bad Gateway

I have been getting 502s when hitting multiple endpoints - I also get a 502 response when trying to go to the XboxAPI website. Any advice?

Jason

Update to Promises

Hello,

I was wondering if this API would be written to support promises rather than callbacks?

Best Regards,

Manny

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.