API Data Explorer
Back to Definitions

API Endpoints

Destiny2

Destiny2.GetDestinyManifest

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

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

Returns Destiny Profile information for the supplied membership.

Destiny2.GetCharacter

Returns character information for the supplied character.

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

Returns the dictionary of values for the Clan Banner

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

Get the details of a specific Vendor.

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

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

Destiny2.GetHistoricalStatsDefinition

Gets historical stats definitions.

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

Gets a page list of Destiny items.

Destiny2.GetHistoricalStats

Gets historical stats for indicated character.

Destiny2.GetHistoricalStatsForAccount

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

Destiny2.GetActivityHistory

Gets activity history stats for indicated character.

Destiny2.GetUniqueWeaponHistory

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

Destiny2.GetDestinyAggregateActivityStats

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

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

Returns the action token if user approves the request.

GroupV2

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

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

GroupV2.GetMembersOfGroup

Get the list of members in a given group.

GroupV2.GetAdminsAndFounderOfGroup

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

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

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

GroupV2.GetGroupsForMember

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

GroupV2.RecoverGroupForFounder

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

GroupV2.GetPotentialGroupsForMember

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