starcraft2-api

StarCraft2-API

Flexible and feature-rich JavaScript / TypeScript library for easy access to StarCraft II Community APIs and StarCraft II Game Data APIs powered by BlizzAPI.

Install

npm install starcraft2-api

Quick start

const { StarCraft2API } = require("starcraft2-api");

/**
 * Or using TypeScript:
 * import { StarCraft2API } from 'StarCraft2API';
 */

const sc2api = new StarCraft2API({
  region: "us",
  clientId: "client id",
  clientSecret: "client secret",
});

const data = await sc2api.queryProfile({
  regionId: 1,
  realmId: 1,
  profileId: 1084304,
});

console.log(data);

Manual build

git clone https://github.com/blizzapi/starcraft2-api.git
cd starcraft2-api
npm install
npm run build

Documentation & examples

• starcraft2-api.lukem.net - documentation
• starcraft2-api-docs - documentation repo on GitHub
• starcraft2-api-example - sample Express.js REST API with usage examples
• Repositories that depend on StarCraft2-API

Contributions

Contributions of any kind are welcome.

You can contribute to StarCraft2-API by:

• submiting a bug report or a feature suggestion
• improving documentation either within the project itself or in the doc site repository
• submitting pull requests

Before contributing be sure to read Contributing Guidelines and Code of Conduct.

Contributors

To all who contribute code, improve documentation, submit issues or feature requests - thank you for making StarCraft2-API even better!

We maintain an AUTHORS file where we keep a list of all project contributors. Please consider adding your name there with your next PR.

License

Licensed under MIT License. See LICENSE for more information.

Legal

This project is not authored, affiliated or endorsed in any way by Blizzard Entertainment.

Battle.net and Blizzard Entertainment are trademarks or registered trademarks of Blizzard Entertainment, Inc. in the U.S. and/or other countries.

© 2010 Blizzard Entertainment, Inc. All rights reserved. Wings of Liberty is a trademark, and StarCraft and Blizzard Entertainment are trademarks or registered trademarks of Blizzard Entertainment, Inc. in the U.S. and/or other countries.

© 2013 Blizzard Entertainment, Inc. All rights reserved. Heart of the Swarm and StarCraft are trademarks or registered trademarks of Blizzard Entertainment, Inc. in the U.S. and/or other countries.