phanx-wow / realminfo-scraper

Script to pull WoW realm data from the Blizzard Developer API

This is a tool to scrape World of Warcraft realm and realm-connection data from the Blizzard Developer API, primarily for use in the LibRealmInfo library.

Usage

1. Run yarn start or npm start or node index.js.
2. See the generated connectionData.json and realmData.json files in the output directory.

Total running time is over 8 minutes, as a delay of 12 ms is enforced between API calls in order to comply with the "100 requests per second" limit for free accounts.

For use in LibRealmInfo:

1. Optionally, run yarn convert or npm convert or node convert.js.
2. See the generated data.lua file in the output directory.

Requirements

1. Install Node.js
2. Optionally, install Yarn
3. Get a Blizzard API Key
4. Run yarn install or npm install
5. Create a .env file:

    CLIENT_ID=<your Blizzard API key>
    CLIENT_SECRET=<your Blizzard API secret>
   

License

Zlib license. See the LICENSE file for the full text.