{"id":21681846,"url":"https://github.com/alvarocastro/wow-realm-status","last_synced_at":"2025-07-20T01:31:57.711Z","repository":{"id":35110475,"uuid":"207323190","full_name":"alvarocastro/wow-realm-status","owner":"alvarocastro","description":"Easily fetch info about the World of Warcraft realms","archived":false,"fork":false,"pushed_at":"2023-01-07T04:36:13.000Z","size":542,"stargazers_count":2,"open_issues_count":8,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-07T08:55:09.371Z","etag":null,"topics":["battlenet","blizzard","realm","world-of-warcraft","wow"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/wow-realm-status","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alvarocastro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-09T14:02:16.000Z","updated_at":"2022-12-13T19:09:54.000Z","dependencies_parsed_at":"2023-01-15T14:01:56.659Z","dependency_job_id":null,"html_url":"https://github.com/alvarocastro/wow-realm-status","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/alvarocastro/wow-realm-status","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alvarocastro%2Fwow-realm-status","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alvarocastro%2Fwow-realm-status/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alvarocastro%2Fwow-realm-status/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alvarocastro%2Fwow-realm-status/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alvarocastro","download_url":"https://codeload.github.com/alvarocastro/wow-realm-status/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alvarocastro%2Fwow-realm-status/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266053825,"owners_count":23869496,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["battlenet","blizzard","realm","world-of-warcraft","wow"],"created_at":"2024-11-25T15:31:58.074Z","updated_at":"2025-07-20T01:31:57.675Z","avatar_url":"https://github.com/alvarocastro.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# wow-realm-status\n[![NPM](https://img.shields.io/npm/v/wow-realm-status.svg)](https://www.npmjs.com/package/wow-realm-status)\n[![Maintainability](https://api.codeclimate.com/v1/badges/753c087f0d8331aa962c/maintainability)](https://codeclimate.com/github/alvarocastro/wow-realm-status/maintainability)\n[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo)\n\nEasily fetch info about the World of Warcraft realms.\n\n- [Install](#install)\n- [Usage](#usage)\n- [Realm data](#realm-data)\n- [Contributing](#contributing)\n- [Support](#support)\n- [Related](#related)\n\n## Install\n\n```bash\nnpm install wow-realm-status\n```\n\n## Usage\n\n```js\nconst {fetchRealm} = require('wow-realm-status');\n\nfetchRealm('us', 'ragnaros')\n\t.then(realm =\u003e console.log(realm));\n//=\u003e {\n//  name: 'Ragnaros',\n//  slug: 'ragnaros',\n//  locale: 'es-MX',\n//  timezone: 'CDT',\n//  online: true,\n//  type: 'normal',\n//  population: 'full'\n//}\n```\n\n### fetchRealm(region, realm[, version=\"retail\"])\n\nReturns a JSON object containing the realm data.\n\n#### region\n\nType: `string`\n\n#### realm\n\nType: `string`\n\n#### classic\n\nType: `boolean`\u003cbr\u003e\nDefault: `\"retail\"`\n\n### fetchRealms(region[, version])\n\nReturns an array of JSON objects with the realms for that region.\n\n#### region\n\nType: `string`\n\n#### version\n\nTo specify the game version to fetch.\n\nType: `string`\u003cbr\u003e\nSupported values: `\"retail\"`, `\"classic\"`, `\"bc\"`\u003cbr\u003e\nDefault: `\"retail\"`\n\n## Realm data\n\nEach realm is represented as a JSON object with the following properties:\n\n#### name\n\nType: `string`\n\n#### slug\n\nType: `string`\n\n#### locale\n\nType: `string`\n\nLocale of the realm, formatted as a [`IETF BCP 47` language tag](https://en.wikipedia.org/wiki/IETF_language_tag).\n\n#### timezone\n\nType: `string`\n\n#### online\n\nType: `boolean`\n\n#### type\n\nType: `string`\n\nPossible values are: `normal`, `pvp`, `rp`, `rppvp`.\n\n#### population\n\nType: `string`\n\nCurrent population of the realm.\u003cbr\u003e\nPossible values are: `very-low`, `low`, `medium`, `high`, `full`\n\n## Contributing\n\nContributions are always welcome! Please run `npm test` before hand to ensure everything is ok.\n\n## Support\n\nIf you use this package please consider starring it :)\n\n## Related\n\n* [wow-realm-status-cli](https://github.com/alvarocastro/wow-realm-status-cli) - CLI version of this library.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falvarocastro%2Fwow-realm-status","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falvarocastro%2Fwow-realm-status","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falvarocastro%2Fwow-realm-status/lists"}