### Making GET /userinfo Request

Source: https://community.developer.battle.net/documentation/guides/using-oauth/authorization-code-flow

This example shows how to make a GET request to the /userinfo endpoint to retrieve a user's Account ID and BattleTag. The access token must be provided in the Authorization header.

```bash
curl -X GET
    'https://oauth.battle.net/userinfo'
    -H 'Authorization: Bearer <access token>'
```

--------------------------------

### Example: Querying Realms with Login Queue

Source: https://community.developer.battle.net/documentation/world-of-warcraft/guides/search

This example demonstrates how to query for all connected realms that have a login queue by specifying the 'has_queue' field.

```http
/data/wow/search/connected-realm?namespace=dynamic-us&has_queue=true
```

--------------------------------

### Example: Querying Realms by Timezone

Source: https://community.developer.battle.net/documentation/world-of-warcraft/guides/search

This example shows how to query for connected realms within a specific timezone using nested field names.

```http
/data/wow/search/connected-realm?namespace=dynamic-us&realms.timezone=America/New_York
```

--------------------------------

### Example JSON with Localization

Source: https://community.developer.battle.net/documentation/guides/game-data-apis

This example demonstrates how localized strings are provided for a resource, including the HREF for a related resource and various language translations for the resource's name.

```json
{
  "key": {
    "href": "https://us.api.blizzard.com/data/wow/journal-instance/758?namespace=static-us"
  },
  "name": {
    "en_US": "Icecrown Citadel",
    "es_MX": "Ciudadela de la Corona de Hielo",
    "pt_BR": "Cidadela da Coroa de Gelo",
    "de_DE": "Die Eiskronenzitadelle",
    "en_GB": "Icecrown Citadel",
    "es_ES": "Ciudadela de la Corona de Hielo",
    "fr_FR": "Citadelle de la Couronne de glace",
    "it_IT": "Rocca della Corona di Ghiaccio",
    "ru_RU": "Цитадель Ледяной Короны",
    "ko_KR": "얼음왕관 성채",
    "zh_TW": "冰冠城塞",
    "zh_CN": "冰冠堡垒"
  },
  "id": 758
}
```

--------------------------------

### Example Character Render URL

Source: https://community.developer.battle.net/documentation/world-of-warcraft/guides/character-renders

An example of a complete URL for a character render, including the base URL, character details, and a fallback image query parameter.

```http
https://render-us.worldofwarcraft.com/character/tichondrius/00/000000000-avatar.jpg?alt=/shadow/avatar/2-1.jpg
```

--------------------------------

### GET /data/wow/tech-talent/index

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Returns an index of tech talents.

```APIDOC
## GET /data/wow/tech-talent/index

### Description
Returns an index of tech talents.

### Method
GET

### Endpoint
/data/wow/tech-talent/index

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/talent/index

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Returns an index of talents.

```APIDOC
## GET /data/wow/talent/index

### Description
Returns an index of talents.

### Method
GET

### Endpoint
/data/wow/talent/index

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/pvp-talent/index

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Returns an index of PvP talents.

```APIDOC
## GET /data/wow/pvp-talent/index

### Description
Returns an index of PvP talents.

### Method
GET

### Endpoint
/data/wow/pvp-talent/index

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/talent/{talentId}

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Returns a talent by ID.

```APIDOC
## GET /data/wow/talent/{talentId}

### Description
Returns a talent by ID.

### Method
GET

### Endpoint
/data/wow/talent/{talentId}

### Parameters
#### Path Parameters
- **{talentId}** (integer) - Required - The ID of the talent.

#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/tech-talent-tree/index

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Returns an index of tech talent trees.

```APIDOC
## GET /data/wow/tech-talent-tree/index

### Description
Returns an index of tech talent trees.

### Method
GET

### Endpoint
/data/wow/tech-talent-tree/index

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/media/tech-talent/{techTalentId}

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Returns media for a tech talent by ID.

```APIDOC
## GET /data/wow/media/tech-talent/{techTalentId}

### Description
Returns media for a tech talent by ID.

### Method
GET

### Endpoint
/data/wow/media/tech-talent/{techTalentId}

### Parameters
#### Path Parameters
- **{techTalentId}** (integer) - Required - The ID of the tech talent.

#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/tech-talent/{techTalentId}

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Returns a tech talent by ID.

```APIDOC
## GET /data/wow/tech-talent/{techTalentId}

### Description
Returns a tech talent by ID.

### Method
GET

### Endpoint
/data/wow/tech-talent/{techTalentId}

### Parameters
#### Path Parameters
- **{techTalentId}** (integer) - Required - The ID of the tech talent.

#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/title/index

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Returns an index of titles.

```APIDOC
## GET /data/wow/title/index

### Description
Returns an index of titles.

### Method
GET

### Endpoint
/data/wow/title/index

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/tech-talent-tree/{techTalentTreeId}

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Returns a tech talent tree by ID.

```APIDOC
## GET /data/wow/tech-talent-tree/{techTalentTreeId}

### Description
Returns a tech talent tree by ID.

### Method
GET

### Endpoint
/data/wow/tech-talent-tree/{techTalentTreeId}

### Parameters
#### Path Parameters
- **{techTalentTreeId}** (integer) - Required - The ID of the tech talent tree.

#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/media/journal-instance/{journalInstanceId}

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Returns media for a journal instance by its ID.

```APIDOC
## GET /data/wow/media/journal-instance/{journalInstanceId}

### Description
Returns media for a journal instance by ID.

### Method
GET

### Endpoint
/data/wow/media/journal-instance/{journalInstanceId}

### Parameters
#### Path Parameters
- **journalInstanceId** (integer) - Required - The ID of the journal instance.

#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.

### Response
#### Success Response (200)
- **assets** (array) - A list of media assets.
- **id** (integer) - The ID of the journal instance.

#### Response Example
```json
{
  "assets": [
    {
      "key": "icon",
      "value": "https://example.com/media/wow/journal-instance/icon/789.jpg"
    }
  ],
  "id": 789
}
```
```

--------------------------------

### GET /data/wow/pvp-talent/{pvpTalentId}

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Returns a PvP talent by ID.

```APIDOC
## GET /data/wow/pvp-talent/{pvpTalentId}

### Description
Returns a PvP talent by ID.

### Method
GET

### Endpoint
/data/wow/pvp-talent/{pvpTalentId}

### Parameters
#### Path Parameters
- **{pvpTalentId}** (integer) - Required - The ID of the PvP talent.

#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/realm/index

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Retrieves an index of all realms.

```APIDOC
## GET /data/wow/realm/index

### Description
Returns an index of realms.

### Method
GET

### Endpoint
/data/wow/realm/index

### Parameters
#### Path Parameters
- **region** (string) - Required - The region of the data to retrieve.

#### Query Parameters
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/journal-instance/index

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Returns an index of journal instances.

```APIDOC
## GET /data/wow/journal-instance/index

### Description
Returns an index of journal instances.

### Method
GET

### Endpoint
/data/wow/journal-instance/index

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.

### Response
#### Success Response (200)
- **journal_instances** (array) - An array of journal instances.

#### Response Example
```json
{
  "journal_instances": [
    {
      "key": {
        "href": "https://example.com/api/wow/journal-instance/789"
      },
      "name": "Example Instance",
      "id": 789
    }
  ]
}
```
```

--------------------------------

### GET /data/wow/journal-instance/{journalInstanceId}

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Returns a journal instance by its ID.

```APIDOC
## GET /data/wow/journal-instance/{journalInstanceId}

### Description
Returns a journal instance.

### Method
GET

### Endpoint
/data/wow/journal-instance/{journalInstanceId}

### Parameters
#### Path Parameters
- **journalInstanceId** (integer) - Required - The ID of the journal instance.

#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.

### Response
#### Success Response (200)
- **id** (integer) - The ID of the journal instance.
- **name** (string) - The name of the journal instance.
- **category** (string) - The category of the journal instance.
- **difficulty** (object) - The difficulty settings for the instance.
- **max_player** (integer) - The maximum number of players allowed.
- **min_player** (integer) - The minimum number of players required.
- **journal_encounters** (array) - A list of journal encounters within this instance.

#### Response Example
```json
{
  "id": 789,
  "name": "Example Instance",
  "category": "Raid",
  "difficulty": {
    "type": "Mythic",
    "name": "Mythic Difficulty"
  },
  "max_player": 20,
  "min_player": 10,
  "journal_encounters": [
    {
      "id": 101,
      "name": "Encounter 1"
    }
  ]
}
```
```

--------------------------------

### GET /data/wow/item-appearance/set/index

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Retrieves an index of item appearance sets.

```APIDOC
## GET /data/wow/item-appearance/set/index

### Description
Returns an index of item appearance sets.

### Method
GET

### Endpoint
/data/wow/item-appearance/set/index

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/item-appearance/slot/index

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Retrieves an index of item appearance slots.

```APIDOC
## GET /data/wow/item-appearance/slot/index

### Description
Returns an index of item appearance slots.

### Method
GET

### Endpoint
/data/wow/item-appearance/slot/index

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/journal-expansion/index

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Retrieves an index of journal expansions.

```APIDOC
## GET /data/wow/journal-expansion/index

### Description
Returns an index of journal expansions.

### Method
GET

### Endpoint
/data/wow/journal-expansion/index

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/search/item-appearance

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Performs a search of item appearances.

```APIDOC
## GET /data/wow/search/item-appearance

### Description
Performs a search of item appearances. The fields below are provided for example. For more detail see the Search Guide.

### Method
GET

### Endpoint
/data/wow/search/item-appearance

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **slot.type** (string) - Optional - The slot type of the item appearance. (example search field)
- **orderby** (string) - Optional - The field to sort the result set by.
- **_page** (integer) - Optional - The result page number.
```

--------------------------------

### GET /data/wow/creature-type/index

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Retrieves an index of all available creature types.

```APIDOC
## GET /data/wow/creature-type/index

### Description
Returns an index of creature types.

### Method
GET

### Endpoint
/data/wow/creature-type/index

### Parameters
#### Path Parameters
- **region** (string) - Required - The region of the data to retrieve.

#### Query Parameters
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/item-class/index

Source: https://community.developer.battle.net/documentation/world-of-warcraft-classic/game-data-apis

Retrieves an index of all available item classes in World of Warcraft.

```APIDOC
## GET /data/wow/item-class/index

### Description
Returns an index of item classes.

### Method
GET

### Endpoint
/data/wow/item-class/index

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/guild-crest/index

Source: https://community.developer.battle.net/documentation/world-of-warcraft-classic/game-data-apis

Retrieves an index of all available guild crest media components.

```APIDOC
## GET /data/wow/guild-crest/index

### Description
Returns an index of guild crest media.

### Method
GET

### Endpoint
/data/wow/guild-crest/index

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### Sample Item Document

Source: https://community.developer.battle.net/documentation/world-of-warcraft/guides/media-documents

This JSON object represents a sample item document, including a 'media' property that links to a generic media document.

```json
{
  "_links": {
    "self": {
      "href": "https://us.api.blizzard.com/data/wow/item/19019?namespace=static-us"
    }
  },
  "id": 19019,
  "name": {
    "en_US": "Thunderfury, Blessed Blade of the Windseeker",
    "es_MX": "Trueno Furioso, espada bendita del Hijo del Viento",
    "pt_BR": "Tormentária, Lâmina Sagrada do Perseguidor dos Ventos",
    "de_DE": "Donnerzorn, Gesegnete Klinge des Windsuchers",
    "en_GB": "Thunderfury, Blessed Blade of the Windseeker",
    "es_ES": "Trueno Furioso, Espada Bendita del Hijo del Viento",
    "fr_FR": "Lame-tonnerre, épée bénie du Cherchevent",
    "it_IT": "Furiatonante, Lama Benedetta del Vento Eterno",
    "ru_RU": "Громовая Ярость, благословенный клинок Искателя Ветра",
    "ko_KR": "우레폭풍 - 바람추적자의 성검",
    "zh_TW": "雷霆之怒，逐風者的祝福之刃",
    "zh_CN": "雷霆之怒，逐风者的祝福之剑"
  },
  "media": {
    "key": {
      "href": "https://us.api.blizzard.com/data/wow/media/item/19019?namespace=static-us"
    },
    "id": 19019
  }
}
```

--------------------------------

### GET /data/wow/title/{titleId}

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Returns a title by ID.

```APIDOC
## GET /data/wow/title/{titleId}

### Description
Returns a title by ID.

### Method
GET

### Endpoint
/data/wow/title/{titleId}

### Parameters
#### Path Parameters
- **{titleId}** (integer) - Required - The ID of the title.

#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### Sample Media Document

Source: https://community.developer.battle.net/documentation/world-of-warcraft/guides/media-documents

This JSON object represents a sample media document, containing assets such as an icon URL.

```json
{
  "_links": {
    "self": {
      "href": "https://us.api.blizzard.com/data/wow/media/item/19019?namespace=static-us"
    }
  },
  "assets": [
    {
      "key": "icon",
      "value": "https://render-us.worldofwarcraft.com/icons/56/inv_sword_39.jpg"
    }
  ],
  "id": 19019
}
```

--------------------------------

### GET /data/wow/quest/type/index

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Retrieves an index of all quest types.

```APIDOC
## GET /data/wow/quest/type/index

### Description
Returns an index of quest types (such as PvP quests, raid quests, or account quests).

### Method
GET

### Endpoint
/data/wow/quest/type/index

### Parameters
#### Path Parameters
- **region** (string) - Required - The region of the data to retrieve.

#### Query Parameters
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/quest/area/index

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Retrieves an index of all quest areas.

```APIDOC
## GET /data/wow/quest/area/index

### Description
Returns an index of quest areas.

### Method
GET

### Endpoint
/data/wow/quest/area/index

### Parameters
#### Path Parameters
- **region** (string) - Required - The region of the data to retrieve.

#### Query Parameters
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### Toy API - Toy Index

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Retrieves an index of all available toys in World of Warcraft.

```APIDOC
## GET /data/wow/toy/index

### Description
Returns an index of toys.

### Method
GET

### Endpoint
/data/wow/toy/index

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/quest/category/index

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Retrieves an index of all quest categories.

```APIDOC
## GET /data/wow/quest/category/index

### Description
Returns an index of quest categories (such as quests for a specific class, profession, or storyline).

### Method
GET

### Endpoint
/data/wow/quest/category/index

### Parameters
#### Path Parameters
- **region** (string) - Required - The region of the data to retrieve.

#### Query Parameters
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /profile/wow/character/{realmSlug}/{characterName}/equipment

Source: https://community.developer.battle.net/documentation/world-of-warcraft/profile-apis

Retrieves a summary of the items equipped by a character.

```APIDOC
## GET /profile/wow/character/{realmSlug}/{characterName}/equipment

### Description
Returns a summary of the items equipped by a character.

### Method
GET

### Endpoint
/profile/wow/character/{realmSlug}/{characterName}/equipment

### Parameters
#### Path Parameters
- **realmSlug** (string) - Required - The slug of the realm.
- **characterName** (string) - Required - The lowercase name of the character.

#### Query Parameters
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
- **region** (string) - Required - The region of the data to retrieve.
```

--------------------------------

### GET /data/wow/search/journal-encounter

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Performs a search of journal encounters.

```APIDOC
## GET /data/wow/search/journal-encounter

### Description
Performs a search of journal encounters. The fields below are provided for example. For more detail see the Search Guide.

### Method
GET

### Endpoint
/data/wow/search/journal-encounter

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **instance.name.en_US** (string) - Optional - The instance name where an encounter appears. (example search field)
- **orderby** (string) - Optional - The field to sort the result set by.
- **_page** (integer) - Optional - The result page number.

### Response
#### Success Response (200)
- **results** (array) - An array of journal encounter search results.

#### Response Example
```json
{
  "results": [
    {
      "id": 1,
      "name": "Example Encounter",
      "journal_instance": {
        "key": {
          "href": "https://example.com/api/wow/journal-instance/789"
        },
        "name": "Example Instance",
        "id": 789
      }
    }
  ]
}
```
```

--------------------------------

### GET /data/wow/media/creature-display/{creatureDisplayId}

Source: https://community.developer.battle.net/documentation/world-of-warcraft-classic/game-data-apis

Retrieves media assets for a specific creature display ID.

```APIDOC
## GET /data/wow/media/creature-display/{creatureDisplayId}

### Description
Returns media for a creature display by ID.

### Method
GET

### Endpoint
/data/wow/media/creature-display/{creatureDisplayId}

### Parameters
#### Path Parameters
- **creatureDisplayId** (integer) - Required - The ID of the creature display.

#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/journal-encounter/index

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Retrieves an index of journal encounters.

```APIDOC
## GET /data/wow/journal-encounter/index

### Description
Returns an index of journal encounters.

### Method
GET

### Endpoint
/data/wow/journal-encounter/index

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
```

--------------------------------

### Retrieve Access Token with CURL

Source: https://community.developer.battle.net/documentation/guides/using-oauth/client-credentials-flow

Use this CURL command to exchange client credentials for an access token. Ensure you replace `{client_id}` and `{client_secret}` with your actual credentials.

```bash
curl -u {client_id}:{client_secret} -d grant_type=client_credentials https://oauth.battle.net/token
```

--------------------------------

### Sample Character Render Request with Fallback

Source: https://community.developer.battle.net/documentation/world-of-warcraft/guides/character-renders

Construct a request URL by combining the avatar URL with the fallback image parameter. Ensure 'avatar_url', 'race-id', and 'gender-id' are correctly substituted.

```http
{avatar-url}?alt=/shadow/avatar/{race-id}-{gender-id}.jpg
```

--------------------------------

### GET /data/wow/quest/{questId}

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Retrieves a specific quest by its ID.

```APIDOC
## GET /data/wow/quest/{questId}

### Description
Returns a quest by ID.

### Method
GET

### Endpoint
/data/wow/quest/{questId}

### Parameters
#### Path Parameters
- **questId** (integer) - Required - The ID of the quest.
- **region** (string) - Required - The region of the data to retrieve.

#### Query Parameters
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/modified-crafting/category/index

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Returns the index of Modified Crafting categories.

```APIDOC
## GET /data/wow/modified-crafting/category/index

### Description
Returns the index of Modified Crafting categories.

### Method
GET

### Endpoint
/data/wow/modified-crafting/category/index

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.

### Response
#### Success Response (200)
- **modified_crafting_categories** (array) - An array of modified crafting categories.

#### Response Example
```json
{
  "modified_crafting_categories": [
    {
      "key": {
        "href": "https://example.com/api/wow/modified-crafting/category/1"
      },
      "name": "Example Category",
      "id": 1
    }
  ]
}
```
```

--------------------------------

### Pet Abilities Index API

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Returns an index of all available pet abilities in World of Warcraft.

```APIDOC
## GET /data/wow/pet-ability/index

### Description
Returns an index of pet abilities.

### Method
GET

### Endpoint
/data/wow/pet-ability/index

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/modified-crafting/index

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Returns the parent index for Modified Crafting.

```APIDOC
## GET /data/wow/modified-crafting/index

### Description
Returns the parent index for Modified Crafting.

### Method
GET

### Endpoint
/data/wow/modified-crafting/index

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.

### Response
#### Success Response (200)
- **modified_crafting_categories** (array) - An array of modified crafting categories.

#### Response Example
```json
{
  "modified_crafting_categories": [
    {
      "key": {
        "href": "https://example.com/api/wow/modified-crafting/category/1"
      },
      "name": "Example Category",
      "id": 1
    }
  ]
}
```
```

--------------------------------

### GET /data/wow/media/creature-family/{creatureFamilyId}

Source: https://community.developer.battle.net/documentation/world-of-warcraft-classic/game-data-apis

Retrieves media assets for a specific creature family ID.

```APIDOC
## GET /data/wow/media/creature-family/{creatureFamilyId}

### Description
Returns media for a creature family by ID.

### Method
GET

### Endpoint
/data/wow/media/creature-family/{creatureFamilyId}

### Parameters
#### Path Parameters
- **creatureFamilyId** (integer) - Required - The ID of the creature family.

#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### Account Decor Collection Summary API

Source: https://community.developer.battle.net/documentation/world-of-warcraft/profile-apis

Retrieves a summary of the housing decor an account has collected.

```APIDOC
## GET /profile/user/wow/collections/decor

### Description
Returns a summary of the housing decor an account has collected.

### Method
GET

### Endpoint
/profile/user/wow/collections/decor

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### GET /data/wow/search/media

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Performs a search of all types of media documents.

```APIDOC
## GET /data/wow/search/media

### Description
Performs a search of all types of media documents. The fields below are provided for example. For more detail see the Search Guide.

### Method
GET

### Endpoint
/data/wow/search/media

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **tags** (string) - Optional - The media document type as derived from the URL. For example, /wow/media/item/{id} will have tag 'item'. (example search field)
- **orderby** (string) - Optional - The field to sort the result set by.
- **_page** (integer) - Optional - The result page number.

### Response
#### Success Response (200)
- **results** (array) - An array of media search results.

#### Response Example
```json
{
  "results": [
    {
      "id": 123,
      "name": "Example Media Item",
      "media_type": "item"
    }
  ]
}
```
```

--------------------------------

### GET /profile/wow/character/{realmSlug}/{characterName}/specializations

Source: https://community.developer.battle.net/documentation/world-of-warcraft/profile-apis

Returns a summary of a character's specializations.

```APIDOC
## GET /profile/wow/character/{realmSlug}/{characterName}/specializations

### Description
Returns a summary of a character's specializations.

### Method
GET

### Endpoint
/profile/wow/character/{realmSlug}/{characterName}/specializations

### Parameters
#### Path Parameters
- **realmSlug** (string) - Required - The slug of the realm.
- **characterName** (string) - Required - The lowercase name of the character.

#### Query Parameters
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
- **region** (string) - Required - The region of the data to retrieve.
```

--------------------------------

### Profile API - Static Data

Source: https://community.developer.battle.net/documentation/starcraft-2/community-apis

Retrieves all static StarCraft II profile data including achievements, categories, criteria, and rewards.

```APIDOC
## GET /sc2/static/profile/:regionId

### Description
Returns all static SC2 profile data (achievements, categories, criteria, and rewards).

### Method
GET

### Endpoint
/sc2/static/profile/:regionId

### Parameters
#### Path Parameters
- **regionId** (integer) - Required - The region for the profile (`1`=US, `2`=EU, `3`=KO and TW, `5`=CN).

#### Query Parameters
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### Profile API - Ladder Summary

Source: https://community.developer.battle.net/documentation/starcraft-2/community-apis

Retrieves a ladder summary for an individual SC2 profile.

```APIDOC
## GET /sc2/profile/:regionId/:realmId/:profileId/ladder/summary

### Description
Returns a ladder summary for an individual SC2 profile.

### Method
GET

### Endpoint
/sc2/profile/:regionId/:realmId/:profileId/ladder/summary

### Parameters
#### Path Parameters
- **regionId** (integer) - Required - The region for the profile (`1`=US, `2`=EU, `3`=KO and TW, `5`=CN).
- **realmId** (integer) - Required - The region of the profile (`1` or `2`).
- **profileId** (integer) - Required - The profile ID.

#### Query Parameters
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/creature-family/index

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Retrieves an index of all available creature families.

```APIDOC
## GET /data/wow/creature-family/index

### Description
Returns an index of creature families.

### Method
GET

### Endpoint
/data/wow/creature-family/index

### Parameters
#### Path Parameters
- **region** (string) - Required - The region of the data to retrieve.

#### Query Parameters
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/talent-tree/{talentTreeId}

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Returns all talent tree nodes as well as links to associated playable specializations given a talent tree id. This is useful to generate loadout export codes.

```APIDOC
## GET /data/wow/talent-tree/{talentTreeId}

### Description
Returns all talent tree nodes as well as links to associated playable specializations given a talent tree id. This is useful to generate loadout export codes.

### Method
GET

### Endpoint
/data/wow/talent-tree/{talentTreeId}

### Parameters
#### Path Parameters
- **{talentTreeId}** (integer) - Required - The ID of the talent-tree.

#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### GET /data/wow/covenant/conduit/{conduitId}

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Retrieves a specific conduit by its ID.

```APIDOC
## GET /data/wow/covenant/conduit/{conduitId}

### Description
Returns a conduit by ID.

### Method
GET

### Endpoint
/data/wow/covenant/conduit/{conduitId}

### Parameters
#### Path Parameters
- **conduitId** (integer) - Required - The ID of the conduit.
- **region** (string) - Required - The region of the data to retrieve.

#### Query Parameters
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### Housing Decor API

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Provides access to housing decor data, including an index, individual decor details, and search functionality.

```APIDOC
## GET /data/wow/decor/index

### Description
Returns an index of decor.

### Method
GET

### Endpoint
/data/wow/decor/index

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.

## GET /data/wow/decor/{decorId}

### Description
Returns a decor by ID.

### Method
GET

### Endpoint
/data/wow/decor/{decorId}

### Parameters
#### Path Parameters
- **decorId** (string) - Required - The ID of the decor.

#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.

## GET /data/wow/search/decor

### Description
Performs a search of decor. The fields below are provided for example. For more detail see the Search Guide.

### Method
GET

### Endpoint
/data/wow/search/decor

### Parameters
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **name.en_US** (string) - Optional - The name of the decor. (example search field)
- **orderby** (string) - Optional - The field to sort the result set by.
- **_page** (integer) - Optional - The result page number.
```

--------------------------------

### World of Warcraft Classic Localization

Source: https://community.developer.battle.net/documentation/world-of-warcraft-classic/guides/localization

This section details how to handle localized fields in the World of Warcraft Classic API. It covers supported locales and how the API behaves with and without locale specification.

```APIDOC
## Supported Locales

The World of Warcraft API supports the following locales:

| Locale | Value |
|---|---|
| English (United States) | en_US |
| Spanish (Mexico) | es_MX |
| Portuguese | pt_BR |
| German | de_DE |
| English (Great Britain) | en_GB |
| Spanish (Spain) | es_ES |
| French | fr_FR |
| Italian | it_IT |
| Russian | ru_RU |
| Korean | ko_KR |
| Chinese (Traditional) | zh_TW |
| Chinese (Simplified) | zh_CN |

## Default Behavior

When you request a resource without specifying a locale, the API returns all supported localized values for a localized field. In the following example, the `name` field is a localized field.

```json
{
  "faction": {
    "type": "ALLIANCE",
    "name": {
      "en_US": "Alliance",
      "es_MX": "Alianza",
      "pt_BR": "Aliança",
      "de_DE": "Allianz",
      "en_GB": "Alliance",
      "es_ES": "Alianza",
      "fr_FR": "Alliance",
      "it_IT": "Alleanza",
      "ru_RU": "Альянс",
      "ko_KR": "얼라이언스",
      "zh_TW": "聯盟",
      "zh_CN": "联盟"
    }
  }
}
```

## Specifying a Locale

A locale is specified as a query parameter:

| Type | Format | Example |
|---|---|---|
| Query Parameter | ?locale={locale} | ?locale=ko_KR |

If you request a resource with the **locale** query parameter, the API flattens localized fields, only including the value for the requested localization. For example, if the above JSON were requested with `?locale=ko_KR`, the response would be:

```json
{
  "faction": {
    "type": "ALLIANCE",
    "name": "얼라이언스"
  }
}
```
```

--------------------------------

### Authorization Code Flow - Obtaining Authorization

Source: https://community.developer.battle.net/documentation/guides/using-oauth/authorization-code-flow

This section details how to initiate the Authorization Code Flow by redirecting the user's browser to the authorization URI with the necessary query parameters.

```APIDOC
## Authorization Code Flow - Obtaining Authorization

### Description
Initiate the Authorization Code Flow by redirecting the user's browser to the authorize URI with the following query parameters.

### Method
GET

### Endpoint
https://oauth.battle.net/authorize

### Parameters
#### Query Parameters
- **client_id** (string) - Required - The developer's client ID.
- **scope** (string) - Required - The space-separated scope values to request from the player.
- **state** (string) - Required - A semi-random data blob to send back with when completing authorization.
- **redirect_uri** (string) - Required - The redirect location. Should either be https://localhost for testing or the redirect_uri configured in the API Access tool.
- **response_type** (string) - Required - The code type being requested. For the authorization code flow, this value should be "code".

### Request Example
```
https://oauth.battle.net/authorize
            ?response_type=code
            &scope=openid
            &state=AbCdEfG
            &redirect_uri=https://localhost
            &client_id=<CLIENT ID>
```

### Response
After the player has granted authorization, the auth provider redirects the browser to the specified `redirect_uri` and includes the provided `state` and a single-use `code` as query parameters.
```

--------------------------------

### GET /data/wow/quest/type/{questTypeId}

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Retrieves a specific quest type by its ID.

```APIDOC
## GET /data/wow/quest/type/{questTypeId}

### Description
Returns a quest type by ID.

### Method
GET

### Endpoint
/data/wow/quest/type/{questTypeId}

### Parameters
#### Path Parameters
- **questTypeId** (string) - Required - The ID of the quest type.
- **region** (string) - Required - The region of the data to retrieve.

#### Query Parameters
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```

--------------------------------

### Pet Media API

Source: https://community.developer.battle.net/documentation/world-of-warcraft/game-data-apis

Fetches media assets for a specific battle pet by its ID.

```APIDOC
## GET /data/wow/media/pet/{petId}

### Description
Returns media for a battle pet by ID.

### Method
GET

### Endpoint
/data/wow/media/pet/{petId}

### Parameters
#### Path Parameters
- **petId** (integer) - Required - The ID of the pet.
#### Query Parameters
- **region** (string) - Required - The region of the data to retrieve.
- **namespace** (string) - Required - The namespace to use to locate this document.
- **locale** (string) - Optional - The locale to reflect in localized data.
```