Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

oversmash

Package Overview
Dependencies
Maintainers
1
Versions
20
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

oversmash

API wrapper for Blizzard's Overwatch player data

  • 1.6.1
  • latest
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

oversmash npm version

API wrapper for Blizzard's Overwatch player stats. Uses promises.

Blizzard does not expose an official API, so this library relies partially on scraping, using cheerio.

Please also keep in mind there is no builtin rate-limiting support, so it's on you to use the library responsibly.

Note: See CHANGELOG.MD for change details

Features

  • Ability to retrieve basic user information, such as name, portrait, level and accounts
    • Correctly identifies the platform for each account
  • Ability to retrieve detailed stats for a player, for a given region and platform
    • Includes all stats available on playoverwatch.com
    • Includes the player's current competitive rank
    • Includes full list of achievements, with details on which the player has completed
    • Stats are retrieved and grouped automatically per career type (quickplay/competitive), hero, and group (e.g combat, awards, etc)
    • Supports new heroes and new types of stats as they're added, no changes required to the code
  • Supports normalizing names and values (e.g converting achievement names to snake_case, properly handling floating-point values in stats, etc)
  • Minimalist and straightforward API

Usage

Install through npm:

$ npm install --save oversmash

Example:

import oversmash from 'oversmash'

// Create a new oversmash object. `oversmash()` accepts an options
// object (see below)
const ow = oversmash()

// Get basic details about a user, including their platform accounts.
//
ow.player('bob#12345').then(player => {
  console.log(player)
})

// Output:
// { name: 'bob#12345',
//   accounts:
//    [ { level: 440,
//        portrait: 'https://blzgdapipro-a.akamaihd.net/game/unlocks/xyz.png',
//        displayName: 'bob#12345',
//        platform: 'pc' } ] }

// Get detailed stats about a user, including
// achievements unlocked, per-career and per-hero stats, and their
// current competitive rank
ow.playerStats('bob#12345', 'pc').then(player => {
  console.log(player)
})

// Output:
// { name: 'bob#12345',
//   region: 'us',
//   platform: 'pc',
//   stats:
//    { competitiveRank: { support: 1234, tank: 1234, damage: 1234 },
//      endorsementLevel: 3,
//      gamesWon: 2500,
//      achievements:
//       [ { name: 'centenary', achieved: true },
//         { name: 'level_10', achieved: true },
//         { name: 'level_25', achieved: true },
//         { name: 'level_50', achieved: true },
//         { name: 'undying', achieved: true },
//         { name: 'survival_expert', achieved: true },
//         /* ... etc ... */],
//      quickplay:
//       { all: { /* avg stats across all characters */ }
//         reaper:
//          { combat:
//             { melee_final_blows: 190,
//               solo_kills: 2922,
//               objective_kills: 6592,
//               final_blows: 9519,
//               damage_done: 6897,
//               eliminations: 18456,
//               environmental_kills: 83,
//               multikills: 155 },
//            assists:
//             { healing_done: 1102,
//               recon_assists: 25,
//               teleporter_pads_destroyed: 18 },
//            best:
//             { eliminations_most_in_game: 44,
//               final_blows_most_in_game: 27,
//               damage_done_most_in_game: 17491,
//   /* ... etc ... */

oversmash() options

The following options are configurable.

{
  // Convert things like stat group names to snake_case (e.g ana.awards.medalsBronze vs ana.awards.medals_bronze)
  normalizeNames: true,

  // When set to snake, names are normalized as snake_case; when set to camel,
  // names are lowerCamelCase. Only applies if normalizeNames is enabled.
  normalizeNamesAs: 'snake' || 'camel',

  // Convert values to their correct format, e.g numbers in stats to JS numbers
  // When disabled, all stats values are strings as extracted from Blizzard
  normalizeValues: true,

  // Convert percentage values to ints, e.g '32%' to 32
  percentsToInts: true,

  // The url template used to build the full portrait url, where the player's Overwatch
  // career icon/profile image is available.
  //
  // %s is replaced with the value from the player's profile.
  portraitUrlTemplate: 'https://d1u1mce87gyfbn.cloudfront.net/game/unlocks/%s.png',

  // Default platform if none is specified in the options
  defaultPlatform: 'pc',

  requestOptions: {
    baseURL: 'https://playoverwatch.com/en-us',
    headers: {
      'User-Agent': 'https://github.com/filp/oversmash (hi jeff)'
    }
  }
}

requestOptions are passed directly to request.defaults on request

Debugging

oversmash uses debug. Run your code calling oversmash with DEBUG=oversmash:* to enable debug logging

Stuff 🐝 🐝 🐝

See LICENSE.md for license information

Contributions are welcome - please follow the style guidelines as enforced by the included .eslintrc!

Keywords

FAQs

Package last updated on 14 Nov 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc