Cold Storage: A Bungie API interface for Destiny 2

Overview

In order to access Bungie API endpoints which require authentication, we have to create an access token.

Creating an access token requires getting a user's permission with them granting it through an interface provided by Bungie

Access to Bungie's permission interface is provided by registering an app and then having a redirect from an https configured web page

1. Set up a bungie developer account.

2. Fill in the required information for the proposed app

3. Create a page to interface with the permission page

4. Retrieve the authorization code from the redirecdt page

5. Generate the token which allows permissions

Cold Storage page

• Navigate to https://sdl.org/coldstorage
• Click 'Get Authorization'
• Approve the Login when the Bungie permission page comes up
• copy the code from Cold storage when returned to https://sdl.org/coldstorage
• run node generateToken.js <code> where is the value from the previous step

General Info

Base Path: https://www.bungie.net/Platform

Membership Types:

Weapon Perks

https://d2.destinygamewiki.com/wiki/Weapon_Perks

Endpoints with Permission ReadBasicUserProfile

Applications.ApplicationScopes

ReadDestinyInventoryAndVault|64| This scope is needed to read anything regarded as private. This is the only scope a Destiny 2 app needs for read operations against Destiny 2 data such as inventory, vault, currency, vendors, milestones, progression, etc.

GET /User/GetMembershipsForCurrentUser/

https://bungie-net.github.io/multi/operation_get_User-GetMembershipDataForCurrentUser.html#operation_get_User-GetMembershipDataForCurrentUser

Returns a list of accounts associated with signed in user. This is useful for OAuth implementations that do not give you access to the token response.

Required Scope: ReadBasicUserProfile

GET /Tokens/Partner/History/{targetBnetMembershipId}/Application/{partnerApplicationId}/

https://bungie-net.github.io/multi/operation_get_Tokens-GetPartnerRewardHistory.html#operation_get_Tokens-GetPartnerRewardHistory

Returns the partner rewards history of the targeted user, both partner offers and Twitch drops.

Required Scope: "oauth2: PartnerOfferGrant"

partnerApplicationId The partner application identifier. Type|int32|targetBnetMembershipId The bungie.net user to return reward history for. Type|int64|

GET /Destiny2/{membershipType}/Profile/{destinyMembershipId}/Item/{itemInstanceId}/

https://bungie-net.github.io/multi/operation_get_Destiny2-GetItem.html#operation_get_Destiny2-GetItem

Retrieve the details of an instanced Destiny Item. An instanced Destiny item is one with an ItemInstanceId. Non-instanced items, such as materials, have no useful instance-specific details and thus are not queryable here.

destinyMembershipId: The membership ID of the destiny profile. Type|int64| itemInstanceId: The Instance ID of the destiny item. Type|int64| membershipType: A valid non-BungieNet membership type. The types of membership the Accounts system supports. This is the external facing enum used in place of the internal-only Bungie.SharedDefinitions.MembershipType. Type|int32|

GET /Destiny2/{membershipType}/Profile/{destinyMembershipId}/Item/{itemInstanceId}/

https://bungie-net.github.io/multi/operation_get_Destiny2-GetItem.html#operation_get_Destiny2-GetItem

Postman Example: {{baseUrlApi}}/Destiny2/{{membership_type}} /Profile/{{membership_id}}/Item/6917529865148649062?components=ItemInstances

ENUMs for Component Type

https://bungie-net.github.io/multi/schema_Destiny-DestinyComponentType.html#schema_Destiny-DestinyComponentType

Represents the possible components that can be returned from Destiny "Get" calls such as GetProfile, GetCharacter, GetVendor etc...

When making one of these requests, you will pass one or more of these components as a comma separated list in the "?components=" querystring parameter. For instance, if you want baseline Profile data, Character Data, and character progressions, you would pass "?components=Profiles,Characters,CharacterProgressions" You may use either the numerical or string values. Type|int32| Valid Enum Values

String Name	Int Value	Description
None	0
Profiles	100	Profiles is the most basic component, only relevant when calling GetProfile. This returns basic information about the profile, which is almost nothing: a list of characterIds, some information about the last time you logged in, and that most sobering statistic: how long you've played.
VendorReceipts	101	Only applicable for GetProfile, this will return information about receipts for refundable vendor items.
ProfileInventories	102	Asking for this will get you the profile-level inventories, such as your Vault buckets (yeah, the Vault is really inventory buckets located on your Profile)
ProfileCurrencies	103	This will get you a summary of items on your Profile that we consider to be "currencies", such as Glimmer. I mean, if there's Glimmer in Destiny 2. I didn't say there was Glimmer.
ProfileProgression	104	This will get you any progression-related information that exists on a Profile-wide level, across all characters.
PlatformSilver	105	This will get you information about the silver that this profile has on every platform on which it plays. You may only request this component for the logged in user's Profile, and will not recieve it if you request it for another Profile.
Characters	200	This will get you summary info about each of the characters in the profile.
CharacterInventories	201	This will get you information about any non-equipped items on the character or character(s) in question, if you're allowed to see it. You have to either be authenticated as that user, or that user must allow anonymous viewing of their non-equipped items in Bungie.Net settings to actually get results.
CharacterProgressions	202	This will get you information about the progression (faction, experience, etc... "levels") relevant to each character, if you are the currently authenticated user or the user has elected to allow anonymous viewing of its progression info.
CharacterRenderData	203	This will get you just enough information to be able to render the character in 3D if you have written a 3D rendering library for Destiny Characters, or "borrowed" ours. It's okay, I won't tell anyone if you're using it. I'm no snitch. (actually, we don't care if you use it - go to town)
CharacterActivities	204	This will return info about activities that a user can see and gating on it, if you are the currently authenticated user or the user has elected to allow anonymous viewing of its progression info. Note that the data returned by this can be unfortunately problematic and relatively unreliable in some cases. We'll eventually work on making it more consistently reliable.
CharacterEquipment	205	This will return info about the equipped items on the character(s). Everyone can see this.
CharacterLoadouts	206	This will return info about the loadouts of the character(s).
ItemInstances	300	This will return basic info about instanced items - whether they can be equipped, their tracked status, and some info commonly needed in many places (current damage type, primary stat value, etc)
ItemObjectives	301	Items can have Objectives (DestinyObjectiveDefinition) bound to them. If they do, this will return info for items that have such bound objectives.
ItemPerks	302	Items can have perks (DestinyPerkDefinition). If they do, this will return info for what perks are active on items.
ItemRenderData	303	If you just want to render the weapon, this is just enough info to do that rendering.
ItemStats	304	Items can have stats, like rate of fire. Asking for this component will return requested item's stats if they have stats.
ItemSockets	305	Items can have sockets, where plugs can be inserted. Asking for this component will return all info relevant to the sockets on items that have them.
ItemTalentGrids	306	Items can have talent grids, though that matters a lot less frequently than it used to. Asking for this component will return all relevant info about activated Nodes and Steps on this talent grid, like the good ol' days.
ItemCommonData	307	Items that aren't instanced still have important information you need to know: how much of it you have, the itemHash so you can look up their DestinyInventoryItemDefinition, whether they're locked, etc... Both instanced and non-instanced items will have these properties. You will get this automatically with Inventory components - you only need to pass this when calling GetItem on a specific item.
ItemPlugStates	308	Items that are "Plugs" can be inserted into sockets. This returns statuses about those plugs and why they can/can't be inserted. I hear you giggling, there's nothing funny about inserting plugs. Get your head out of the gutter and pay attention!
ItemPlugObjectives	309	Sometimes, plugs have objectives on them. This data can get really large, so we split it into its own component. Please, don't grab it unless you need it.
ItemReusablePlugs	310	Sometimes, designers create thousands of reusable plugs and suddenly your response sizes are almost 3MB, and something has to give. Reusable Plugs were split off as their own component, away from ItemSockets, as a result of the Plug changes in Shadowkeep that made plug data infeasibly large for the most common use cases. Request this component if and only if you need to know what plugs could be inserted into a socket, and need to know it before "drilling" into the details of an item in your application (for instance, if you're doing some sort of interesting sorting or aggregation based on available plugs. When you get this, you will also need to combine it with "Plug Sets" data if you want a full picture of all of the available plugs: this component will only return plugs that have state data that is per-item. See Plug Sets for available plugs that have Character, Profile, or no state-specific restrictions.
Vendors	400	When obtaining vendor information, this will return summary information about the Vendor or Vendors being returned.
VendorCategories	401	When obtaining vendor information, this will return information about the categories of items provided by the Vendor.
VendorSales	402	When obtaining vendor information, this will return the information about items being sold by the Vendor.
Kiosks	500	Asking for this component will return you the account's Kiosk statuses: that is, what items have been filled out/acquired. But only if you are the currently authenticated user or the user has elected to allow anonymous viewing of its progression info.
CurrencyLookups	600	A "shortcut" component that will give you all of the item hashes/quantities of items that the requested character can use to determine if an action (purchasing, socket insertion) has the required currency. (recall that all currencies are just items, and that some vendor purchases require items that you might not traditionally consider to be a "currency", like plugs/mods!)
PresentationNodes	700	Returns summary status information about all "Presentation Nodes". See DestinyPresentationNodeDefinition for more details, but the gist is that these are entities used by the game UI to bucket Collectibles and Records into a hierarchy of categories. You may ask for and use this data if you want to perform similar bucketing in your own UI: or you can skip it and roll your own.
Collectibles	800	Returns summary status information about all "Collectibles". These are records of what items you've discovered while playing Destiny, and some other basic information. For detailed information, you will have to call a separate endpoint devoted to the purpose.
Records	900	Returns summary status information about all "Records" (also known in the game as "Triumphs". I know, it's confusing because there's also "Moments of Triumph" that will themselves be represented as "Triumphs.")
Transitory	1000	Returns information that Bungie considers to be "Transitory": data that may change too frequently or come from a non-authoritative source such that we don't consider the data to be fully trustworthy, but that might prove useful for some limited use cases. We can provide no guarantee of timeliness nor consistency for this data: buyer beware with the Transitory component.
Metrics	1100	Returns summary status information about all "Metrics" (also known in the game as "Stat Trackers").
StringVariables	1200	Returns a mapping of localized string variable hashes to values, on a per-account or per-character basis.
Craftables	1300	Returns summary status information about all "Craftables" aka crafting recipe items.
SocialCommendations	1400	Returns score values for all commendations and commendation nodes.

itemHash itemInstanceId bucketHash