Skip to content

Latest commit

 

History

History
2141 lines (1338 loc) · 153 KB

Doc.md

File metadata and controls

2141 lines (1338 loc) · 153 KB

Dysnomia.Common.BlizzardWebAPI

Contents

Diablo3Community type

Namespace

Dysnomia.Common.BlizzardWebAPI

Summary

Diablo III community APIs provide endpoints for Diablo III player profiles. https://develop.battle.net/documentation/diablo-3/community-apis

GetAccount(accessToken,region,account,locale) method

Summary

Returns the specified account profile.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
account System.String The BattleTag for the account to retrieve.
locale System.String The locale to reflect in localized data.

GetAccount(accessToken,region,account,locale) method

Summary

Returns the specified account profile.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
account System.String The BattleTag for the account to retrieve.
locale System.String The locale to reflect in localized data.

GetAct(accessToken,region,actId,locale) method

Summary

Returns a single act by ID.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
actId System.Int32 The ID of the act to retrieve.
locale System.String The locale to reflect in localized data.

GetAct(accessToken,region,actId,locale) method

Summary

Returns a single act by ID.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
actId System.Int32 The ID of the act to retrieve.
locale System.String The locale to reflect in localized data.

GetActIndex(accessToken,region,locale) method

Summary

Returns an index of acts.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
locale System.String The locale to reflect in localized data.

GetActIndex(accessToken,region,locale) method

Summary

Returns an index of acts.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
locale System.String The locale to reflect in localized data.

GetApiSkill(accessToken,region,classSlug,skillSlug,locale) method

Summary

Returns a single skill by slug for a specific character class.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
classSlug System.String The slug of the character class to retrieve.
skillSlug System.String The slug of the skill to retrieve.
locale System.String The locale to reflect in localized data.

GetApiSkill(accessToken,region,classSlug,skillSlug,locale) method

Summary

Returns a single skill by slug for a specific character class.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
classSlug Dysnomia.Common.BlizzardWebAPI.Enums.Diablo3ClassEnum The slug of the character class to retrieve.
skillSlug Dysnomia.Common.BlizzardWebAPI.Enums.Diablo3SkillEnum The slug of the skill to retrieve.
locale System.String The locale to reflect in localized data.

GetArtisan(accessToken,region,artisanSlug,locale) method

Summary

Returns a single artisan by slug.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
artisanSlug System.String The slug of the artisan to retrieve.
locale System.String The locale to reflect in localized data.

GetArtisan(accessToken,region,artisanSlug,locale) method

Summary

Returns a single artisan by slug.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
artisanSlug Dysnomia.Common.BlizzardWebAPI.Enums.Diablo3ArtisanEnum The slug of the artisan to retrieve.
locale System.String The locale to reflect in localized data.

GetCharacterClass(accessToken,region,classSlug,locale) method

Summary

Returns a single character class by slug.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
classSlug System.String The slug of the character class to retrieve.
locale System.String The locale to reflect in localized data.

GetCharacterClass(accessToken,region,classSlug,locale) method

Summary

Returns a single character class by slug.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
classSlug Dysnomia.Common.BlizzardWebAPI.Enums.Diablo3ClassEnum The slug of the character class to retrieve.
locale System.String The locale to reflect in localized data.

GetDetailedFollowersItems(accessToken,region,account,heroId,locale) method

Summary

Returns a list of items for the specified hero's followers.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
account System.String The BattleTag for the account to retrieve.
heroId System.UInt64 The ID of the hero to retrieve.
locale System.String The locale to reflect in localized data.

GetDetailedFollowersItems(accessToken,region,account,heroId,locale) method

Summary

Returns a list of items for the specified hero's followers.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
account System.String The BattleTag for the account to retrieve.
heroId System.UInt64 The ID of the hero to retrieve.
locale System.String The locale to reflect in localized data.

GetDetailedHeroItems(accessToken,region,account,heroId,locale) method

Summary

Returns a list of items for the specified hero.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
account System.String The BattleTag for the account to retrieve.
heroId System.UInt64 The ID of the hero to retrieve.
locale System.String The locale to reflect in localized data.

GetDetailedHeroItems(accessToken,region,account,heroId,locale) method

Summary

Returns a list of items for the specified hero.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
account System.String The BattleTag for the account to retrieve.
heroId System.UInt64 The ID of the hero to retrieve.
locale System.String The locale to reflect in localized data.

GetFollower(accessToken,region,followerSlug,locale) method

Summary

Returns a single follower by slug.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
followerSlug System.String The slug of the follower to retrieve.
locale System.String The locale to reflect in localized data.

GetFollower(accessToken,region,followerSlug,locale) method

Summary

Returns a single follower by slug.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
followerSlug Dysnomia.Common.BlizzardWebAPI.Enums.Diablo3FollowerEnum The slug of the follower to retrieve.
locale System.String The locale to reflect in localized data.

GetHero(accessToken,region,account,heroId,locale) method

Summary

Returns a single hero.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
account System.String The BattleTag for the account to retrieve.
heroId System.UInt64 The ID of the hero to retrieve.
locale System.String The locale to reflect in localized data.

GetHero(accessToken,region,account,heroId,locale) method

Summary

Returns a single hero.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
account System.String The BattleTag for the account to retrieve.
heroId System.UInt64 The ID of the hero to retrieve.
locale System.String The locale to reflect in localized data.

GetImage(type,size,icon) method

Summary

Get image URL from type, size and icon in blizzard CDN. Warning: this CDN only supports HTTP, not HTTPS

Returns
Parameters
Name Type Description
type Dysnomia.Common.BlizzardWebAPI.Enums.Diablo3ImageType The image type (items or skills)
size System.String The size: for items must either be small or large; for skills must be 21, 42, or 64 (These values refer to the image size in pixels).
icon System.String Icon name without extension

GetItem(accessToken,region,itemSlugAndId,locale) method

Summary

Returns a single item type by slug.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
itemSlugAndId System.String The slug of the item type to retrieve.
locale System.String The locale to reflect in localized data.

GetItem(accessToken,region,itemSlugAndId,locale) method

Summary

Returns a single item type by slug.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
itemSlugAndId System.String The slug of the item type to retrieve.
locale System.String The locale to reflect in localized data.

GetItemType(accessToken,region,itemTypeSlug,locale) method

Summary

Returns a single item type by slug.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
itemTypeSlug System.String The slug of the item type to retrieve.
locale System.String The locale to reflect in localized data.

GetItemType(accessToken,region,itemTypeSlug,locale) method

Summary

Returns a single item type by slug.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
itemTypeSlug System.String The slug of the item type to retrieve.
locale System.String The locale to reflect in localized data.

GetItemTypeIndex(accessToken,region,locale) method

Summary

Returns an index of item types.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
locale System.String The locale to reflect in localized data.

GetItemTypeIndex(accessToken,region,locale) method

Summary

Returns an index of item types.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
locale System.String The locale to reflect in localized data.

GetRecipe(accessToken,region,artisanSlug,recipeSlug,locale) method

Summary

Returns a single recipe by slug for the specified artisan.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
artisanSlug System.String The slug of the artisan to retrieve.
recipeSlug System.String The slug of the recipe to retrieve.
locale System.String The locale to reflect in localized data.

GetRecipe(accessToken,region,artisanSlug,recipeSlug,locale) method

Summary

Returns a single recipe by slug for the specified artisan.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
artisanSlug Dysnomia.Common.BlizzardWebAPI.Enums.Diablo3ArtisanEnum The slug of the artisan to retrieve.
recipeSlug System.String The slug of the recipe to retrieve.
locale System.String The locale to reflect in localized data.

IDiablo3Community type

Namespace

Dysnomia.Common.BlizzardWebAPI

Summary

Diablo III community APIs provide endpoints for Diablo III player profiles. https://develop.battle.net/documentation/diablo-3/community-apis

GetAccount(accessToken,region,account,locale) method

Summary

Returns the specified account profile.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
account System.String The BattleTag for the account to retrieve.
locale System.String The locale to reflect in localized data.

GetAccount(accessToken,region,account,locale) method

Summary

Returns the specified account profile.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
account System.String The BattleTag for the account to retrieve.
locale System.String The locale to reflect in localized data.

GetAct(accessToken,region,actId,locale) method

Summary

Returns a single act by ID.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
actId System.Int32 The ID of the act to retrieve.
locale System.String The locale to reflect in localized data.

GetAct(accessToken,region,actId,locale) method

Summary

Returns a single act by ID.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
actId System.Int32 The ID of the act to retrieve.
locale System.String The locale to reflect in localized data.

GetActIndex(accessToken,region,locale) method

Summary

Returns an index of acts.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
locale System.String The locale to reflect in localized data.

GetActIndex(accessToken,region,locale) method

Summary

Returns an index of acts.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
locale System.String The locale to reflect in localized data.

GetApiSkill(accessToken,region,classSlug,skillSlug,locale) method

Summary

Returns a single skill by slug for a specific character class.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
classSlug System.String The slug of the character class to retrieve.
skillSlug System.String The slug of the skill to retrieve.
locale System.String The locale to reflect in localized data.

GetApiSkill(accessToken,region,classSlug,skillSlug,locale) method

Summary

Returns a single skill by slug for a specific character class.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
classSlug Dysnomia.Common.BlizzardWebAPI.Enums.Diablo3ClassEnum The slug of the character class to retrieve.
skillSlug Dysnomia.Common.BlizzardWebAPI.Enums.Diablo3SkillEnum The slug of the skill to retrieve.
locale System.String The locale to reflect in localized data.

GetArtisan(accessToken,region,artisanSlug,locale) method

Summary

Returns a single artisan by slug.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
artisanSlug System.String The slug of the artisan to retrieve.
locale System.String The locale to reflect in localized data.

GetArtisan(accessToken,region,artisanSlug,locale) method

Summary

Returns a single artisan by slug.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
artisanSlug Dysnomia.Common.BlizzardWebAPI.Enums.Diablo3ArtisanEnum The slug of the artisan to retrieve.
locale System.String The locale to reflect in localized data.

GetCharacterClass(accessToken,region,classSlug,locale) method

Summary

Returns a single character class by slug.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
classSlug System.String The slug of the character class to retrieve.
locale System.String The locale to reflect in localized data.

GetCharacterClass(accessToken,region,classSlug,locale) method

Summary

Returns a single character class by slug.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
classSlug Dysnomia.Common.BlizzardWebAPI.Enums.Diablo3ClassEnum The slug of the character class to retrieve.
locale System.String The locale to reflect in localized data.

GetDetailedFollowersItems(accessToken,region,account,heroId,locale) method

Summary

Returns a list of items for the specified hero's followers.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
account System.String The BattleTag for the account to retrieve.
heroId System.UInt64 The ID of the hero to retrieve.
locale System.String The locale to reflect in localized data.

GetDetailedFollowersItems(accessToken,region,account,heroId,locale) method

Summary

Returns a list of items for the specified hero's followers.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
account System.String The BattleTag for the account to retrieve.
heroId System.UInt64 The ID of the hero to retrieve.
locale System.String The locale to reflect in localized data.

GetDetailedHeroItems(accessToken,region,account,heroId,locale) method

Summary

Returns a list of items for the specified hero.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
account System.String The BattleTag for the account to retrieve.
heroId System.UInt64 The ID of the hero to retrieve.
locale System.String The locale to reflect in localized data.

GetDetailedHeroItems(accessToken,region,account,heroId,locale) method

Summary

Returns a list of items for the specified hero.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
account System.String The BattleTag for the account to retrieve.
heroId System.UInt64 The ID of the hero to retrieve.
locale System.String The locale to reflect in localized data.

GetFollower(accessToken,region,followerSlug,locale) method

Summary

Returns a single follower by slug.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
followerSlug System.String The slug of the follower to retrieve.
locale System.String The locale to reflect in localized data.

GetFollower(accessToken,region,followerSlug,locale) method

Summary

Returns a single follower by slug.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
followerSlug Dysnomia.Common.BlizzardWebAPI.Enums.Diablo3FollowerEnum The slug of the follower to retrieve.
locale System.String The locale to reflect in localized data.

GetHero(accessToken,region,account,heroId,locale) method

Summary

Returns a single hero.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
account System.String The BattleTag for the account to retrieve.
heroId System.UInt64 The ID of the hero to retrieve.
locale System.String The locale to reflect in localized data.

GetHero(accessToken,region,account,heroId,locale) method

Summary

Returns a single hero.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
account System.String The BattleTag for the account to retrieve.
heroId System.UInt64 The ID of the hero to retrieve.
locale System.String The locale to reflect in localized data.

GetImage(type,size,icon) method

Summary

Get image URL from type, size and icon in blizzard CDN

Returns
Parameters
Name Type Description
type Dysnomia.Common.BlizzardWebAPI.Enums.Diablo3ImageType The image type (items or skills)
size System.String The size: for items must either be small or large; for skills must be 21, 42, or 64 (These values refer to the image size in pixels).
icon System.String Icon name without extension

GetItem(accessToken,region,itemSlugAndId,locale) method

Summary

Returns a single item type by slug.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
itemSlugAndId System.String The slug of the item type to retrieve.
locale System.String The locale to reflect in localized data.

GetItem(accessToken,region,itemSlugAndId,locale) method

Summary

Returns a single item type by slug.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
itemSlugAndId System.String The slug of the item type to retrieve.
locale System.String The locale to reflect in localized data.

GetItemType(accessToken,region,itemTypeSlug,locale) method

Summary

Returns a single item type by slug.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
itemTypeSlug System.String The slug of the item type to retrieve.
locale System.String The locale to reflect in localized data.

GetItemType(accessToken,region,itemTypeSlug,locale) method

Summary

Returns a single item type by slug.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
itemTypeSlug System.String The slug of the item type to retrieve.
locale System.String The locale to reflect in localized data.

GetItemTypeIndex(accessToken,region,locale) method

Summary

Returns an index of item types.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
locale System.String The locale to reflect in localized data.

GetItemTypeIndex(accessToken,region,locale) method

Summary

Returns an index of item types.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
locale System.String The locale to reflect in localized data.

GetRecipe(accessToken,region,artisanSlug,recipeSlug,locale) method

Summary

Returns a single recipe by slug for the specified artisan.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region System.String The region of the data to retrieve.
artisanSlug System.String The slug of the artisan to retrieve.
recipeSlug System.String The slug of the recipe to retrieve.
locale System.String The locale to reflect in localized data.

GetRecipe(accessToken,region,artisanSlug,recipeSlug,locale) method

Summary

Returns a single recipe by slug for the specified artisan.

Returns
Parameters
Name Type Description
accessToken System.String Client credential flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
artisanSlug Dysnomia.Common.BlizzardWebAPI.Enums.Diablo3ArtisanEnum The slug of the artisan to retrieve.
recipeSlug System.String The slug of the recipe to retrieve.
locale System.String The locale to reflect in localized data.

ILegacyStarcraft2Community type

Namespace

Dysnomia.Common.BlizzardWebAPI

Summary

See https://develop.battle.net/documentation/starcraft-2/community-apis, under "Legacy API"

GetPlayerProfile(accessToken,region,regionId,realmId,profileId) method

Summary

Retrieves data about an individual Starcraft2 profile.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region System.String StarCraft II community APIs use the region parameter to set the host region in the Try It feature. Note: {region} does not affect StarCraft II responses, which use the :regionId parameter in requests.
regionId System.Int32 You can retrieve these parameters by issuing a GetPlayerAccount request.
realmId System.Int32 You can retrieve these parameters by issuing a GetPlayerAccount request.
profileId System.UInt64 You can retrieve these parameters by issuing a GetPlayerAccount request.

GetPlayerProfile(accessToken,region,regionId,realmId,profileId) method

Summary

Retrieves data about an individual Starcraft2 profile.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum StarCraft II community APIs use the region parameter to set the host region in the Try It feature. Note: {region} does not affect StarCraft II responses, which use the :regionId parameter in requests.
regionId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RegionEnum You can retrieve these parameters by issuing a GetPlayerAccount request.
realmId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RealmEnum You can retrieve these parameters by issuing a GetPlayerAccount request.
profileId System.UInt64 You can retrieve these parameters by issuing a GetPlayerAccount request.

IStarcraft2Community type

Namespace

Dysnomia.Common.BlizzardWebAPI

Summary

See https://develop.battle.net/documentation/starcraft-2/community-apis

GetGrandmasterLeaderboard(accessToken,region,regionId) method

Summary

Returns ladder data for the current season's grandmaster leaderboard.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region System.String The region of the data to retrieve.
regionId System.Int32 The region for the profile

GetGrandmasterLeaderboard(accessToken,region,regionId) method

Summary

Returns ladder data for the current season's grandmaster leaderboard.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
regionId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RegionEnum The region for the profile

GetLadderSeason(accessToken,region,regionId) method

Summary

Returns data about the current season.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region System.String The region of the data to retrieve.
regionId System.Int32 The region for the profile

GetLadderSeason(accessToken,region,regionId) method

Summary

Returns data about the current season.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
regionId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RegionEnum The region for the profile

GetMetadataProfile(accessToken,region,regionId,realmId,profileId,locale) method

Summary

Returns metadata for an individual's profile.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region System.String The region of the data to retrieve.
regionId System.Int32 The region for the profile
realmId System.Int32 Realm Id (1/2)
profileId System.UInt64 The profile ID
locale System.String The locale to reflect in localized data.

GetMetadataProfile(accessToken,region,regionId,realmId,profileId,locale) method

Summary

Returns metadata for an individual's profile.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
regionId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RegionEnum The region for the profile
realmId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RealmEnum Realm Id (1/2)
profileId System.UInt64 The profile ID
locale System.String The locale to reflect in localized data.

GetPlayerAccount(accessToken,region,accountId) method

Summary

Returns metadata for an individual's account.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region System.String The region of the data to retrieve.
accountId System.UInt64 The ID of the account for which to retrieve data.

GetPlayerAccount(accessToken,region,accountId) method

Summary

Returns metadata for an individual's account.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
accountId System.UInt64 The ID of the account for which to retrieve data.

GetProfile(accessToken,region,regionId,realmId,profileId,locale) method

Summary

Returns data about an individual Starcraft2 profile.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region System.String The region of the data to retrieve.
regionId System.Int32 The region for the profile
realmId System.Int32 Realm Id (1/2)
profileId System.UInt64 The profile ID
locale System.String The locale to reflect in localized data.

GetProfile(accessToken,region,regionId,realmId,profileId,locale) method

Summary

Returns data about an individual Starcraft2 profile.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
regionId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RegionEnum The region for the profile
realmId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RealmEnum Realm Id (1/2)
profileId System.UInt64 The profile ID
locale System.String The locale to reflect in localized data.

GetProfileLadder(accessToken,region,regionId,realmId,profileId,ladderId,locale) method

Summary

Returns data about an individual profile's ladder.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region System.String The region of the data to retrieve.
regionId System.Int32 The region for the profile
realmId System.Int32 Realm Id (1/2)
profileId System.UInt64 The profile ID
ladderId System.Int32 The ID of the ladder for which to retrieve data.
locale System.String The locale to reflect in localized data.

GetProfileLadder(accessToken,region,regionId,realmId,profileId,ladderId,locale) method

Summary

Returns data about an individual profile's ladder.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
regionId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RegionEnum The region for the profile
realmId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RealmEnum Realm Id (1/2)
profileId System.UInt64 The profile ID
ladderId System.Int32 The ID of the ladder for which to retrieve data.
locale System.String The locale to reflect in localized data.

GetProfileLadderSummary(accessToken,region,regionId,realmId,profileId,locale) method

Summary

Returns a ladder summary for an individual Starcraft2 profile.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region System.String The region of the data to retrieve.
regionId System.Int32 The region for the profile
realmId System.Int32 Realm Id (1/2)
profileId System.UInt64 The profile ID
locale System.String The locale to reflect in localized data.

GetProfileLadderSummary(accessToken,region,regionId,realmId,profileId,locale) method

Summary

Returns a ladder summary for an individual Starcraft2 profile.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
regionId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RegionEnum The region for the profile
realmId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RealmEnum Realm Id (1/2)
profileId System.UInt64 The profile ID
locale System.String The locale to reflect in localized data.

GetStaticProfile(accessToken,region,regionId,locale) method

Summary

Returns all static Starcraft2 profile data (achievements, categories, criteria, and rewards).

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region System.String The region of the data to retrieve.
regionId System.Int32 The region for the profile
locale System.String The locale to reflect in localized data.

GetStaticProfile(accessToken,region,regionId,locale) method

Summary

Returns all static Starcraft2 profile data (achievements, categories, criteria, and rewards).

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
regionId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RegionEnum The region for the profile
locale System.String The locale to reflect in localized data.

LegacyStarcraft2Community type

Namespace

Dysnomia.Common.BlizzardWebAPI

Summary

See https://develop.battle.net/documentation/starcraft-2/community-apis, under "Legacy API"

GetPlayerProfile(accessToken,region,regionId,realmId,profileId) method

Summary

Retrieves data about an individual Starcraft2 profile.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region System.String StarCraft II community APIs use the region parameter to set the host region in the Try It feature. Note: {region} does not affect StarCraft II responses, which use the :regionId parameter in requests.
regionId System.Int32 You can retrieve these parameters by issuing a GetPlayerAccount request.
realmId System.Int32 You can retrieve these parameters by issuing a GetPlayerAccount request.
profileId System.UInt64 You can retrieve these parameters by issuing a GetPlayerAccount request.

GetPlayerProfile(accessToken,region,regionId,realmId,profileId) method

Summary

Retrieves data about an individual Starcraft2 profile.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum StarCraft II community APIs use the region parameter to set the host region in the Try It feature. Note: {region} does not affect StarCraft II responses, which use the :regionId parameter in requests.
regionId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RegionEnum You can retrieve these parameters by issuing a GetPlayerAccount request.
realmId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RealmEnum You can retrieve these parameters by issuing a GetPlayerAccount request.
profileId System.UInt64 You can retrieve these parameters by issuing a GetPlayerAccount request.

Starcraft2Community type

Namespace

Dysnomia.Common.BlizzardWebAPI

Summary

See https://develop.battle.net/documentation/starcraft-2/community-apis

GetGrandmasterLeaderboard(accessToken,region,regionId) method

Summary

Returns ladder data for the current season's grandmaster leaderboard.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region System.String The region of the data to retrieve.
regionId System.Int32 The region for the profile

GetGrandmasterLeaderboard(accessToken,region,regionId) method

Summary

Returns ladder data for the current season's grandmaster leaderboard.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
regionId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RegionEnum The region for the profile

GetLadderSeason(accessToken,region,regionId) method

Summary

Returns data about the current season.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region System.String The region of the data to retrieve.
regionId System.Int32 The region for the profile

GetLadderSeason(accessToken,region,regionId) method

Summary

Returns data about the current season.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
regionId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RegionEnum The region for the profile

GetMetadataProfile(accessToken,region,regionId,realmId,profileId,locale) method

Summary

Returns metadata for an individual's profile.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region System.String The region of the data to retrieve.
regionId System.Int32 The region for the profile
realmId System.Int32 Realm Id (1/2)
profileId System.UInt64 The profile ID
locale System.String The locale to reflect in localized data.

GetMetadataProfile(accessToken,region,regionId,realmId,profileId,locale) method

Summary

Returns metadata for an individual's profile.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
regionId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RegionEnum The region for the profile
realmId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RealmEnum Realm Id (1/2)
profileId System.UInt64 The profile ID
locale System.String The locale to reflect in localized data.

GetPlayerAccount(accessToken,region,accountId) method

Summary

Returns metadata for an individual's account.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region System.String The region of the data to retrieve.
accountId System.UInt64 The ID of the account for which to retrieve data.

GetPlayerAccount(accessToken,region,accountId) method

Summary

Returns metadata for an individual's account.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
accountId System.UInt64 The ID of the account for which to retrieve data.

GetProfile(accessToken,region,regionId,realmId,profileId,locale) method

Summary

Returns data about an individual Starcraft2 profile.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region System.String The region of the data to retrieve.
regionId System.Int32 The region for the profile
realmId System.Int32 Realm Id (1/2)
profileId System.UInt64 The profile ID
locale System.String The locale to reflect in localized data.

GetProfile(accessToken,region,regionId,realmId,profileId,locale) method

Summary

Returns data about an individual Starcraft2 profile.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
regionId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RegionEnum The region for the profile
realmId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RealmEnum Realm Id (1/2)
profileId System.UInt64 The profile ID
locale System.String The locale to reflect in localized data.

GetProfileLadder(accessToken,region,regionId,realmId,profileId,ladderId,locale) method

Summary

Returns data about an individual profile's ladder.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region System.String The region of the data to retrieve.
regionId System.Int32 The region for the profile
realmId System.Int32 Realm Id (1/2)
profileId System.UInt64 The profile ID
ladderId System.Int32 The ID of the ladder for which to retrieve data.
locale System.String The locale to reflect in localized data.

GetProfileLadder(accessToken,region,regionId,realmId,profileId,ladderId,locale) method

Summary

Returns data about an individual profile's ladder.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
regionId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RegionEnum The region for the profile
realmId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RealmEnum Realm Id (1/2)
profileId System.UInt64 The profile ID
ladderId System.Int32 The ID of the ladder for which to retrieve data.
locale System.String The locale to reflect in localized data.

GetProfileLadderSummary(accessToken,region,regionId,realmId,profileId,locale) method

Summary

Returns a ladder summary for an individual Starcraft2 profile.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region System.String The region of the data to retrieve.
regionId System.Int32 The region for the profile
realmId System.Int32 Realm Id (1/2)
profileId System.UInt64 The profile ID
locale System.String The locale to reflect in localized data.

GetProfileLadderSummary(accessToken,region,regionId,realmId,profileId,locale) method

Summary

Returns a ladder summary for an individual Starcraft2 profile.

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
regionId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RegionEnum The region for the profile
realmId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RealmEnum Realm Id (1/2)
profileId System.UInt64 The profile ID
locale System.String The locale to reflect in localized data.

GetStaticProfile(accessToken,region,regionId,locale) method

Summary

Returns all static Starcraft2 profile data (achievements, categories, criteria, and rewards).

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region System.String The region of the data to retrieve.
regionId System.Int32 The region for the profile
locale System.String The locale to reflect in localized data.

GetStaticProfile(accessToken,region,regionId,locale) method

Summary

Returns all static Starcraft2 profile data (achievements, categories, criteria, and rewards).

Returns
Parameters
Name Type Description
accessToken System.String Credential Code Flow access token
region Dysnomia.Common.BlizzardWebAPI.Enums.RegionEnum The region of the data to retrieve.
regionId Dysnomia.Common.BlizzardWebAPI.Enums.StarCraft2RegionEnum The region for the profile
locale System.String The locale to reflect in localized data.

TokenQuerier type

Namespace

Dysnomia.Common.BlizzardWebAPI

Summary

See https://develop.battle.net/documentation/guides/using-oauth

GetAuthorizationCodeFlow(authorization_code,scope) method

Summary

The OAuth 2.0 Authorization Code Flow allows an application to access a user's data on their behalf. This allows an application to acquire more sensitive, opt-in information about a user, such as their list of World of Warcraft characters, after obtaining the user's permission to do so. The Authorization Code Flow has two major parts: the authorization code request and the access token request. https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow

Returns

Access token response

Parameters
Name Type Description
authorization_code System.String The previously-retrieved authorization_code.
scope System.String The scopes needed for the access token. Note that this can be fewer scopes than the authorization.

GetClientCredentialFlow() method

Summary

The OAuth client credentials flow is used to exchange a pair of client credentials (client_id and client_secret) for an access token. https://develop.battle.net/documentation/guides/using-oauth/client-credentials-flow

Returns

Access token response

Parameters

This method has no parameters.