WowQL

A GraphQL wrapper for the World of Warcraft Game Data APIs and Profile APIs. Built with Apollo Server.

Some WoW endpoints still need to be implemented. See the Implementation Status section for a list of the WoW endpoints and their status.

Quick Start

1. Install dependencies

   npm install
   

2. Update environment variables

   Rename .env.example to .env and set the following variables:

   PORT=4000
   REDIS_HOST="redis server ip"
   REDIS_PORT=6379
   REDIS_PASSWORD="password"
   CLIENT_ID="blizzard battle.net client id"
   CLIENT_SECRET="blizzard battle.net client secret"
   OAUTH_SUCCESS_REDIRECT="successful login redirect url"
   OAUTH_FAILURE_REDIRECT="failed login redirect url"
   

   • The port to run the server on
   • The Redis server IP
   • The port the Redis server runs on
   • The Redis server password
   • Your Client ID and Client Secret from your Blizzard Battle.net OAuth client
   • The URL to redirect clients to on a successful login
   • The URL to redirect clients to on a failed login

3. Start Redis in a Docker container

   docker-compose up -d
   

4. Start the server

   npm start
   

GraphQL Playground

Apollo Server provides GraphQL Playground for you to test your GraphQL queries before implementing them in client code.

With your server running, go to http://localhost:4000/api in your browser to open GraphQL Playground. It includes:

• A text area for writing queries
• A play button to execute queries
• A text area for viewing query results
• Views for schema inspection and generated documentation

Schema Documentation

In addition to the documentation generated by GraphQL Playground, schema documentation is also available as browsable webpages via graphdoc.

Run the following command to generate the webpages, which can be hosted on a web server. A docs/ directory will be created in the root of the project.

npm run graphdoc

Roadmap

• Implement the rest of the WoW API endpoints
• Implement unit tests
• Allow for query params (namespace, region, locale, etc.)

Implementation Status

The GraphQL implementation status of each WoW API endpoint is listed below.

Game Data APIs

Name	Endpoint	Status
Achievement Categories Index	/data/wow/achievement-category/index	Not Started
Achievement Category	/data/wow/achievement-category/{achievementCategoryId}	Not Started
Achievements Index	/data/wow/achievement/index	Not Started
Achievement	/data/wow/achievement/{achievementId}	Not Started
Achievement Media	/data/wow/media/achievement/{achievementId}	Not Started
Auctions	/data/wow/connected-realm/{connectedRealmId}/auctions	Not Started
Azerite Essences Index	/data/wow/azerite-essence/index	Not Started
Azerite Essence	/data/wow/azerite-essence/{azeriteEssenceId}	Not Started
Azerite Essence Media	/data/wow/media/azerite-essence/{azeriteEssenceId}	Not Started
Connected Realms Index	/data/wow/connected-realm/index	Not Started
Connected Realm	/data/wow/connected-realm/{connectedRealmId}	Not Started
Creature Families Index	/data/wow/creature-family/index	Not Started
Creature Family	/data/wow/creature-family/{creatureFamilyId}	Not Started
Creature Types Index	/data/wow/creature-type/index	Not Started
Creature Type	/data/wow/creature-type/{creatureTypeId}	Not Started
Creature	/data/wow/creature/{creatureId}	Not Started
Creature Display Media	/data/wow/media/creature-display/{creatureDisplayId}	Not Started
Creature Family Media	/data/wow/media/creature-family/{creatureFamilyId}	Not Started
Guild Crest Components Index	/data/wow/guild-crest/index	Not Started
Guild Crest Border Media	/data/wow/media/guild-crest/border/{borderId}	Not Started
Guild Crest Emblem Media	/data/wow/media/guild-crest/emblem/{emblemId}	Not Started
Item Classes Index	/data/wow/item-class/index	Not Started
Item Class	/data/wow/item-class/{itemClassId}	Not Started
Item Sets Index	/data/wow/item-set/index	Not Started
Item Set	/data/wow/item-set/{itemSetId}	Not Started
Item Subclass	/data/wow/item-class/{itemClassId}/item-subclass/{itemSubclassId}	Not Started
Item	/data/wow/item/{itemId}	Not Started
Item Media	/data/wow/media/item/{itemId}	Not Started
Journal Expansions Index	/data/wow/journal-expansion/index	Not Started
Journal Expansion	/data/wow/journal-expansion/{journalExpansionId}	Not Started
Journal Encounters Index	/data/wow/journal-encounter/index	Not Started
Journal Encounter	/data/wow/journal-encounter/{journalEncounterId}	Not Started
Journal Instances Index	/data/wow/journal-instance/index	Not Started
Journal Instance	/data/wow/journal-instance/{journalInstanceId}	Not Started
Mounts Index	/data/wow/mount/index	Not Started
Mount	/data/wow/mount/{mountId}	Not Started
Mythic Keystone Affixes Index	/data/wow/keystone-affix/index	Not Started
Mythic Keystone Affix	/data/wow/keystone-affix/{keystoneAffixId}	Not Started
Mythic Keystone Affix Media	/data/wow/media/keystone-affix/{keystoneAffixId}	Not Started
Mythic Keystone Dungeons Index	/data/wow/media/keystone-affix/{keystoneAffixId}	Not Started
Mythic Keystone Dungeon	/data/wow/mythic-keystone/dungeon/{dungeonId}	Not Started
Mythic Keystone Index	/data/wow/mythic-keystone/index	Not Started
Mythic Keystone Periods Index	/data/wow/mythic-keystone/period/index	Not Started
Mythic Keystone Period	/data/wow/mythic-keystone/period/{periodId}	Not Started
Mythic Keystone Seasons Index	/data/wow/mythic-keystone/season/index	Not Started
Mythic Keystone Season	/data/wow/mythic-keystone/season/{seasonId}	Not Started
Mythic Keystone Leaderboards Index	/data/wow/connected-realm/{connectedRealmId}/mythic-leaderboard/index	Not Started
Mythic Keystone Leaderboard	/data/wow/connected-realm/{connectedRealmId}/mythic-leaderboard/{dungeonId}/period/{period}	Not Started
Mythic Raid Leaderboard	/data/wow/leaderboard/hall-of-fame/{raid}/{faction}	Not Started
Pets Index	/data/wow/pet/index	Not Started
Pet	/data/wow/pet/{petId}	Not Started
Playable Classes Index	/data/wow/playable-class/index	Not Started
Playable Class	/data/wow/playable-class/{classId}	Not Started
Playable Class Media	/data/wow/media/playable-class/{playableClassId}	Not Started
PvP Talent Slots	/data/wow/playable-class/{classId}/pvp-talent-slots	Not Started
Playable Races Index	/data/wow/playable-race/index	Not Started
Playable Race	/data/wow/playable-race/{playableRaceId}	Not Started
Playable Specializations Index	/data/wow/playable-specialization/index	Not Started
Playable Specialization	/data/wow/playable-specialization/{specId}	Not Started
Playable Specialization Media	/data/wow/media/playable-specialization/{specId}	Not Started
Power Types Index	/data/wow/power-type/index	Not Started
Power Type	/data/wow/power-type/{powerTypeId}	Not Started
PvP Seasons Index	/data/wow/pvp-season/index	Not Started
PvP Season	/data/wow/pvp-season/{pvpSeasonId}	Not Started
PvP Leaderboards Index	/data/wow/pvp-season/{pvpSeasonId}/pvp-leaderboard/index	Not Started
PvP Leaderboard	/data/wow/pvp-season/{pvpSeasonId}/pvp-leaderboard/{pvpBracket}	Not Started
PvP Rewards Index	/data/wow/pvp-season/{pvpSeasonId}/pvp-reward/index	Not Started
PvP Tier Media	/data/wow/media/pvp-tier/{pvpTierId}	Not Started
PvP Tiers Index	/data/wow/pvp-tier/index	Not Started
PvP Tier	/data/wow/pvp-tier/{pvpTierId}	Not Started
Quests Index	/data/wow/quest/index	Not Started
Quest	/data/wow/quest/{questId}	Not Started
Quest Categories Index	/data/wow/quest/category/index	Not Started
Quest Category	/data/wow/quest/category/{questCategoryId}	Not Started
Quest Areas Index	/data/wow/quest/area/index	Not Started
Quest Area	/data/wow/quest/area/{questAreaId}	Not Started
Quest Types Index	/data/wow/quest/type/index	Not Started
Quest Type	/data/wow/quest/type/{questTypeId}	Not Started
Realms Index	/data/wow/realm/index	Not Started
Realm	/data/wow/realm/{realmSlug}	Not Started
Regions Index	/data/wow/region/index	Not Started
Region	/data/wow/region/{regionId}	Not Started
Reputation Factions Index	/data/wow/reputation-faction/index	Not Started
Reputation Faction	/data/wow/reputation-faction/{reputationFactionId}	Not Started
Reputation Tiers Index	/data/wow/reputation-tiers/index	Not Started
Reputation Tiers	/data/wow/reputation-tiers/{reputationTiersId}	Not Started
Spell	/data/wow/spell/{spellId}	Not Started
Spell Media	/data/wow/media/spell/{spellId}	Not Started
Talents Index	/data/wow/talent/index	Not Started
Talent	/data/wow/talent/{talentId}	Not Started
PvP Talents Index	/data/wow/pvp-talent/index	Not Started
PvP Talent	/data/wow/pvp-talent/{pvpTalentId}	Not Started
Titles Index	/data/wow/title/index	Not Started
Title	/data/wow/title/{titleId}	Not Started
WoW Token Index	/data/wow/token/index	Not Started

Profile APIs

Name	Endpoint	Status
Account Profile Summary	/profile/user/wow	Completed
Protected Character Profile Summary	/profile/user/wow/protected-character/{realmId}-{characterId}	Not Started
Account Collections Index	/profile/user/wow/collections	Not Started
Account Mounts Collections Summary	/profile/user/wow/collections/mounts	Not Started
Character Achievements Summary	/profile/wow/character/{realmSlug}/{characterName}/achievements	Not Started
Character Achievement Statistics	/profile/wow/character/{realmSlug}/{characterName}/achievements/statistics	Not Started
Character Appearance Summary	/profile/wow/character/{realmSlug}/{characterName}/appearance	Not Started
Character Collections Index	/profile/wow/character/{realmSlug}/{characterName}/collections	Not Started
Character Mounts Collection Summary	/profile/wow/character/{realmSlug}/{characterName}/collections/mounts	Not Started
Character Pets Collection Summary	/profile/wow/character/{realmSlug}/{characterName}/collections/pets	Not Started
Character Equipment Summary	/profile/wow/character/{realmSlug}/{characterName}/equipment	Completed
Character Hunter Pets Summary	/profile/wow/character/{realmSlug}/{characterName}/hunter-pets	Not Started
Character Media Summary	/profile/wow/character/{realmSlug}/{characterName}/character-media	Completed
Character Mythic Keystone Profile Index	/profile/wow/character/{realmSlug}/{characterName}/mythic-keystone-profile	Not Started
Character Mythic Keystone Season Details	/profile/wow/character/{realmSlug}/{characterName}/mythic-keystone-profile/season/{seasonId}	Not Started
Character Profile Summary	/profile/wow/character/{realmSlug}/{characterName}	Completed
Character Profile Status	/profile/wow/character/{realmSlug}/{characterName}/status	Not Started
Character PvP Bracket Statistics	/profile/wow/character/{realmSlug}/{characterName}/pvp-bracket/{pvpBracket}	Not Started
Character PvP Summary	/profile/wow/character/{realmSlug}/{characterName}/pvp-summary	Not Started
Character Quests	/profile/wow/character/{realmSlug}/{characterName}/quests	Not Started
Character Completed Quests	/profile/wow/character/{realmSlug}/{characterName}/quests/completed	Not Started
Character Reputations Summary	/profile/wow/character/{realmSlug}/{characterName}/reputations	Completed
Character Specializations Summary	/profile/wow/character/{realmSlug}/{characterName}/specializations	Not Started
Character Statistics Summary	/profile/wow/character/{realmSlug}/{characterName}/statistics	Not Started
Character Titles Summary	/profile/wow/character/{realmSlug}/{characterName}/titles	Not Started
Guild	/data/wow/guild/{realmSlug}/{nameSlug}	Not Started
Guild Activity	/data/wow/guild/{realmSlug}/{nameSlug}/activity	Not Started
Guild Achievements	/data/wow/guild/{realmSlug}/{nameSlug}/achievements	Not Started
Guild Roster	/data/wow/guild/{realmSlug}/{nameSlug}/roster	Not Started