Bungie.Net API

Tools (136)

Extracted live via the executor SDK.

• app.getApplicationApiUsage

  Get API usage by application for time frame specified. You can go as far back as 30 days ago, and can ask for up to a 48 hour window of time in a single request. You must be authenticated with at least the ReadUserData permission to access this endpoint.

• app.getBungieApplications

  Get list of applications created by Bungie.

• communityContent.getCommunityContent

  Returns community content.

• content.getContentById

  Returns a content item referenced by id

• content.getContentByTagAndType

  Returns the newest item that matches a given tag and Content Type.

• content.getContentType

  Gets an object describing a particular variant of content.

• content.rssNewsArticles

  Returns a JSON string response that is the RSS feed for news articles.

• content.searchContentByTagAndType

  Searches for Content Items that match the given Tag and Content Type.

• content.searchContentWithText

  Gets content based on querystring information passed in. Provides basic search and text search capabilities.

• content.searchHelpArticles

  Search for Help Articles.

• destiny2.awaGetActionToken

  Returns the action token if user approves the request.

• destiny2.awaInitializeRequest

  Initialize a request to perform an advanced write action.

• destiny2.awaProvideAuthorizationResult

  Provide the result of the user interaction. Called by the Bungie Destiny App to approve or reject a request.

• destiny2.clearLoadout

  Clear the identifiers and items of a loadout.

• destiny2.equipItem

  Equip an item. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline.

• destiny2.equipItems

  Equip a list of items by itemInstanceIds. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline. Any items not found on your character will be ignored.

• destiny2.equipLoadout

  Equip a loadout. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline.

• destiny2.getActivityHistory

  Gets activity history stats for indicated character.

• destiny2.getCharacter

  Returns character information for the supplied character.

• destiny2.getClanAggregateStats

  Gets aggregated stats for a clan using the same categories as the clan leaderboards. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.

• destiny2.getClanBannerSource

  Returns the dictionary of values for the Clan Banner

• destiny2.getClanLeaderboards

  Gets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.

• destiny2.getClanWeeklyRewardState

  Returns information on the weekly clan rewards and if the clan has earned them or not. Note that this will always report rewards as not redeemed.

• destiny2.getCollectibleNodeDetails

  Given a Presentation Node that has Collectibles as direct descendants, this will return item details about those descendants in the context of the requesting character.

• destiny2.getDestinyAggregateActivityStats

  Gets all activities the character has participated in together with aggregate statistics for those activities.

• destiny2.getDestinyEntityDefinition

  Returns the static definition of an entity of the given Type and hash identifier. Examine the API Documentation for the Type Names of entities that have their own definitions. Note that the return type will always inherit from DestinyDefinition, but the specific type returned will be the requested entity type if it can be found. Please don't use this as a chatty alternative to the Manifest database if you require large sets of data, but for simple and one-off accesses this should be handy.

• destiny2.getDestinyManifest

  Returns the current version of the manifest as a json object.

• destiny2.getHistoricalStats

  Gets historical stats for indicated character.

• destiny2.getHistoricalStatsDefinition

  Gets historical stats definitions.

• destiny2.getHistoricalStatsForAccount

  Gets aggregate historical stats organized around each character for a given account.

• 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.

• destiny2.getLeaderboards

  Gets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint has not yet been implemented. It is being returned for a preview of future functionality, and for public comment/suggestion/preparation.

• destiny2.getLeaderboardsForCharacter

  Gets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.

• destiny2.getLinkedProfiles

  Returns a summary information about all profiles linked to the requesting membership type/membership ID that have valid Destiny information. The passed-in Membership Type/Membership ID may be a Bungie.Net membership or a Destiny membership. It only returns the minimal amount of data to begin making more substantive requests, but will hopefully serve as a useful alternative to UserServices for people who just care about Destiny data. Note that it will only return linked accounts whose linkages you are allowed to view.

• destiny2.getPostGameCarnageReport

  Gets the available post game carnage report for the activity ID.

• destiny2.getProfile

  Returns Destiny Profile information for the supplied membership.

• destiny2.getPublicMilestoneContent

  Gets custom localized content for the milestone of the given hash, if it exists.

• destiny2.getPublicMilestones

  Gets public information about currently available Milestones.

• destiny2.getPublicVendors

  Get items available from vendors where the vendors have items for sale that are common for everyone. If any portion of the Vendor's available inventory is character or account specific, we will be unable to return their data from this endpoint due to the way that available inventory is computed. As I am often guilty of saying: 'It's a long story...'

• destiny2.getUniqueWeaponHistory

  Gets details about unique weapon usage, including all exotic weapons.

• destiny2.getVendor

  Get the details of a specific Vendor.

• destiny2.getVendors

  Get currently available vendors from the list of vendors that can possibly have rotating inventory. Note that this does not include things like preview vendors and vendors-as-kiosks, neither of whom have rotating/dynamic inventories. Use their definitions as-is for those.

• destiny2.insertSocketPlug

  Insert a plug into a socketed item. I know how it sounds, but I assure you it's much more G-rated than you might be guessing. We haven't decided yet whether this will be able to insert plugs that have side effects, but if we do it will require special scope permission for an application attempting to do so. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline. Request must include proof of permission for 'InsertPlugs' from the account owner.

• destiny2.insertSocketPlugFree

  Insert a 'free' plug into an item's socket. This does not require 'Advanced Write Action' authorization and is available to 3rd-party apps, but will only work on 'free and reversible' socket actions (Perks, Armor Mods, Shaders, Ornaments, etc.). You must have a valid Destiny Account, and the character must either be in a social space, in orbit, or offline.

• destiny2.pullFromPostmaster

  Extract an item from the Postmaster, with whatever implications that may entail. You must have a valid Destiny account. You must also pass BOTH a reference AND an instance ID if it's an instanced item.

• destiny2.reportOffensivePostGameCarnageReportPlayer

  Report a player that you met in an activity that was engaging in ToS-violating activities. Both you and the offending player must have played in the activityId passed in. Please use this judiciously and only when you have strong suspicions of violation, pretty please.

• destiny2.searchDestinyEntities

  Gets a page list of Destiny items.

• destiny2.searchDestinyPlayerByBungieName

  Returns a list of Destiny memberships given a global Bungie Display Name. This method will hide overridden memberships due to cross save.

• destiny2.setItemLockState

  Set the Lock State for an instanced item. You must have a valid Destiny Account.

• destiny2.setQuestTrackedState

  Set the Tracking State for an instanced item, if that item is a Quest or Bounty. You must have a valid Destiny Account. Yeah, it's an item.

• destiny2.snapshotLoadout

  Snapshot a loadout with the currently equipped items.

• destiny2.transferItem

  Transfer an item to/from your vault. You must have a valid Destiny account. You must also pass BOTH a reference AND an instance ID if it's an instanced item. itshappening.gif

• destiny2.updateLoadoutIdentifiers

  Update the color, icon, and name of a loadout.

• fireteam.getActivePrivateClanFireteamCount

  Gets a count of all active non-public fireteams for the specified clan. Maximum value returned is 25.

• fireteam.getAvailableClanFireteams

  Gets a listing of all of this clan's fireteams that are have available slots. Caller is not checked for join criteria so caching is maximized.

• fireteam.getClanFireteam

  Gets a specific fireteam.

• fireteam.getMyClanFireteams

  Gets a listing of all fireteams that caller is an applicant, a member, or an alternate of.

• fireteam.searchPublicAvailableClanFireteams

  Gets a listing of all public fireteams starting now with open slots. Caller is not checked for join criteria so caching is maximized.

• forum.getCoreTopicsPaged

  Gets a listing of all topics marked as part of the core group.

• forum.getForumTagSuggestions

  Gets tag suggestions based on partial text entry, matching them with other tags previously used in the forums.

• forum.getPoll

  Gets the specified forum poll.

• forum.getPostAndParent

  Returns the post specified and its immediate parent.

• forum.getPostAndParentAwaitingApproval

  Returns the post specified and its immediate parent of posts that are awaiting approval.

• forum.getPostsThreadedPaged

  Returns a thread of posts at the given parent, optionally returning replies to those posts as well as the original parent.

• forum.getPostsThreadedPagedFromChild

  Returns a thread of posts starting at the topicId of the input childPostId, optionally returning replies to those posts as well as the original parent.

• forum.getRecruitmentThreadSummaries

  Allows the caller to get a list of to 25 recruitment thread summary information objects.

• forum.getTopicForContent

  Gets the post Id for the given content item's comments, if it exists.

• forum.getTopicsPaged

  Get topics from any forum.

• getAvailableLocales.getOperation

  List of available localization cultures

• globalAlerts.getGlobalAlerts

  Gets any active global alert for display in the forum banners, help pages, etc. Usually used for DOC alerts.

• groupV2.abdicateFoundership

  An administrative method to allow the founder of a group or clan to give up their position to another admin permanently.

• groupV2.addOptionalConversation

  Add a new optional conversation/chat channel. Requires admin permissions to the group.

• groupV2.approveAllPending

  Approve all of the pending users for the given group.

• groupV2.approvePending

  Approve the given membershipId to join the group/clan as long as they have applied.

• groupV2.approvePendingForList

  Approve all of the pending users for the given group.

• groupV2.banMember

  Bans the requested member from the requested group for the specified period of time.

• groupV2.denyAllPending

  Deny all of the pending users for the given group.

• groupV2.denyPendingForList

  Deny all of the pending users for the given group that match the passed-in .

• groupV2.editClanBanner

  Edit an existing group's clan banner. You must have suitable permissions in the group to perform this operation. All fields are required.

• groupV2.editFounderOptions

  Edit group options only available to a founder. You must have suitable permissions in the group to perform this operation.

• groupV2.editGroup

  Edit an existing group. You must have suitable permissions in the group to perform this operation. This latest revision will only edit the fields you pass in - pass null for properties you want to leave unaltered.

• groupV2.editGroupMembership

  Edit the membership type of a given member. You must have suitable permissions in the group to perform this operation.

• groupV2.editOptionalConversation

  Edit the settings of an optional conversation/chat channel. Requires admin permissions to the group.

• groupV2.getAdminsAndFounderOfGroup

  Get the list of members in a given group who are of admin level or higher.

• groupV2.getAvailableAvatars

  Returns a list of all available group avatars for the signed-in user.

• groupV2.getAvailableThemes

  Returns a list of all available group themes.

• groupV2.getBannedMembersOfGroup

  Get the list of banned members in a given group. Only accessible to group Admins and above. Not applicable to all groups. Check group features.

• groupV2.getGroup

  Get information about a specific group of the given ID.

• groupV2.getGroupByName

  Get information about a specific group with the given name and type.

• groupV2.getGroupByNameV2

  Get information about a specific group with the given name and type. The POST version.

• groupV2.getGroupOptionalConversations

  Gets a list of available optional conversation channels and their settings.

• groupV2.getGroupsForMember

  Get information about the groups that a given member has joined.

• groupV2.getInvitedIndividuals

  Get the list of users who have been invited into the group.

• groupV2.getMembersOfGroup

  Get the list of members in a given group.

• groupV2.getPendingMemberships

  Get the list of users who are awaiting a decision on their application to join a given group. Modified to include application info.

• groupV2.getPotentialGroupsForMember

  Get information about the groups that a given member has applied to or been invited to.

• groupV2.getRecommendedGroups

  Gets groups recommended for you based on the groups to whom those you follow belong.

• groupV2.getUserClanInviteSetting

  Gets the state of the user's clan invite preferences for a particular membership type - true if they wish to be invited to clans, false otherwise.

• groupV2.groupSearch

  Search for Groups.

• groupV2.individualGroupInvite

  Invite a user to join this group.

• groupV2.individualGroupInviteCancel

  Cancels a pending invitation to join a group.

• groupV2.kickMember

  Kick a member from the given group, forcing them to reapply if they wish to re-join the group. You must have suitable permissions in the group to perform this operation.

• groupV2.recoverGroupForFounder

  Allows a founder to manually recover a group they can see in game but not on bungie.net

• groupV2.unbanMember

  Unbans the requested member, allowing them to re-apply for membership.

• settings.getCommonSettings

  Get the common settings used by the Bungie.Net environment.

• social.acceptFriendRequest

  Accepts a friend relationship with the target user. The user must be on your incoming friend request list, though no error will occur if they are not.

• social.declineFriendRequest

  Declines a friend relationship with the target user. The user must be on your incoming friend request list, though no error will occur if they are not.

• social.getFriendList

  Returns your Bungie Friend list

• social.getFriendRequestList

  Returns your friend request queue.

• social.getPlatformFriendList

  Gets the platform friend of the requested type, with additional information if they have Bungie accounts. Must have a recent login session with said platform.

• social.issueFriendRequest

  Requests a friend relationship with the target user. Any of the target user's linked membership ids are valid inputs.

• social.removeFriend

  Remove a friend relationship with the target user. The user must be on your friend list, though no error will occur if they are not.

• social.removeFriendRequest

  Remove a friend relationship with the target user. The user must be on your outgoing request friend list, though no error will occur if they are not.

• tokens.applyMissingPartnerOffersWithoutClaim

  Apply a partner offer to the targeted user. This endpoint does not claim a new offer, but any already claimed offers will be applied to the game if not already.

• tokens.claimPartnerOffer

  Claim a partner offer as the authenticated user.

• tokens.forceDropsRepair

  Twitch Drops self-repair function - scans twitch for drops not marked as fulfilled and resyncs them.

• tokens.getBungieRewardsForPlatformUser

  Returns the bungie rewards for the targeted user when a platform membership Id and Type are used.

• tokens.getBungieRewardsForUser

  Returns the bungie rewards for the targeted user.

• tokens.getBungieRewardsList

  Returns a list of the current bungie rewards

• tokens.getPartnerOfferSkuHistory

  Returns the partner sku and offer history of the targeted user. Elevated permissions are required to see users that are not yourself.

• tokens.getPartnerRewardHistory

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

• trending.getTrendingCategories

  Returns trending items for Bungie.net, collapsed into the first page of items per category. For pagination within a category, call GetTrendingCategory.

• trending.getTrendingCategory

  Returns paginated lists of trending items for a category.

• trending.getTrendingEntryDetail

  Returns the detailed results for a specific trending entry. Note that trending entries are uniquely identified by a combination of both the TrendingEntryType and the identifier: the identifier alone is not guaranteed to be globally unique.

• user.getAvailableThemes

  Returns a list of all available user themes.

• user.getBungieNetUserById

  Loads a bungienet user by membership id.

• user.getCredentialTypesForTargetAccount

  Returns a list of credential types attached to the requested account

• user.getMembershipDataById

  Returns a list of accounts associated with the supplied membership ID and membership type. This will include all linked accounts (even when hidden) if supplied credentials permit it.

• 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.

• user.getMembershipFromHardLinkedCredential

  Gets any hard linked membership given a credential. Only works for credentials that are public (just SteamID64 right now). Cross Save aware.

• user.getSanitizedPlatformDisplayNames

  Gets a list of all display names linked to this membership id but sanitized (profanity filtered). Obeys all visibility rules of calling user and is heavily cached.

• user.searchByGlobalNamePost

  Given the prefix of a global display name, returns all users who share that name.

• user.searchByGlobalNamePrefix

  [OBSOLETE] Do not use this to search users, use SearchByGlobalNamePost instead.

• userSystemOverrides.getUserSystemOverrides

  Get the user-specific system overrides that should be respected alongside common systems.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools