Almost a year since we last touched this changelog!
For this release, we've updated content for the Season of the Worthy and Trials of Osiris, and added support for new Traits, Trait Categories, and Metrics (aka Stat Trackers). We've also added 'icon sequences' to display properties, so that all of the icon frames from the game are now included in the content definitions.
I've been gone for a bit, so there's some other mostly content changes that have occurred between 2.3.4 and 2.3.5, but aside from that only some small changes have occurred in the API.
- Activity Categories and Modes now includes Gambit Prime and Reckoning, though Reckoning is experiencing ongoing issues with data consistency that may not be resolved given the way that the activity is set up. For the forseeable future, we recommend not attempting to build features around Reckoning historical stats.
- Removed some API endpoints that aren't actually possible to use with the rights we allow Applications to ask for.
- Some minor bug fixes for Milestones, and addition of new Vendor and PGCR data for Season of the Drifter.
In this patch, we have several changes from the Winter Wishlist, along with new content for Crimson Days and a variety of other smaller changes.
- Github Issues Resolved:
- #148 Add data to schema to indicate Flag enumerations
- #77 gendered*Names properties keyed by English strings
- #472 allPvP is including private matches
- #502 Provide a public Xur API
- #566 The Fall Will Kill You Objective is still classified
- #642 Release custom icon font
- #696 Vendor Lord Saladin's manifest definition has missing info
- #712 Can Competitive be added to the DestinyActivityModeType?
- #761 Feature Request: Add Vendor Hash to Applicable Items
- #796 Add Lord Saladin to Iron Banner Milestone [3427325023]
- #803 Add Triumph rewards to manifest
- #805 Sub-ranks for Valor and Glory are not reflected in the api
- #808 Clan Staffs are Classified
- #811 Account for randomized perks in base item definition stats
- #833 ActivityMode 68 (IronBannerSalvage) returning Iron Banner Control activities
- #844 Vendor caching is f'd
- #849 Activity history for forges
We've actually had a series of smaller updates and fixes between 2.3.2 and 2.3.3, but this is a rough outline of the changes as of today's deployment to catch us up.
- Github Issues Resolved:
- #805 Sub-ranks for Valor and Glory are not reflected in the api
- #785 The manifest will start including JSON-formatted Destiny definitions definitions
- #784 GameVersion in GetProfile once black armory comes out
- #771 Destiny endpoints will begin returning DestinyThrottledByGameServer in periods of high traffic
- #753 titles on Seal records not populated
- #744 Too many items' data returned in ItemComponents with GetProfile/GetCharacter/etc requests
- #742 Leviathan in Milestone Endpoint returns 2 normal and 2 GG hashes
- #724 2 burst side arms report 'zero' rounds per minute in the api
- #714 Some weapon show not available masterwork Tier upgrades
- #696 Vendor Lord Saladin's manifest definition has missing info
- #694 Record Objective
- #651 GetHistoricalStats (account or character) endpoints will not return Gambit/PvECompetitive stats for now
- #77 genderedNames properties keyed by English strings
- Many entities unredacted. More to come in 2018-10-02 release.
- Presentation Nodes now have an "Obscured" state, to reflect that state as it exists in the game
- Ongoing work to fix Activity Modes that are broken, and add support for upcoming activity modes
- Added Vendor and Item refresh/expiration dates (referenced through the issues below, but may be unclear unless you read all the details)
- Github Issues Resolved:
- #646 - Forsaken Checklist Updates
- #666 - Nightfalls' (et al) manifest displayProperties.name is just "Nightfall"
- #665 - PGCR Returning Mode 0
- #659 - Expiration time for items (bounties)
- #654 - Vendors (esp. Spider): wrong RefreshDate
- #651 - GetHistoricalStats (account or character) endpoints will not return Gambit/PvECompetitive stats for now
- #650 - Stats not returning Bow, Beam Rifle weapon/precision weapon stats
- #649 - sourceString hash for collectibles
- #648 - Public Milestones reports wrong end dates for 4 day reset items
- #641 - Need a Forsaken flag in DestinyGameVersions
- #638 - DestinyUnhandledException for various Stats endpoint calls on some accounts/activity modes
- #637 - Legendary/Rare Energy/Power with Kinetic Damage Type
- #629 - Daily Crucible Challenge missing from Milestones when Weekly Flashpoint is completed
- #628 - Unable to map Daily Heroic Story Mission Activitiy to specific mission
- #624 - Feature request: collectableHash on items
- #622 - (Some?) Items with Kinetic Damage have damageTypes but empty damageTypeHashes
- Changes related to new features in Forsaken (See the Wiki for more information)
- See the wiki linked above for more information: it covers the significant changes in this release.
- Changes related to new features in Forsaken (See the Wiki for more information)
- See the wiki for more info: Milestones in particular have changed in potentially backwards-incompatible ways
- #539 Curse of Osiris milestones
- #532 [question] where to get flashpoint location ?
- #523 Known Issue: Clans may be inaccessible, increase in timeouts
- #522 plugSources does not seem correct for shaders
- #514 Wrong kills/deaths/assists numbers for Rumble
- #513 "You're Welcome" ghost perk incorrectly classified as a Weapon Mod
- #511 Glass modifier missing in DestinySandboxPerkDefinition
- #506 /Platform/GlobalAlerts/
- #493 Display properties for PlugSets
- Added a new component for Profile-level Progression data: ProfileProgressions.
- For now, this will only have checklists. More will likely be added to it as time goes by.
- Added the concept of DestinyChecklistDefinition, and checklist data to Progression components returned from the API.
- Added some throwaway APIs for an upcoming update to the game.
- If you happen to dig through our Platform Client Javascript libraries to find our unpublished APIs, you'll likely see some APIs about "Triumphs." Yes, Triumphs are coming. Please don't build anything that relies on these endpoints: as the name of them implies, they're going to be thrown away once Triumphs is over. Such is the ethereal and ever-changing nature of Triumphs. It's very Zen-like, I assure you. The data that will both be truly interesting and that will actually persist once Triumphs is over is in the new Checklists data. (though not all checklists will be used in Triumphs, and vice-versa! I tried to get you all as many checklists as I could find data for.)
- A new endpoint, "GetLinkedProfiles", has been added to the Destiny 2 endpoints. The hope is that this will simplify some of your workflows if you find you've had to do a lot of manual workarounds and querying to find out if linked Platform accounts actually have Destiny information.
- A new activity mode, "Showdown", has been added.
- #504 : Known issue: "Crucible Labs" Activity Mode won't be in data until May 30th, Crucible Labs PGCRs will return as "All" until then. bug
- #501 : Equip Items (added a workaround where logged off characters can still equip)
- #485 : New Warmind items are not appearing in screenshots bug
- #476 : Official companion app doesn’t display the counter on Sentinel’s Shove bug
- #470 : The new Warmind vendor's (Ana Bray) faction definition is lacking tokenValues property bug investigation
- #469 : Since Warmind itemState property is not showing if an item is a masterwork bug
- #468 : Known bug: Nightfall Score Multiplier and Handicap not being returned bug
- #466 : Content Warning for DLC2: Several Activities removed from database, replaced with variants that have only changed identifiers definitions
- Item Stats now have "categories" enum, in case you want to sort stats
- Equipment Slot Definitions now have Art Dye Channels, so you don't have to hard code what channels to apply to items in a given equipment slot if you're doing 3D rendering.
- Item Preview Blocks now expose a "screenStyle" property: a string that the game UI (and you!) can use as a hint for how the item should be rendered if shown in a preview window/view.
- Vendor Categories now have information indicating if they are for display only (i.e. you can't actually buy the items shown), whether there is a currency item shown as a "featured" currency for that section, and various new fields about progressions that can be shown along with the category and other display information and hints.
- Various Activity Modes have been added for Private Match subcategories and Heroic Adventures
- The bug with private matches not categorizing correctly still exists, and will hopefully be resolved in time for the 5/16 BNet hotfix release.
- Objective Definitions now have new properties that can help you determine when you should show the objective's progress information (minimumVisibilityThreshold, allowOvercompletion, showValueOnComplete)
- Item's Plug definitions now expose style information that could be useful for you (styles, whether it's a "dummy" plug or a legitimate one etc...)
- Item's socket definitions now have "plug source" information, which tells you what components in live data need to be inspected to assemble all of the socket's possible reusable plug states.
- "Plug Sets" now exist as a concept: they indicate a set of reusable plugs that share common state across character or Account boundaries, and may be referred to by multiple sockets across multiple characters.
- Paired with this is the new "profilePlugSets" and "characterPlugSets" components on GetProfile/GetCharacter which will give you this reusable plug information that was previously only found on the item's "itemSockets" component itself.
- Item Objectives can now optionally have a "dateCompleted", which will tell you when the objective successfully was completed if it has been.
- Vendor components now have an optional "seasonalRank" property, that will tell you the value of their rank for this season if the vendor has one.
- Vendor sale items now have "augments": a flags enumeration value that indicates modifiers you can apply visually to the items being sold.
- New Milestones for DLC2!
- Emote wheel support (through "Plug Sets", see above), though changing your equipped emotes must take place with an "insert plugs" operation now, which is not currently available to 3rd parties. We hope to rectify that situation in the near future.
- All PVP activities have had their identifiers altered in game content, and thus the hash identifiers for them have been altered as well. PGCR data should compensate for this automatically, but if you had hard coded references to PVP activity names you will need to update those accordingly.
- GetApplicationApiUsage - A new endpoint for viewing your application's API usage.
- Fireteam Services - Many new endpoints for creating Fireteams through Clans that result in on-console Fireteam creation. Currently not available for 3rd party developers, but the documentation exists here for your reference in case we release this for more general use in the future.
- non-Crimson "Doubles" added as an Activity Mode, for potential future use. Added an "All Doubles" mode as a parent mode to both Crimson Doubles and non-Crimson doubles.
- Added a field to mark some Item Categories as "deprecated": categories that neither have any items currently in that category, nor will likely have items in that category in the future, but that I won't remove from the API in case doing so would break anyone with hard references to them.
- Rumble as an activity mode
- A new component, CurrencyLookups, that you can ask for alongside Vendor data for a quick reference of the requesting character's items and quantities of those items.
- The Vendor APIs are officially out of beta. Have at them, and as usual file any bugs you see!
- Insert Plugs action now ready for Bungie use, alongside the Advanced Write Action authorization flow. These features are not yet available to 3rd parties, but we will keep you posted.
- A new Application History page shows a user the in-game actions performed through both 1st and 3rd party applications, so that users can more reliably monitor what apps are doing with their characters, items etc.
- Team Scores added to Nightfall Strikes view on the web.
- There is a new component for Vendor requests, "VendorGroups". This grabs dynamic categorizations of groups for vendors, and comes with its own new set of Destiny Definitions in the manifest. This is a replacement for the confusing and obsolete "VendorCategories" concept from the Destiny 1.0 API, which not only wasn't as dynamic as we want but also was very confusing to talk about (given that vendor sale items are also grouped by "Categories").
- Two new activity modes: ScoredNightfall and ScoredHeroicNightfall.
- Vendor location data should now be accurate.
- Nightfall activities should now be categorized correctly.
- The following bugs were fixed:
- #430 Gunsmith reports the wrong mods for sale
- #429 Sonic Simulation Emblem is Classified
- #424 UnhandledException for Vendors on profile with little/no progress
- #423 All masterwork plugs are returned even if they can't actually be used
- #415 GetVendor: Kind of messy data
- #413 Some items are classified
- Vendor Categories was removed as a concept. There was already no data populating for this type of entity in Destiny 2, so it shouldn't cause anyone harm.
- Vendor definitions will now have "location" data, and DestinyVendorComponent will now have a "vendorLocationIndex" property. If a valid (>= 0) index, it will point to the index of DestinyVendorDefinition.locations data that you can use to show a vendor's destination and other human readable info. (actual population of that info is TBD, didn't quite make it out for release yet: but you can begin implementing against it in anticipation)
- Vendor components should be getting returned now from requests. Some data, such as time sensitive items, may still be incorrect and will have fixes in the next release.
- Vendors will no longer be returned if they can't be accessed in the game by the character in question (for instance, Xur will only appear once he appears on the map on Friday: but also, if the character hasn't reached the point where they are at the Tower, they won't see Tower-related Vendors in the results) (spoiler alert for those who haven't beaten the D2 campaign yet, sorry not sorry)
- Further improvements to the new Advanced Write Actions
- The following Github Issues were addressed:
- #412 NOTICE: DestinyVendorCategoryDefinition is going to be removed rfc
- #411 NOTICE: The Aura activity bucket will be left unused starting 2/27
- #402 RFC: emblemHash on DestinyCharacterComponent may no longer necessarily point to an emblem item
- #399 Weapon Mods with empty itemCategoryHashes
- #397 Include Mayhem in AllPvP mode
- #395 The daily strike milestone claims to have 48 challenges! instead of 3
- #394 Transfer between char x vault returning error for some item types
- #393 Armour Ornaments missing itemCategoryHashes
- #392 New Item Categories lack localized text for name/description
- #379 Clarification around instanced reusablePlugHashes data
- #348 Mayhem Mode in API
- #334 Heroic Strike DestinyActivityModeType
- New milestones added for the upcoming Crimson Days event
- Crimson re-added as a historical stats Activity Mode
- Still in-progress work for "Explore 2.0", which will be a new aggregation endpoint that provides a more personalized experience for the homepage and Companion. Completion date TBD, still in early prototyping phase. You'll see some new endpoints and contracts related to "Explore": pay no attention to the man behind the curtain!
- Ongoing work on Advanced Write Actions. We will make an announcement later about how these can be used in conjunction with the API. Rest assured that you will have to explicitly ask for permissions to use these new actions, that it will require 2 factor auth through Bungie's companion app itself, and that it will come with logging that users can inspect about actions taken through your app to safeguard your app from false accusations of undesired actions.
- #329, #322, #319, #206, #168 - A vast number of new Item Categories and ItemTypes/ItemSubTypes have been added. Check the documentation for further details.
- Vendor API responses should now have correct item component data. We're still adding more tests and implementing features against this data ourselves, so I'm not going to pull it out of beta until I feel a high level of confidence in it. But we're nearing the final threshold for having a fully functional vendor endpoint again.
- The "Trending" endpoint has been altered to make the front page of the site and app more news-oriented.
- #349, #88 - Challenges should be greatly improved, with proper challenges on Milestones that need them and not on ones that are unrelated.
- #348 - Mayhem mode should be working again in historical stats.
- #288 - Grenade kills should come through correctly once more.
- #181 - "Globally" applied stat bonuses from mods on equipped items now no longer get applied to any item other than the item on which it is equipped (if relevant to that item).
- #78 - Classified items now have a default blank icon applied to them.
- #166, #69 - Fixes to character stats that should not have been appearing, and forcing other stats to appear even if they are 0.
- Added support for returning Objective/Progress information for Reusable Plugs. When you see plugs that you can insert into sockets, but require you to complete an Objective to do so, that objective information is now being returned. See the changes to DestinyItemSocketsComponent, as this has been modified to store additional data about reusable plugs. DestinyItemObjectivesComponent now has an optional "flavorObjective" property. When items such as Emblems have stats that they show about the user, those are represented by flavorObjectives. Various data is added for Masterworks sockets:
- #154 Equipment Slot definitions are now finally making it out to the manifest database.
- The ItemState enum has a new value, "Masterwork", that indicates whether the item has a Masterwork plug inserted (since this ItemState property is on the basic DestinyItemComponent, this makes knowing whether the item is a Masterwork easier than having to iterate through the plugs inserted into the item)
- Extra state information was added to DestinyItemPlugDefinition and DestinySocketTypeDefinition (and its children) that should be useful (see definition for new properties and their documentation). Notably, Socket Type actions now convey the rules under which a plug can be inserted into a socket of that type. (These rules keep piling on each other! Sockets are getting pretty complicated) Socket Type whitelists also have reinitializationPossiblePlugHashes, which is the list of possible masterwork plugs that could be inserted when you "reinitialize" a masterwork socket.
- The template for player reporting URLs to redirect to us for player reports is:
- https://www.bungie.net/en/PGCR/Report/[PGCR ID]/?characterId=[Offending Character ID]
- It's kind of ugly right now, something I need to fix up when I get the time.
- The template for player reporting URLs to redirect to us for player reports is:
- #317 Fixed the issue where certain types of daily milestones were not being returned in all situations
- #324 Infusion Category changes mentioned in the bug have been implemented.
- Fixed a bug where challenges weren't being returned for Mercury's landing zone.
- Various items that should not have been redacted are now not redacted.
- New "PullFromPostmaster" endpoint, and accompanying changes to contracts
- New "ReportOffensivePostGameCarnageReportPlayer" endpoint, allowing players to report players that violated terms of service in games in which they participated.
- New Milestones for DLC1 and Season 2.
- Historical Stats APIs no longer in pre-release
- Vendor endpoint is still not quite ready for use, but the contracts are changing to better reflect the desired output of the API once it is ready for use. Comments and suggestions are welcome!
- Screenshots will now be at 1920 x 1080 resolution.
- Many changes were made over these months that I did not document well previously. I doubt anyone will care at this point, so I'm not going to bother fishing them all out now. But if anyone really cares enough that they want this historical information, file a Github issue and I'll get to it when we get to other documentation and spec improvements! Better documentation for what was specifically going out with releases started with 2.1.0, see above for that history.
- Initial implementation of Destiny 2 API, see documentation for more details
- Historical Stats are in a functional but Beta state, and have many bugs that still need resolving.
- Vendors are offline and not yet implemented; the endpoint and contract documentation is being provided for reference and public evaluation.