The Bungie.Net API

Full Documentation: https://bungie-net.github.io/multi/index.html

Documentation as one single, gigantic page: https://bungie-net.github.io

This section will be added to as time goes by - we're working with it as we go!

2025-12-02 Update for Renegades

• Added unclaimedOrderRewards and orderRewardsUnlockValueHashesToRewardItemHashes to offer a method of getting the number of type of earned, unclaimed rewards from Orders.
• Added images for Featured Quests.

2025-11-18 Portal Root Nodes and enum value fixes

• Added portalActivityGraphRootNodesWithIcons to DestinyGlobalConstantsDefinition to assist Portal representation.
• Fix enum values being when Strings when intended to be Integers.

2025-10-14 Update for Portal Activities

• Added curatorBlockDefinition and durationEstimate to DestinyActivityDefinition.
• Added difficultyTierCollections and selectableSkullCollections to DestinyCharacterActivitiesComponent.

2025-09-26 Nullable Enum Properties

• Updated nullable enum type properties to reference the enum definitions, rather than redefining them.

2025-09-16 Extra Item Icon Layers

• Added extra static item icon layer image paths to DestinyInventoryItemConstantsDefinition.

2025-09-10 Update for Ash & Iron

• Added selectableSkullCollections to DestinyActivityDefinition.
• Added currentSeasonPassHash to DestinyProfileComponent and Destiny2CoreSettings.

2025-08-26 Destiny Global Constants Definition

• Finally added specs for DestinyGlobalConstantsDefinition, but this has existed for a while now. Sorry!

2025-08-19 Item Icon Layers and PGCR Scoreboards

• Added DestinyIconDefinition for individual inventory item icon layers.
  • Added iconHash to DestinyDisplayPropertiesDefinition for inventory item icons only.
  • Also added useful static item icon layer image paths to DestinyInventoryItemConstantsDefinition.
• Added scoreboardValues to DestinyPostGameCarnageReportExtendedData for Crucible player scores, reward scores, multipliers, and more.
  • There will be some overlap between scoreboardValues and other existing stat values in PGCRs.

2025-08-05 Follow-up for The Edge of Fate

• Added isHolofoil and isAdept to DestinyInventoryItemDefinition.
• Fixed DestinyItemFilterDefinition and renamed setItems to allowedItems.

2025-07-29 Follow-up for The Edge of Fate

• Added account-owned seasonPassHashes to DestinyProfileComponent.
• Added visibleRewards to DestinyActvity, which includes Bonus Focus rewards from the Portal.
• Fixed the incorrect enum flag values for DestinyGameVersions.
• Removed Fireteam Finder API specs that are not available to 3rd-party apps.

2025-07-15 Update for The Edge of Fate

• Items
  • Added support for featured items and armor sets in DestinyInventoryItemDefinition.
  • Added the gear tier to DestinyItemInstanceComponent.
  • Added DestinyInventoryItemConstantsDefinition for gear tier icon overlays.
  • Added the featured items list and armor archetype plug set hash to Destiny2CoreSettings.
• Activities
  • Added support for activity families, traits, difficulty tiers, and selectable skulls in DestinyActivityDefinition.
  • Added the difficulty tier index and selected skull hashes to DestinyPostGameCarnageReportData.
• Seasons
  • Added seasonPassList to support two reward passes in a DestinySeasonDefinition.
  • Added the seasonalHubEventCardHash to Destiny2CoreSettings.

2025-05-09 Update for Rite of the Nine

• Added new fields to DestinyEventCardDefinition to support Heavy Metal event cards.
  • These fields are eventCardCurrencyList, weeklyChallengesPresentationNodeHash, and rewardProgressionHash.
• Fixed the FireteamFinderApplicantNotInGame Fireteam Finder error code.
  • Now it is unique, rather than the same integer as another error code.

2024-12-08 Update for the Dawning

• Added support for socket override definitions and states on season passes.
  • Added socketOverrides to DestinyProgressionRewardItemQuantity definitions to reference socket types and plug items.
  • Added rewardItemSocketOverrideStates to DestinyProgression for season pass rewards.
    • This includes rewardItemStats for armor rolls and itemState for Deepsight red-border weapons.
• Added support for virtual stack sizes on material requirements.
  • Added hasVirtualStackSize to DestinyMaterialRequirement definitions, which would require the new material requirement states.
  • Added materialRequirementSetStates to DestinyCurrenciesComponent with the CurrencyLookups component.
    • The materialRequirementStates include an itemHash, a required count and a current stackSize (which may be virtual).

2024-10-08 Update for Episode: Revenant

• Added DestinyVendorItemComponentSet to return DestinyItemComponent objects for Vendor sale items.
  • Request the itemComponents with the ItemCommonData component type.
  • DestinyItemComponent.state provides Deepsight red-border status.
  • DestinyItemComponent.tooltipNotificationIndexes provides tooltips, relevant for the new potions.
• Added stackSize and maxStackSize to socket plugs.
  • The stackSize shows the number of potions you've brewed in the Tonic Capsule sockets.

2024-07-16 Update for Lost Sectors

• Added availableActivityInteractables to DestinyCharacterActivitiesComponent.
  • Finally adds support for today's Expert and Master Lost Sector activities.
  • Also includes in-world activity interactables (totems) for campaign missions and the like.
  • Cross-reference with availableActivities for those that can also be launched from the Director.

2024-07-10 Update for The Final Shape

• Added acts to DestinySeasonDefinition for the new Episodes.
• Added an isVisible flag to DestinyArtifactTierItem.
• Added a new DestinyActivityModeType enum value for 'Relic' activities.
• Added a recordTypeName to DestinyRecordDefinition.
• Replaced obscuredString with obscuredName and obscuredDescription on record definition state blocks.
• Added commendationNodePercentagesByHash to DestinySocialCommendationsComponent.
• Added a tintedIcon to DestinySocialCommendationNodeDefinition.
• Added guardianRankHashes to DestinyGuardianRankConstantsDefinition.
• Added the renewedGuardianRank to DestinyProfileComponent.

2023-02-28 Update for Lightfall

• Added Loadouts, Guardian Ranks, and Commendations!

2022-12-06 Update for the Season of the Seraph

• Added responseMintedTimestamp and secondaryComponentsMintedTimestamp to DestinyProfileResponse.
  • Use these new values to handle stale cached responses from the Destiny2.GetProfile API.
• Added new EquipFailureReason enum flag values, and renamed ItemNotOnCharacter to ItemWrapped.
• Added new categoryfilter and includebody parameters to the /Content/Rss/NewsArticle/<page>/ API.
  • Going forward, new news content will be available via the RSS feeds and this API.

2022-08-23 Update for the Season of Plunder

• Added Support for Epic Games accounts.

2022-07-19 Update for Solstice 2022

• Added DestinyEventCardDefinition for the new seasonal Event Card feature.
  • The Event Card challenges root node has three child nodes (one for each character class), so clients should respect node visibility to show the appropriate records.
• Added new properties for eventCardHashesOwned and activeEventCardHash to DestinyProfileComponent.

2022-05-24 Update for the Season of the Haunted

• Added new DestinyActivityModeType enum values for Zone Control, Rift, and Iron Banner: Rift.
• Added a displayHint string property to DestinyTraitDefinition.
• Added a shouldShowLargeIcons boolean property to DestinyRecordDefinition.
• Added a new DestinyVendorItemState enum value for Locked sale items.

2022-05-01 Update for housekeeping

• Added a definition mapping and specification for DestinySandboxPatternDefinition.
• Fixed the DestinyTraitCategoryDefinition.traitHashes mapping to properly reference DestinyTraitDefinition.
• Added a deprecation warning to DestinyObjectiveDefinition.valueStyle, which is no longer populated by game content.
  • Please use inProgressValueStyle and completedValueStyle instead.

2022-02-22 Update for The Witch Queen

• Items
  • Added new ItemState flag values for Shaped (Crafted) and Deepsight (HighlightedObjective) weapons.
  • Added DestinyItemCraftingBlockDefinition for more details in crafting recipe (Pattern) item definitions.
  • Added recipeItemHash to DestinyItemInventoryBlockDefinition for a reference to the crafted item's recipe (Pattern) definition.
  • Added craftingRequirements to DestinyItemSocketEntryPlugItemRandomizedDefinition for plugs used in crafting.
    • New 'Enhanced Trait' plug item definitions have an inventory.tierType value of Common (3) instead of Basic (2).
  • Added a new DestinyItemSubType for Glaive weapons.
• Objectives
  • Added uiLabel and uiState properties to DestinyObjectiveDefinition.
  • Added DestinyObjectiveUiStyle enum values for highlighted objectives (Deepsight), crafted item objectives (date, level, progress), and memento reward objectives.
  • Added LevelAndReward to DestinyUnlockValueUIStyle for memento reward objectives.
• Craftables
  • Added the craftingRootNodeHash to Destiny2CoreSettings for the display of Shaping progress.
    • The exoticCatalystsRootNodeHash now includes unlock progress records for weapon shaping 'Patterns' as well as Exotic Catalysts.
  • Added craftables (crafting recipe items) as children of DestinyPresentationNodeDefinition.
  • Added a new Craftables enum value for DestinyComponentType for use with GetProfile.
  • Added characterCraftables state to DestinyProfileResponse.
    • Only initial Shaping state is returned, not Reshaping state.
• Material Requirements can n