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/Alf-1608
{
    "username": "Alf",
    "games": {
        "quickplay": {
            "won": 508
        },
        "competitive": {
            "won": 26,
            "lost": 26,
            "draw": 2,
            "played": 54
        }
    },
    "playtime": {
        "quickplay": "122 hours",
        "competitive": "6 hours"
    },
    "competitive": {
        "rank": "2073",
        "rank_img": "https://blzgdapipro-a.akamaihd.net/game/rank-icons/rank-10.png"
    },
    "levelFrame": "https://blzgdapipro-a.akamaihd.net/game/playerlevelrewards/0x0250000000000928_Border.png",
    "star": "https://blzgdapipro-a.akamaihd.net/game/playerlevelrewards/0x0250000000000928_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