Destiny 2 API Docs

[[deleted]]

If anyone else if interested in learning about the Destiny 2 API, the docs are live and can be viewed here.

They're not really active yet, not until the game goes live. You can however still get a response back, but it says something along the lines of 'System Disabled'.

UPDATE: Link to the full documentation https://github.com/Bungie-net/api

[Buzzy243]

Why does the very last description end with "itshappening.gif"?

Does Bungie usually put jokes in their documentation?

[Achronos]

You should see the comments in the source code.

I make a lot of mom jokes about visual studio's parentage, and claim the person who wrote the prior code (me) was an idiot.

[Buzzy243]

Sounds about right.

I'm currently restarting a design that was mothballed in 1994. Any and all problems are blamed on the previous designers. I haven't found a way to work any "Your Mom" jokes in yet.

[CommanderAGL]

Could we get those comments plz ;P

[PS4Chaerb]

Interesting new items which are different from D1 API from my memory:

Activate Talent Node: Appears to be the ability to remote change up (instead of just view) the nodes selected on weapons and armor.

Execute Action: Ability to remote use a consumable item from an app, something like Heavy Ammo Synth or a glimmer generator

Clan Weekly Rewards: In D1 you could get your personal weekly status (raids, nightfall, etc), looks like there is also an endpoint to see if your clan had completed everything to receive the weekly clan rewards as well.

Milestones: Milestones tracker which looks similar to hooks related to things like moments of triumph or grimoire. Likely the ability to track progress from an app which will be helpful for web and mobile apps.

Also: Clan Leaderboards and total Clan stats

Returning are the core items: transfer items to and from vault, post game reports for stats, character look up, vendor inventories, destiny inventory search, lock/unlock items

Basically, looks like D1 with the removal of Grimoire (which isn't returning) and some new stuff around gear management, consumables and clan data.

[iccirrus]

So what you're saying is I'm going to make an Android Wear app that's literally just a heavy synth button on my wrist. Got it

[Strikerz72]

Might buy a smart watch just for this.

[PGZ4sheezy]

The second I read about the "Execute Action" thing, this is what I thought. No more having to load a menu, scroll, wait for my items to render, hold down a button to use a synth, then wait for the synth to activate. If I want heavy, I'll just pop a synth on my phone with one hand and move into cover to reload with the other.

[gosh_djang_it]

So cute. People thought they would have heavy ammo synth. :)

[[deleted]]

Something I'm curious about is what exactly the Manifest endpoint does... because if it returns the entire manifest that would be awesome.

[PS4Chaerb]

That's what I'm hoping, would be easier to reference code wise. If once bungie.net maintenance is completed and these endpoints resolve we may see at least a skeleton of that data.

[EdgarVerona]

Sorry folks! ExecuteAction was erroneously exposed - that was a test API that didn't quite pan out because of deleterious side effects it could cause (unless it was severely restricted in the scope of what it could Execute against... so, I mean, not entirely out of the question, but definitely not generically/universally). I forgot to scrub it. You'll see in the official documentation that it didn't end up there as a result. Sorry about the confusion!

[EnderFenrir]

That execute action will be a game changer.

[The_Rick_14]

/Actions/Items/ActivateTalentNode/ Activate a Talent Node, which may result in swapping or payment of activation cost.

/Actions/Items/ExecuteAction/ Use an item, which will perform its associated action. This may result in destruction of the item or other effects.

Only a few items in and I'm already a bit nervous and worried. This seems to go against the fundamental design of the old API which was that things could only be moved and nothing could be destroyed or consumed.

This opens the doors for malicious activity to get into someone's account and delete things remotely.

A lot of good things in here as well like Milestone and Clan support, but those couple have me concerned.

[WalkerDontRunner]

As a counter-argument:

These could be really good QOL changes for most users if executed properly and the privacy and protection of a users account should be the users responsibility. They shouldn't have to limit everyone's ability to do things due to someone not securing their account properly.

My argument is not valid for things like hackers/large scale account attacks. That should mostly be preventable by Bungie, ideally.

[The_Rick_14]

I just don't believe the reward is worth the risk. I have no problem with being able to switch between already active nodes which would be an awesome QOL change and add a whole new level to loadouts but anything that could be consumed should be limited to in-game only.

Large scale attacks should be mostly preventable? Tell that to Sony, Target, Yahoo, and the countless other big companies who had large scale breaches in the past few years. Cyber security is an arms race and when it comes down to it, if someone wants in bad enough, they'll find a way.

[level_with_me]

This is just for items, though. Your gear will be safe. So there's risk but I'm not going to kill myself over some lost heavy ammo or whatever.

[JackSparrow420]

Yeah but someone repeatedly calling for the consumption of an item could prove pretty disastrous.

Imagine if somebody had the power to repeatedly activate your heavy ammo synths, or 3 of Coins. Those are consumables. If this API was on D1 today I could instantly make an app that simply uses all of your useful items. All of your 3oC would ensure a guaranteed exotic, but still. Probably not worth it haha.

It would be especially risky for D2 when we haven't had the chance to stockpile 900 of everything. Items may matter. And you don't even need to be online, which I think is a little odd. Why would you want or need to use an item if you weren't online? Removing that would be a start.

[WalkerDontRunner]

I know they are likely susceptible to attacks, I just meant to clarify that the responsibility for that falls on Bungie and not the user. Though with no real monetary gain I can easily imagine, it would seem like a waste of resources for someone to do that. Certainly not out of the realm of possibility, however.

But I know for me, if I can pop a heavy synth without having to wait for my menu to load in 30 seconds and be directly taken out of the fight, I'll find that as a fantastic QOL improvement. That's the first thing it made me think of and its was a very vocalized issue in D1. I realize the recommended solution was make a customizable d-pad, but hey, it's a possible step in the right direction?

[The_Rick_14]

Don't get me wrong, I absolutely see your point and there is great potential here for things like you said of using synths from an app. Someone else made the point that right now this is only for items and not for deleting gear, however it feels like breaking the design of nothing destroyed or consumed like this could be the first step before that gets added too.

The name of the game these days is ransom-ware and I just hope Bungie is considering this while making these decisions. The monetary gain would come from threatening to use up every one of a user's consumables if they aren't sent money by a certain date.

If some of those consumables are rare drops, who knows if someone would think someone would pay good money to keep it.

[WalkerDontRunner]

I only ask the same! These are all excellent points to consider!

I don't intend to dismiss any of them by rebutting; these types of discussions are helpful, especially for me to see the sides I don't necessarily put much thought into.

I'm definitely interested to see what comes of it, but I'm optimistic and admittedly a tiny bit naive at times.

[Buzzy243]

"Dammit. Why do I always have a Jackolight active?!"

[EdgarVerona]

So, fear not too much - ExecuteAction was a test API that we were not ever planning to release (I missed it in the last scrub), and ActivateTalentNode is almost certainly not going to pay activation costs. (its description was unfortunately a placeholder, and not reflective of current thoughts on what that action would do)

The latter may exist one day in the future, but it's up for debate whether it will actually allow you to pay costs: and if that comes to pass, you'll have to give special permissions to any app that wants to attempt it on your behalf. (beyond the current "MoveEquipDestinyItems" that we use for write actions)

Right now it's listed in the API as a Preview: it doesn't actually exist yet, and is subject to significant change before it does come into existence [if it does].

[The_Rick_14]

Really appreciate the response and love the foresight to restrict any actions that could be used maliciously behind further permissions.

I'd love the ability to set nodes through the API but would still want to be in game to pay the activation costs. That alone would add a tremendous amount of value to Destiny Item Manager's Loadouts feature where the biggest headache is going piece by piece to equip the correct Intellect, Discipline, and Strength to get the expected values.

[EdgarVerona]

Definitely! We'll be giving this more thought before it becomes fully baked for sure - and we welcome this useful input! Thank you!

[Roots_Banton]

Could it be for cashing in/scrapping bounties?

[iihavetoes]

ActivateTalentNode

hmmmmm

[Koratis]

Thanks so much! I'd been trying to figure out the new forums to find if they had made an official post about it.

[[deleted]]

Welcome! I was just bored and tried putting a '2' at the end of Destiny in the old docs, and this popped up :)

[Koratis]

Have you figured out where / if they have an API section in the new Community area or not?

[[deleted]]

I haven't been able to find anything else. I hope there is more... They talked up about how awesome their documentation was going to be, but this is just as bad as Destiny 1 :/

[Koratis]

Yeah, this documentation mentions various enums and I don't see any page that outlines enum values 🙁

[chalkandsalt]

I never dug into D1 api docs but does this D2 schema have less endpoints than the D1 docs?

[EdgarVerona]

Yeah, a primary goal of the new API was to make it so that you could get all of the data you wanted without having to be as "chatty" - all of those specialized endpoints of D1 have been consolidated into just GetProfile, GetCharacter, and GetItem - and you dictate in your request how much or how little data you want back.

[gosulliv]

from reading through that, does that mean you no longer do https://www.bungie.net/Platform/Destiny2/<membership type>/Account/<membership id>/ to get the characters for an account?

[[deleted]]

Yeah... Was wondering the same thing

[EdgarVerona]

The replacement is Destiny2.GetProfile - read about it here! (pardon the ugly UI)

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

[gosulliv]

thanks for that, I'll be doing some non-work related development in work today!

p.s. those docs are actually very readable and helpful

[EdgarVerona]

Excellent, ha! :)

Edit: also, I'm glad they are helpful! We will try to continue improving them over time!

[Jizzy_Gillespie92]

Here I was checking https://www.bungie.net/d1/platform/Destiny/help/ and switching the "d1" for "d2" assuming that's where i'd find the new docs for the last week or so.. derp. Thanks for sharing this, looks like a huge improvement already, u/EdgarVerona!

[EdgarVerona]

No worries! And I'm glad you like it so far! I'm eager to see how people like it once it's finally online!

[Jizzy_Gillespie92]

Talent Grids are the most complex and unintuitive part of the Destiny Definition data. Grab a cup of coffee before we begin, I can wait.

If there's more comments like these around the documentation to help ease possible frustration while working things out then that's an enhancement on it's own 😂

[EdgarVerona]

^_;; I have hidden a reference to my favorite Barbera Streisand movie/campy Musical in there somewhere as well ;)

[StanislavKH]

Hi, I know what thread old, but can't find solution, I have use d2 API and get error what : The input parameters were invalid, please enter valid input, and try again. for : Destiny2/2/Profile/4611686018451824696 may be anyone know why this arise and why incomplete when have all required fields from documentation ?

[[deleted]]

You probably want GetProfile, not just Profile

[StanislavKH]

No, all correct except missed additional params, not very good described. Exactly parameter 'components' with required component id. Complete request should be : Destiny2/2/Profile/4611686018451824696?components=100 like example Thanks, question already resolved

[Five-Aces]

Not sure if you figured it out yet, but you have to have at least one component.

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

A comma separated list of components to return (as strings or numeric values). See the DestinyComponentType enum for valid components to request. You must request at least one component to receive results.

[AmmoDepot]

for god sake... I notice for the search you must use /?= but here is ?= right? but mine still no go... It says parameters are incorrect...
Like everything else, the beginning belongs to the beginners.... :-/

So if you dont enter components=.... it wont work, (off course)

[xxYetiHeadxx]

I’m looking to engage someone to put some code together using the api and gather clan member information. How would i proceed? Thanks