Activision Blizzard Character Encounters API

openapi: 3.2.0
info:
  title: Battle.net World of Warcraft Character Encounters API
  version: 1.0.0
  description: World of Warcraft API from Blizzard Entertainment (Activision Blizzard, part of Microsoft Gaming), converted field-for-field from the machine-readable API reference the Battle.net Community Developer Portal serves at community.developer.battle.net/api/pages/content/documentation/*.json (saved verbatim in openapi/_original/battle-net-reference/). Response schemas are not published in that reference.
  contact:
    name: Battle.net Community Developer Portal
    url: https://community.developer.battle.net/
  termsOfService: https://www.blizzard.com/en-us/legal/a2aefd3f-87e1-4a35-a38d-e0f7a8f42a00/blizzard-developer-api-terms-of-use
  x-generated-from: provider-reference-json
  x-derived-from:
  - openapi/_original/battle-net-reference/world-of-warcraft-game-data-apis.json
  - openapi/_original/battle-net-reference/world-of-warcraft-profile-apis.json
  x-derived: '2026-11-04'
servers:
- url: https://{region}.api.blizzard.com
  description: Global regions (documented host format {region}.api.blizzard.com)
  variables:
    region:
      enum:
      - us
      - eu
      - kr
      - tw
      default: us
- url: https://gateway.battlenet.com.cn
  description: China region host (documented in Regionality and APIs / game data host names)
security:
- oauth2: []
tags:
- name: Character Encounters API
paths:
  /profile/wow/character/{realmSlug}/{characterName}/encounters:
    get:
      operationId: characterEncountersSummary
      summary: Character Encounters Summary
      description: Returns a summary of a character's encounters.
      tags:
      - Character Encounters API
      x-source: https://community.developer.battle.net/documentation/world-of-warcraft/profile-apis
      parameters:
      - name: realmSlug
        in: path
        required: true
        description: The slug of the realm.
        schema:
          type: string
          default: tichondrius
      - name: characterName
        in: path
        required: true
        description: The lowercase name of the character.
        schema:
          type: string
          default: charactername
      - name: namespace
        in: query
        required: true
        description: The namespace to use to locate this document.
        schema:
          type: string
          default: profile-us
      - name: locale
        in: query
        required: false
        description: The locale to reflect in localized data.
        schema:
          type: string
          default: en_US
      responses:
        '200':
          description: Successful response (response schema not published in the reference).
  /profile/wow/character/{realmSlug}/{characterName}/encounters/dungeons:
    get:
      operationId: characterDungeons
      summary: Character Dungeons
      description: Returns a summary of a character's completed dungeons.
      tags:
      - Character Encounters API
      x-source: https://community.developer.battle.net/documentation/world-of-warcraft/profile-apis
      parameters:
      - name: realmSlug
        in: path
        required: true
        description: The slug of the realm.
        schema:
          type: string
          default: tichondrius
      - name: characterName
        in: path
        required: true
        description: The lowercase name of the character.
        schema:
          type: string
          default: charactername
      - name: namespace
        in: query
        required: true
        description: The namespace to use to locate this document.
        schema:
          type: string
          default: profile-us
      - name: locale
        in: query
        required: false
        description: The locale to reflect in localized data.
        schema:
          type: string
          default: en_US
      responses:
        '200':
          description: Successful response (response schema not published in the reference).
  /profile/wow/character/{realmSlug}/{characterName}/encounters/raids:
    get:
      operationId: characterRaids
      summary: Character Raids
      description: Returns a summary of a character's completed raids.
      tags:
      - Character Encounters API
      x-source: https://community.developer.battle.net/documentation/world-of-warcraft/profile-apis
      parameters:
      - name: realmSlug
        in: path
        required: true
        description: The slug of the realm.
        schema:
          type: string
          default: tichondrius
      - name: characterName
        in: path
        required: true
        description: The lowercase name of the character.
        schema:
          type: string
          default: charactername
      - name: namespace
        in: query
        required: true
        description: The namespace to use to locate this document.
        schema:
          type: string
          default: profile-us
      - name: locale
        in: query
        required: false
        description: The locale to reflect in localized data.
        schema:
          type: string
          default: en_US
      responses:
        '200':
          description: Successful response (response schema not published in the reference).
components:
  securitySchemes:
    oauth2:
      type: oauth2
      description: Documented at https://community.developer.battle.net/documentation/guides/using-oauth
      flows:
        clientCredentials:
          tokenUrl: https://oauth.battle.net/token
          scopes: {}
        authorizationCode:
          authorizationUrl: https://oauth.battle.net/authorize
          tokenUrl: https://oauth.battle.net/token
          scopes:
            openid: OpenID Connect
            wow.profile: World of Warcraft profile
            sc2.profile: StarCraft II profile
            d3.profile: Diablo III profile