Package Exports

overwatch-api-server

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (overwatch-api-server) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Overwatch API

An unofficial Overwatch and Overwatch League HTTP API and NodeJS module.

Features

Profile Data
Career Stats
Overwatch League Data
- Live Match
- Standings
- Schedule

API Docs

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

NPM Module

If you wish to use the Javascript API in your own project, see api/README.md.

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!

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