Research
Security News
Quasar RAT Disguised as an npm Package for Detecting Vulnerabilities in Ethereum Smart Contracts
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
promise-battlenet-api
Advanced tools
A basic client for the Blizzard Battle.net api using request and promises.
A basic client for the Blizzard Battle.net api using request and promises.
Currently only supports some WoW resources.
Does not currently support protected resources.
npm install promise-battlenet-api --save
var bnet = require("promise-battlenet-api");
var client = new bnet({
apikey: "your_api_key_here",
});
client.setApiKey("your_api_key_here");
If an apikey has not been explicitly provided, the client will fallback to either of the below environment variables if available.
process.env.BNET_ID
process.env.BATTLENET_API_KEY
If for example, your apikey is limited to 100 calls a second, you should configure the client to perform 99 or less api calls per 1000 milliseconds (1 second). This allows for just a slight buffer to avoid edge cases.
If you are requesting api calls faster than the set throttle, subsequent calls be will queued to be executed once the throttle duration has expired.
Throttling uses xavi-/node-simple-rate-limiter under the hood.
var bnet = require("promise-battlenet-api");
var client = new bnet({
apikey: "your_api_key_here",,
throttle: {
to: 99, // the number of calls
per: 1000 // the timeframe in milliseconds
}
});
Throttling is intended for avoiding 403 Forbidden (Account Over Queries Per Second Limit) errors. Should your application make more requests than allowed for your hourly quota, you will need to manually handle those errors.
client.fetch("character", {
region: "us",
realm: "emerald-dream",
name: "talgees"
})
.then(function printData (data) {
console.log(data);
})
.catch(console.error);
client.fetch("character", {
region: "us",
realm: "emerald-dream",
name: "talgees",
fields: "stats,items"
})
.then(function printData (data) {
console.log(data);
})
.catch(console.error);
client.fetch("character", {
apikey: "your_api_key_here",
region: "us",
realm: "emerald-dream",
name: "talgees"
})
.then(function printData (data) {
console.log(data);
})
.catch(console.error);
The below responses are an example of, but not a complete list, of common responses from the client.
{ statusCode: 200, // http status code
responseTime: 528, // how long in milliseconds the response took
headers:
{ 'x-plan-qps-allotted': '100', // how many calls you are allowed to make an second
'x-plan-qps-current': '61', // how many calls you have made this second
'x-plan-quota-allotted': '36000', // how many calls you are allowed to make an hour
'x-plan-quota-current': '711', // how many calls you have made this hour
'x-plan-quota-reset': 'Sunday, April 17, 2016 5:00:00 PM GMT', // when your calls per hour limit will reset
'last-modified': 'Sun, 17 Apr 2016 11:49:37 GMT' }, // when the data of the response was last modified
data: // the json payload / body of the response
{ lastModified: 1460893777000,
name: 'Bøllwèrk',
realm: 'Blackrock',
battlegroup: 'Glutsturm / Emberstorm',
class: 1,
race: 10,
gender: 0,
level: 100,
achievementPoints: 11625,
thumbnail: 'blackrock/3/67405315-avatar.jpg',
calcClass: 'Z',
faction: 1,
totalHonorableKills: 14402 } }
{ statusCode: 404,
responseTime: 933,
headers:
{ 'x-plan-qps-allotted': '100',
'x-plan-qps-current': '30',
'x-plan-quota-allotted': '36000',
'x-plan-quota-current': '870',
'x-plan-quota-reset': 'Sunday, April 17, 2016 5:00:00 PM GMT' },
data: { status: 'nok', reason: 'Character not found.' } }
Use the throttling feature to avoid this error.
{ statusCode: 403,
responseTime: 498,
headers: {
'x-plan-qps-allotted': '100',
'x-plan-qps-current': '150' },
data:
{ code: 403,
type: 'Forbidden',
detail: 'Account Over Queries Per Second Limit' } }
The MIT License (MIT)
Copyright (c) 2015 Kevin Viglucci
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
A basic client for the Blizzard Battle.net api using request and promises.
The npm package promise-battlenet-api receives a total of 0 weekly downloads. As such, promise-battlenet-api popularity was classified as not popular.
We found that promise-battlenet-api demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.