activision-blizzard
Battle.net API

Game data and profile APIs for World of Warcraft, Diablo III, Hearthstone, StarCraft II, and Battle.net account information. Requires OAuth2 authentication via develop.battle.net.
Documentation GitHub OpenAPI
OpenAPI Specification

{
  "openapi": "3.1.0",
  "info": {
    "title": "Activision Blizzard Battle.net API",
    "version": "1.0.0",
    "description": "Battle.net Game Data and Profile APIs from Activision Blizzard providing access to data from World of Warcraft, Diablo III, Hearthstone, StarCraft II, Overwatch, and account profile information. Requires OAuth2 client credentials.",
    "contact": {
      "name": "Blizzard Developer Portal",
      "url": "https://develop.battle.net/"
    },
    "x-generated-from": "documentation"
  },
  "servers": [
    {
      "url": "https://{region}.api.blizzard.com",
      "description": "Battle.net regional API",
      "variables": {
        "region": {
          "enum": ["us", "eu", "kr", "tw"],
          "default": "us",
          "description": "API region"
        }
      }
    },
    {
      "url": "https://gateway.battlenet.com.cn",
      "description": "Battle.net China API"
    }
  ],
  "security": [
    { "OAuth2ClientCredentials": [] }
  ],
  "tags": [
    { "name": "World of Warcraft", "description": "World of Warcraft game data and profile APIs" },
    { "name": "World of Warcraft Classic", "description": "World of Warcraft Classic game data APIs" },
    { "name": "Diablo III", "description": "Diablo III game data and profile APIs" },
    { "name": "Hearthstone", "description": "Hearthstone game data APIs" },
    { "name": "StarCraft II", "description": "StarCraft II game data and profile APIs" },
    { "name": "Overwatch League", "description": "Overwatch League game data APIs" },
    { "name": "Account", "description": "Battle.net account and user profile APIs" }
  ],
  "paths": {
    "/profile/user/wow": {
      "get": {
        "operationId": "getWoWProfileSummary",
        "summary": "Activision Blizzard Get WoW Profile Summary",
        "description": "Returns a profile summary for an account, including character list",
        "tags": ["World of Warcraft"],
        "parameters": [
          { "name": "namespace", "in": "query", "required": true, "schema": { "type": "string", "example": "profile-us" }, "description": "Namespace for the data" },
          { "name": "locale", "in": "query", "schema": { "type": "string", "example": "en_US" }, "description": "Response locale" }
        ],
        "responses": {
          "200": { "description": "WoW account profile", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WoWProfileSummary" } } } },
          "401": { "description": "Unauthorized" },
          "404": { "description": "Not found" }
        },
        "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" }
      }
    },
    "/profile/wow/character/{realmSlug}/{characterName}": {
      "get": {
        "operationId": "getWoWCharacterProfile",
        "summary": "Activision Blizzard Get WoW Character Profile",
        "description": "Returns a summary of a character's profile",
        "tags": ["World of Warcraft"],
        "parameters": [
          { "name": "realmSlug", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The realm slug" },
          { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The lowercase character name" },
          { "name": "namespace", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The namespace for the data" },
          { "name": "locale", "in": "query", "schema": { "type": "string" }, "description": "Response locale" }
        ],
        "responses": {
          "200": { "description": "Character profile", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WoWCharacter" } } } },
          "404": { "description": "Character not found" }
        },
        "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" }
      }
    },
    "/profile/wow/character/{realmSlug}/{characterName}/achievements": {
      "get": {
        "operationId": "getWoWCharacterAchievements",
        "summary": "Activision Blizzard Get WoW Character Achievements",
        "description": "Returns a summary of the achievements a character has completed",
        "tags": ["World of Warcraft"],
        "parameters": [
          { "name": "realmSlug", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The realm slug" },
          { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The character name" },
          { "name": "namespace", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The namespace for the data" }
        ],
        "responses": {
          "200": { "description": "Character achievements", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WoWCharacterAchievements" } } } }
        },
        "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" }
      }
    },
    "/profile/wow/character/{realmSlug}/{characterName}/equipment": {
      "get": {
        "operationId": "getWoWCharacterEquipment",
        "summary": "Activision Blizzard Get WoW Character Equipment",
        "description": "Returns a summary of the items equipped by a character",
        "tags": ["World of Warcraft"],
        "parameters": [
          { "name": "realmSlug", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The realm slug" },
          { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The character name" },
          { "name": "namespace", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The namespace for the data" }
        ],
        "responses": {
          "200": { "description": "Character equipment", "content": { "application/json": { "schema": { "type": "object" } } } }
        },
        "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" }
      }
    },
    "/data/wow/realm/index": {
      "get": {
        "operationId": "getWoWRealmsIndex",
        "summary": "Activision Blizzard Get WoW Realms Index",
        "description": "Returns an index of realms",
        "tags": ["World of Warcraft"],
        "parameters": [
          { "name": "namespace", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The namespace for the data" },
          { "name": "locale", "in": "query", "schema": { "type": "string" }, "description": "Response locale" }
        ],
        "responses": {
          "200": { "description": "Realms index", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WoWRealmsIndex" } } } }
        },
        "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" }
      }
    },
    "/data/wow/realm/{realmSlug}": {
      "get": {
        "operationId": "getWoWRealm",
        "summary": "Activision Blizzard Get WoW Realm",
        "description": "Returns the specified realm",
        "tags": ["World of Warcraft"],
        "parameters": [
          { "name": "realmSlug", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The realm slug" },
          { "name": "namespace", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The namespace for the data" }
        ],
        "responses": {
          "200": { "description": "Realm details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WoWRealm" } } } }
        },
        "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" }
      }
    },
    "/data/wow/guild/{realmSlug}/{nameSlug}": {
      "get": {
        "operationId": "getWoWGuild",
        "summary": "Activision Blizzard Get WoW Guild",
        "description": "Returns a single guild by its name and realm",
        "tags": ["World of Warcraft"],
        "parameters": [
          { "name": "realmSlug", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The realm slug" },
          { "name": "nameSlug", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The guild name slug" },
          { "name": "namespace", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The namespace for the data" }
        ],
        "responses": {
          "200": { "description": "Guild details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WoWGuild" } } } }
        },
        "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" }
      }
    },
    "/data/wow/item/{itemId}": {
      "get": {
        "operationId": "getWoWItem",
        "summary": "Activision Blizzard Get WoW Item",
        "description": "Returns an item by ID",
        "tags": ["World of Warcraft"],
        "parameters": [
          { "name": "itemId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The item ID" },
          { "name": "namespace", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The namespace for the data" }
        ],
        "responses": {
          "200": { "description": "Item details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WoWItem" } } } }
        },
        "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" }
      }
    },
    "/d3/profile/{battletag}/": {
      "get": {
        "operationId": "getD3CareerProfile",
        "summary": "Activision Blizzard Get Diablo III Career Profile",
        "description": "Returns the specified account's Diablo III career profile",
        "tags": ["Diablo III"],
        "parameters": [
          { "name": "battletag", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The BattleTag for the account" },
          { "name": "locale", "in": "query", "schema": { "type": "string" }, "description": "Response locale" }
        ],
        "responses": {
          "200": { "description": "Diablo III career profile", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/D3CareerProfile" } } } }
        },
        "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" }
      }
    },
    "/d3/profile/{battletag}/hero/{heroId}": {
      "get": {
        "operationId": "getD3Hero",
        "summary": "Activision Blizzard Get Diablo III Hero",
        "description": "Returns a single hero",
        "tags": ["Diablo III"],
        "parameters": [
          { "name": "battletag", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The BattleTag for the account" },
          { "name": "heroId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The hero ID" }
        ],
        "responses": {
          "200": { "description": "Hero details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/D3Hero" } } } }
        },
        "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" }
      }
    },
    "/hearthstone/cards": {
      "get": {
        "operationId": "getHearthstoneCards",
        "summary": "Activision Blizzard Get Hearthstone Cards",
        "description": "Returns an up-to-date list of all cards matching the search criteria",
        "tags": ["Hearthstone"],
        "parameters": [
          { "name": "locale", "in": "query", "schema": { "type": "string" }, "description": "Response locale" },
          { "name": "set", "in": "query", "schema": { "type": "string" }, "description": "Filter cards by set" },
          { "name": "class", "in": "query", "schema": { "type": "string" }, "description": "Filter cards by class" },
          { "name": "manaCost", "in": "query", "schema": { "type": "integer" }, "description": "Filter by mana cost" },
          { "name": "attack", "in": "query", "schema": { "type": "integer" }, "description": "Filter by attack" },
          { "name": "health", "in": "query", "schema": { "type": "integer" }, "description": "Filter by health" },
          { "name": "rarity", "in": "query", "schema": { "type": "string" }, "description": "Filter by rarity" },
          { "name": "type", "in": "query", "schema": { "type": "string" }, "description": "Filter by card type" },
          { "name": "page", "in": "query", "schema": { "type": "integer" }, "description": "Page number" },
          { "name": "pageSize", "in": "query", "schema": { "type": "integer" }, "description": "Cards per page" }
        ],
        "responses": {
          "200": { "description": "Hearthstone cards", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HearthstoneCardsResponse" } } } }
        },
        "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" }
      }
    },
    "/hearthstone/cards/{idOrSlug}": {
      "get": {
        "operationId": "getHearthstoneCard",
        "summary": "Activision Blizzard Get Hearthstone Card",
        "description": "Returns the card with an ID or slug that matches the one you specify",
        "tags": ["Hearthstone"],
        "parameters": [
          { "name": "idOrSlug", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The card ID or slug" },
          { "name": "locale", "in": "query", "schema": { "type": "string" }, "description": "Response locale" }
        ],
        "responses": {
          "200": { "description": "Card details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HearthstoneCard" } } } }
        },
        "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" }
      }
    },
    "/hearthstone/decks": {
      "get": {
        "operationId": "getHearthstoneDeck",
        "summary": "Activision Blizzard Get Hearthstone Deck",
        "description": "Finds a deck by its deck code",
        "tags": ["Hearthstone"],
        "parameters": [
          { "name": "code", "in": "query", "required": true, "schema": { "type": "string" }, "description": "A deck code" },
          { "name": "locale", "in": "query", "schema": { "type": "string" }, "description": "Response locale" }
        ],
        "responses": {
          "200": { "description": "Deck details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HearthstoneDeck" } } } }
        },
        "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" }
      }
    },
    "/sc2/profile/{regionId}/{realmId}/{profileId}": {
      "get": {
        "operationId": "getSC2Profile",
        "summary": "Activision Blizzard Get StarCraft II Profile",
        "description": "Returns data about an individual SC2 profile",
        "tags": ["StarCraft II"],
        "parameters": [
          { "name": "regionId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The region for the profile" },
          { "name": "realmId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The realm for the profile" },
          { "name": "profileId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The profile ID" },
          { "name": "locale", "in": "query", "schema": { "type": "string" }, "description": "Response locale" }
        ],
        "responses": {
          "200": { "description": "SC2 profile", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SC2Profile" } } } }
        },
        "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" }
      }
    },
    "/sc2/ladder/grandmaster/{regionId}": {
      "get": {
        "operationId": "getSC2GrandmasterLeaderboard",
        "summary": "Activision Blizzard Get StarCraft II Grandmaster Leaderboard",
        "description": "Returns the grandmaster leaderboard for the current season",
        "tags": ["StarCraft II"],
        "parameters": [
          { "name": "regionId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The region for the ladder" }
        ],
        "responses": {
          "200": { "description": "Grandmaster leaderboard", "content": { "application/json": { "schema": { "type": "object" } } } }
        },
        "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" }
      }
    },
    "/profile/user": {
      "get": {
        "operationId": "getBattleNetProfile",
        "summary": "Activision Blizzard Get Battle.net Account Profile",
        "description": "Returns the authenticated user's Battle.net account profile",
        "tags": ["Account"],
        "responses": {
          "200": { "description": "Account profile", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BattleNetProfile" } } } },
          "401": { "description": "Unauthorized" }
        },
        "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" }
      }
    },
    "/wow/user/characters": {
      "get": {
        "operationId": "getWoWUserCharacters",
        "summary": "Activision Blizzard Get WoW User Characters",
        "description": "Returns a list of all WoW characters on the account",
        "tags": ["Account"],
        "parameters": [
          { "name": "namespace", "in": "query", "schema": { "type": "string" }, "description": "The namespace for the data" }
        ],
        "responses": {
          "200": { "description": "List of characters", "content": { "application/json": { "schema": { "type": "object" } } } }
        },
        "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "OAuth2ClientCredentials": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://oauth.battle.net/token",
            "scopes": {
              "wow.profile": "Access WoW character profile data",
              "sc2.profile": "Access StarCraft II profile data",
              "openid": "Access basic account information"
            }
          },
          "authorizationCode": {
            "authorizationUrl": "https://oauth.battle.net/authorize",
            "tokenUrl": "https://oauth.battle.net/token",
            "scopes": {
              "wow.profile": "Access WoW character profile data",
              "sc2.profile": "Access StarCraft II profile data",
              "openid": "Access basic account information"
            }
          }
        },
        "description": "OAuth2 authentication. Create a client at develop.battle.net for client ID and secret."
      }
    },
    "schemas": {
      "WoWProfileSummary": {
        "type": "object",
        "description": "World of Warcraft account profile summary",
        "properties": {
          "id": { "type": "integer", "description": "Account ID", "example": 12345678 },
          "wow_accounts": { "type": "array", "items": { "$ref": "#/components/schemas/WoWAccount" }, "description": "WoW accounts linked to the Battle.net account" }
        }
      },
      "WoWAccount": {
        "type": "object",
        "description": "A World of Warcraft account",
        "properties": {
          "id": { "type": "integer", "description": "Account ID", "example": 1 },
          "characters": { "type": "array", "items": { "$ref": "#/components/schemas/WoWCharacterSummary" }, "description": "List of characters on this account" }
        }
      },
      "WoWCharacterSummary": {
        "type": "object",
        "description": "Summary of a WoW character",
        "properties": {
          "character": { "type": "object", "description": "Character reference with href" },
          "protected_character": { "type": "object", "description": "Protected character reference" },
          "name": { "type": "string", "description": "Character name", "example": "Thrall" },
          "id": { "type": "integer", "description": "Character ID", "example": 123456 },
          "realm": { "$ref": "#/components/schemas/WoWRealm" },
          "playable_class": { "type": "object", "description": "Playable class reference" },
          "playable_race": { "type": "object", "description": "Playable race reference" },
          "gender": { "type": "object", "description": "Character gender" },
          "faction": { "type": "object", "description": "Character faction (Alliance or Horde)" },
          "level": { "type": "integer", "description": "Character level", "example": 70 }
        }
      },
      "WoWCharacter": {
        "type": "object",
        "description": "Full World of Warcraft character profile",
        "properties": {
          "id": { "type": "integer", "description": "Character ID", "example": 123456 },
          "name": { "type": "string", "description": "Character name", "example": "Thrall" },
          "gender": { "type": "object", "description": "Character gender" },
          "faction": { "type": "object", "description": "Character faction" },
          "race": { "type": "object", "description": "Character race" },
          "character_class": { "type": "object", "description": "Character class" },
          "active_spec": { "type": "object", "description": "Active specialization" },
          "realm": { "$ref": "#/components/schemas/WoWRealm" },
          "guild": { "$ref": "#/components/schemas/WoWGuild" },
          "level": { "type": "integer", "description": "Character level", "example": 70 },
          "experience": { "type": "integer", "description": "Character experience points" },
          "achievement_points": { "type": "integer", "description": "Total achievement points", "example": 15000 },
          "last_login_timestamp": { "type": "integer", "description": "Unix timestamp of last login", "example": 1718153645993 }
        }
      },
      "WoWCharacterAchievements": {
        "type": "object",
        "description": "Character achievements summary",
        "properties": {
          "total_quantity": { "type": "integer", "description": "Total achievements completed", "example": 2500 },
          "total_points": { "type": "integer", "description": "Total achievement points", "example": 15000 },
          "achievements": { "type": "array", "items": { "type": "object" }, "description": "List of completed achievements" }
        }
      },
      "WoWRealmsIndex": {
        "type": "object",
        "description": "Index of WoW realms",
        "properties": {
          "realms": { "type": "array", "items": { "$ref": "#/components/schemas/WoWRealm" }, "description": "List of realms" }
        }
      },
      "WoWRealm": {
        "type": "object",
        "description": "A World of Warcraft realm",
        "properties": {
          "id": { "type": "integer", "description": "Realm ID", "example": 1 },
          "name": { "type": "string", "description": "Realm name", "example": "Area 52" },
          "slug": { "type": "string", "description": "Realm slug", "example": "area-52" },
          "region": { "type": "object", "description": "Region reference" },
          "category": { "type": "string", "description": "Realm category", "example": "United States" },
          "locale": { "type": "string", "description": "Realm locale", "example": "en_US" },
          "timezone": { "type": "string", "description": "Realm timezone", "example": "America/New_York" },
          "type": { "type": "object", "description": "Realm type (Normal, RP, etc.)" },
          "is_tournament": { "type": "boolean", "description": "Whether this is a tournament realm" }
        }
      },
      "WoWGuild": {
        "type": "object",
        "description": "A World of Warcraft guild",
        "properties": {
          "id": { "type": "integer", "description": "Guild ID", "example": 789012 },
          "name": { "type": "string", "description": "Guild name", "example": "The Exodar" },
          "faction": { "type": "object", "description": "Guild faction" },
          "realm": { "$ref": "#/components/schemas/WoWRealm" },
          "member_count": { "type": "integer", "description": "Number of guild members", "example": 150 },
          "achievement_points": { "type": "integer", "description": "Guild achievement points", "example": 5000 }
        }
      },
      "WoWItem": {
        "type": "object",
        "description": "A World of Warcraft item",
        "properties": {
          "id": { "type": "integer", "description": "Item ID", "example": 19019 },
          "name": { "type": "string", "description": "Item name", "example": "Thunderfury, Blessed Blade of the Windseeker" },
          "quality": { "type": "object", "description": "Item quality (Common, Rare, Epic, etc.)" },
          "level": { "type": "integer", "description": "Item level", "example": 80 },
          "item_class": { "type": "object", "description": "Item class" },
          "item_subclass": { "type": "object", "description": "Item subclass" },
          "inventory_type": { "type": "object", "description": "Inventory type" },
          "purchase_price": { "type": "integer", "description": "Purchase price in copper" },
          "sell_price": { "type": "integer", "description": "Sell price in copper" }
        }
      },
      "D3CareerProfile": {
        "type": "object",
        "description": "Diablo III career profile",
        "properties": {
          "battletag": { "type": "string", "description": "Player BattleTag", "example": "Player#1234" },
          "paragonLevel": { "type": "integer", "description": "Paragon level", "example": 1500 },
          "paragonLevelHardcore": { "type": "integer", "description": "Hardcore paragon level", "example": 200 },
          "guildName": { "type": "string", "description": "Guild name" },
          "heroes": { "type": "array", "items": { "$ref": "#/components/schemas/D3HeroSummary" }, "description": "List of heroes" },
          "lastHeroPlayed": { "type": "integer", "description": "ID of last hero played", "example": 12345 },
          "kills": { "type": "object", "description": "Kill statistics" },
          "timePlayed": { "type": "object", "description": "Time played by class" }
        }
      },
      "D3HeroSummary": {
        "type": "object",
        "description": "Summary of a Diablo III hero",
        "properties": {
          "id": { "type": "integer", "description": "Hero ID", "example": 12345 },
          "name": { "type": "string", "description": "Hero name", "example": "Zul'jin" },
          "class": { "type": "string", "description": "Hero class", "example": "barbarian" },
          "level": { "type": "integer", "description": "Hero level", "example": 70 },
          "hardcore": { "type": "boolean", "description": "Whether this is a hardcore hero" },
          "seasonal": { "type": "boolean", "description": "Whether this is a seasonal hero" },
          "dead": { "type": "boolean", "description": "Whether this hero is dead" }
        }
      },
      "D3Hero": {
        "type": "object",
        "description": "A Diablo III hero",
        "properties": {
          "id": { "type": "integer", "description": "Hero ID", "example": 12345 },
          "name": { "type": "string", "description": "Hero name", "example": "Zul'jin" },
          "class": { "type": "string", "description": "Hero class", "example": "barbarian" },
          "gender": { "type": "integer", "description": "Hero gender (0=male, 1=female)", "example": 0 },
          "level": { "type": "integer", "description": "Hero level", "example": 70 },
          "paragonLevel": { "type": "integer", "description": "Paragon level", "example": 1500 },
          "hardcore": { "type": "boolean", "description": "Whether this is a hardcore hero" },
          "seasonal": { "type": "boolean", "description": "Whether this is a seasonal hero" },
          "dead": { "type": "boolean", "description": "Whether this hero is dead" },
          "kills": { "type": "object", "description": "Kill statistics" },
          "skills": { "type": "object", "description": "Hero skills and runes" },
          "items": { "type": "object", "description": "Equipped items" },
          "stats": { "type": "object", "description": "Character stats" }
        }
      },
      "HearthstoneCard": {
        "type": "object",
        "description": "A Hearthstone card",
        "properties": {
          "id": { "type": "integer", "description": "Card ID", "example": 1234 },
          "collectible": { "type": "integer", "description": "Whether the card is collectible (1=yes)", "example": 1 },
          "slug": { "type": "string", "description": "Card slug", "example": "ragnaros-the-firelord" },
          "classId": { "type": "integer", "description": "Class ID", "example": 1 },
          "multiClassIds": { "type": "array", "items": { "type": "integer" }, "description": "Multi-class IDs" },
          "cardTypeId": { "type": "integer", "description": "Card type ID", "example": 4 },
          "cardSetId": { "type": "integer", "description": "Card set ID", "example": 2 },
          "rarityId": { "type": "integer", "description": "Rarity ID", "example": 5 },
          "artistName": { "type": "string", "description": "Artist name", "example": "Alex Horley" },
          "health": { "type": "integer", "description": "Card health", "example": 8 },
          "attack": { "type": "integer", "description": "Card attack", "example": 8 },
          "manaCost": { "type": "integer", "description": "Mana cost", "example": 8 },
          "name": { "type": "string", "description": "Card name", "example": "Ragnaros the Firelord" },
          "text": { "type": "string", "description": "Card text" },
          "image": { "type": "string", "format": "uri", "description": "Card image URL" },
          "imageGold": { "type": "string", "format": "uri", "description": "Gold card image URL" },
          "flavorText": { "type": "string", "description": "Card flavor text" },
          "cropImage": { "type": "string", "format": "uri", "description": "Cropped card image URL" }
        }
      },
      "HearthstoneCardsResponse": {
        "type": "object",
        "description": "Paginated Hearthstone cards response",
        "properties": {
          "cards": { "type": "array", "items": { "$ref": "#/components/schemas/HearthstoneCard" }, "description": "List of cards" },
          "cardCount": { "type": "integer", "description": "Total card count", "example": 2847 },
          "pageCount": { "type": "integer", "description": "Total page count", "example": 143 },
          "page": { "type": "integer", "description": "Current page", "example": 1 }
        }
      },
      "HearthstoneDeck": {
        "type": "object",
        "description": "A Hearthstone deck",
        "properties": {
          "deckCode": { "type": "string", "description": "The deck code", "example": "AAECAQcG0LQDubQD3rUD57UDibYDvbYDDI..." },
          "version": { "type": "integer", "description": "Deck format version", "example": 1 },
          "format": { "type": "object", "description": "Deck format" },
          "hero": { "$ref": "#/components/schemas/HearthstoneCard" },
          "heroPower": { "$ref": "#/components/schemas/HearthstoneCard" },
          "class": { "type": "object", "description": "Deck class" },
          "cards": { "type": "array", "items": { "$ref": "#/components/schemas/HearthstoneCard" }, "description": "Cards in the deck" },
          "cardCount": { "type": "integer", "description": "Number of cards in the deck", "example": 30 }
        }
      },
      "SC2Profile": {
        "type": "object",
        "description": "A StarCraft II profile",
        "properties": {
          "summary": { "type": "object", "description": "Profile summary" },
          "snapshot": { "type": "object", "description": "Profile snapshot data" }
        }
      },
      "BattleNetProfile": {
        "type": "object",
        "description": "Battle.net account profile",
        "properties": {
          "id": { "type": "integer", "description": "Account ID", "example": 12345678 },
          "battletag": { "type": "string", "description": "Battle.net BattleTag", "example": "Player#1234" },
          "sub": { "type": "string", "description": "OAuth2 subject identifier" }
        }
      }
    }
  }
}
Battle.net API

Specifications

Schemas & Data

Other Resources

OpenAPI Specification
