Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alvarocastro/wow-realm-status
Easily fetch info about the World of Warcraft realms
https://github.com/alvarocastro/wow-realm-status
battlenet blizzard realm world-of-warcraft wow
Last synced: 28 days ago
JSON representation
Easily fetch info about the World of Warcraft realms
- Host: GitHub
- URL: https://github.com/alvarocastro/wow-realm-status
- Owner: alvarocastro
- License: mit
- Created: 2019-09-09T14:02:16.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T04:36:13.000Z (almost 2 years ago)
- Last Synced: 2024-10-31T17:12:37.292Z (about 2 months ago)
- Topics: battlenet, blizzard, realm, world-of-warcraft, wow
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/wow-realm-status
- Size: 529 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wow-realm-status
[](https://www.npmjs.com/package/wow-realm-status)
[](https://codeclimate.com/github/alvarocastro/wow-realm-status/maintainability)
[](https://github.com/xojs/xo)
Easily fetch info about the World of Warcraft realms.
- [Install](#install)
- [Usage](#usage)
- [Realm data](#realm-data)
- [Contributing](#contributing)
- [Support](#support)
- [Related](#related)
## Install
```bash
npm install wow-realm-status
```
## Usage
```js
const {fetchRealm} = require('wow-realm-status');
fetchRealm('us', 'ragnaros')
.then(realm => console.log(realm));
//=> {
// name: 'Ragnaros',
// slug: 'ragnaros',
// locale: 'es-MX',
// timezone: 'CDT',
// online: true,
// type: 'normal',
// population: 'full'
//}
```
### fetchRealm(region, realm[, version="retail"])
Returns a JSON object containing the realm data.
#### region
Type: `string`
#### realm
Type: `string`
#### classic
Type: `boolean`
Default: `"retail"`
### fetchRealms(region[, version])
Returns an array of JSON objects with the realms for that region.
#### region
Type: `string`
#### version
To specify the game version to fetch.
Type: `string`
Supported values: `"retail"`, `"classic"`, `"bc"`
Default: `"retail"`
## Realm data
Each realm is represented as a JSON object with the following properties:
#### name
Type: `string`
#### slug
Type: `string`
#### locale
Type: `string`
Locale of the realm, formatted as a [`IETF BCP 47` language tag](https://en.wikipedia.org/wiki/IETF_language_tag).
#### timezone
Type: `string`
#### online
Type: `boolean`
#### type
Type: `string`
Possible values are: `normal`, `pvp`, `rp`, `rppvp`.
#### population
Type: `string`
Current population of the realm.
Possible values are: `very-low`, `low`, `medium`, `high`, `full`
## Contributing
Contributions are always welcome! Please run `npm test` before hand to ensure everything is ok.
## Support
If you use this package please consider starring it :)
## Related
* [wow-realm-status-cli](https://github.com/alvarocastro/wow-realm-status-cli) - CLI version of this library.