overwatch-api

by alfg

GitHub Readme.md

Overwatch API

An unofficial Overwatch HTTP API, built with NodeJS.

npm Build Status

Features

  • Profile Data
  • Career Stats

API Docs

See: https://ow-api.herokuapp.com/docs/

Demo

curl http://ow-api.herokuapp.com/profile/pc/us/Calvin-1337
{
   "username":"Calvin",
   "level":813,
   "portrait":"https://d1u1mce87gyfbn.cloudfront.net/game/unlocks/0x0250000000000EF7.png",
   "games":{
      "quickplay":{
         "won":647
      },
      "competitive":{
         "won":59,
         "lost":48,
         "draw":1,
         "played":108
      }
   },
   "playtime":{
      "quickplay":"129 hours",
      "competitive":"23 hours"
   },
   "competitive":{
      "rank":4420,
      "rank_img":"https://d1u1mce87gyfbn.cloudfront.net/game/rank-icons/season-2/rank-7.png"
   },
   "levelFrame":"https://d1u1mce87gyfbn.cloudfront.net/game/playerlevelrewards/0x025000000000096F_Border.png",
   "star":"https://d1u1mce87gyfbn.cloudfront.net/game/playerlevelrewards/0x025000000000096F_Rank.png"
}

Please note, the hosted Heroku app above is for development and testing purposes only and not to be used in production. We recommend deploying a copy of this project on your own server.

A production-ready hosted service is TBD.

Or deploy your own Heroku instance!

Deploy

Install

Requirements

  • Node v6.0+
git clone https://github.com/alfg/overwatch-api.git
cd overwatch-api
npm install
npm start

Development

This project is built using srv, a microservices stack based on express. After installation, run the project using the following:

node node_modules/srv-cli/build/srv app/index.js

nodemon is recommended for auto-reloading during development:

nodemon node_modules/srv-cli/build/srv app/index.js

Generate docs with the --docs app/routes flag.

See srv documentation for more info on srv specific options.

License

MIT