Activision Blizzard Character Profile API

openapi: 3.2.0
info:
  title: Battle.net World of Warcraft Character Profile 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 Profile API
paths:
  /profile/wow/character/{realmSlug}/{characterName}/status:
    get:
      operationId: characterProfileStatus
      summary: Character Profile Status
      description: 'Returns the status and a unique ID for a character. A client should delete information about a character from their application if any of the following conditions occur:


        an HTTP 404 Not Found error is returned


        the is_valid value is false


        the returned character ID doesn''t match the previously recorded value for the character


        The following example illustrates how to use this endpoint:


        A client requests and stores information about a character, including its unique character ID and the timestamp of the request.


        After 30 days, the client makes a request to the status endpoint to verify if the character information is still valid.


        If character cannot be found, is not valid, or the characters IDs do not match, the client removes the information from their application.


        If the character is valid and the character IDs match, the client retains the data for another 30 days.'
      tags:
      - Character Profile 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