bungienet-api

name	bungienet-api
description	Bungie.Net API skill. Use when working with Bungie.Net for App, User, Content. Covers 135 endpoints.
version	1.0.0
generator	lapsh

Bungie.Net API

API version: 2.21.9

Auth

ApiKey X-API-Key in header | OAuth2

Base URL

https://www.bungie.net/Platform

Setup

1. Set your API key in the appropriate header
2. GET /App/FirstParty/ -- verify access
3. POST /User/Search/GlobalName/{page}/ -- create first GlobalName

Endpoints

135 endpoints across 15 groups. See references/api-spec.lap for full details.

App

Method	Path	Description
GET	/App/ApiUsage/{applicationId}/	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.
GET	/App/FirstParty/	Get list of applications created by Bungie.

User

Method	Path	Description
GET	/User/GetBungieNetUserById/{id}/	Loads a bungienet user by membership id.
GET	/User/GetSanitizedPlatformDisplayNames/{membershipId}/	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.
GET	/User/GetCredentialTypesForTargetAccount/{membershipId}/	Returns a list of credential types attached to the requested account
GET	/User/GetAvailableThemes/	Returns a list of all available user themes.
GET	/User/GetMembershipsById/{membershipId}/{membershipType}/	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.
GET	/User/GetMembershipsForCurrentUser/	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.
GET	/User/GetMembershipFromHardLinkedCredential/{crType}/{credential}/	Gets any hard linked membership given a credential. Only works for credentials that are public (just SteamID64 right now). Cross Save aware.
GET	/User/Search/Prefix/{displayNamePrefix}/{page}/	[OBSOLETE] Do not use this to search users, use SearchByGlobalNamePost instead.
POST	/User/Search/GlobalName/{page}/	Given the prefix of a global display name, returns all users who share that name.

Content

Method	Path	Description
GET	/Content/GetContentType/{type}/	Gets an object describing a particular variant of content.
GET	/Content/GetContentById/{id}/{locale}/	Returns a content item referenced by id
GET	/Content/GetContentByTagAndType/{tag}/{type}/{locale}/	Returns the newest item that matches a given tag and Content Type.
GET	/Content/Search/{locale}/	Gets content based on querystring information passed in. Provides basic search and text search capabilities.
GET	/Content/SearchContentByTagAndType/{tag}/{type}/{locale}/	Searches for Content Items that match the given Tag and Content Type.
GET	/Content/SearchHelpArticles/{searchtext}/{size}/	Search for Help Articles.
GET	/Content/Rss/NewsArticles/{pageToken}/	Returns a JSON string response that is the RSS feed for news articles.

Forum

Method	Path	Description
GET	/Forum/GetTopicsPaged/{page}/{pageSize}/{group}/{sort}/{quickDate}/{categoryFilter}/	Get topics from any forum.
GET	/Forum/GetCoreTopicsPaged/{page}/{sort}/{quickDate}/{categoryFilter}/	Gets a listing of all topics marked as part of the core group.
GET	/Forum/GetPostsThreadedPaged/{parentPostId}/{page}/{pageSize}/{replySize}/{getParentPost}/{rootThreadMode}/{sortMode}/	Returns a thread of posts at the given parent, optionally returning replies to those posts as well as the original parent.
GET	/Forum/GetPostsThreadedPagedFromChild/{childPostId}/{page}/{pageSize}/{replySize}/{rootThreadMode}/{sortMode}/	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.
GET	/Forum/GetPostAndParent/{childPostId}/	Returns the post specified and its immediate parent.
GET	/Forum/GetPostAndParentAwaitingApproval/{childPostId}/	Returns the post specified and its immediate parent of posts that are awaiting approval.
GET	/Forum/GetTopicForContent/{contentId}/	Gets the post Id for the given content item's comments, if it exists.
GET	/Forum/GetForumTagSuggestions/	Gets tag suggestions based on partial text entry, matching them with other tags previously used in the forums.
GET	/Forum/Poll/{topicId}/	Gets the specified forum poll.
POST	/Forum/Recruit/Summaries/	Allows the caller to get a list of to 25 recruitment thread summary information objects.

GroupV2

Method	Path	Description
GET	/GroupV2/GetAvailableAvatars/	Returns a list of all available group avatars for the signed-in user.
GET	/GroupV2/GetAvailableThemes/	Returns a list of all available group themes.
GET	/GroupV2/GetUserClanInviteSetting/{mType}/	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.
POST	/GroupV2/Recommended/{groupType}/{createDateRange}/	Gets groups recommended for you based on the groups to whom those you follow belong.
POST	/GroupV2/Search/	Search for Groups.
GET	/GroupV2/{groupId}/	Get information about a specific group of the given ID.
GET	/GroupV2/Name/{groupName}/{groupType}/	Get information about a specific group with the given name and type.
POST	/GroupV2/NameV2/	Get information about a specific group with the given name and type. The POST version.
GET	/GroupV2/{groupId}/OptionalConversations/	Gets a list of available optional conversation channels and their settings.
POST	/GroupV2/{groupId}/Edit/	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.
POST	/GroupV2/{groupId}/EditClanBanner/	Edit an existing group's clan banner. You must have suitable permissions in the group to perform this operation. All fields are required.
POST	/GroupV2/{groupId}/EditFounderOptions/	Edit group options only available to a founder. You must have suitable permissions in the group to perform this operation.
POST	/GroupV2/{groupId}/OptionalConversations/Add/	Add a new optional conversation/chat channel. Requires admin permissions to the group.
POST	/GroupV2/{groupId}/OptionalConversations/Edit/{conversationId}/	Edit the settings of an optional conversation/chat channel. Requires admin permissions to the group.
GET	/GroupV2/{groupId}/Members/	Get the list of members in a given group.

Tokens

Method	Path	Description
POST	/Tokens/Partner/ForceDropsRepair/	Twitch Drops self-repair function - scans twitch for drops not marked as fulfilled and resyncs them.
POST	/Tokens/Partner/ClaimOffer/	Claim a partner offer as the authenticated user.
POST	/Tokens/Partner/ApplyMissingOffers/{partnerApplicationId}/{targetBnetMembershipId}/	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.
GET	/Tokens/Partner/History/{partnerApplicationId}/{targetBnetMembershipId}/	Returns the partner sku and offer history of the targeted user. Elevated permissions are required to see users that are not yourself.
GET	/Tokens/Partner/History/{targetBnetMembershipId}/Application/{partnerApplicationId}/	Returns the partner rewards history of the targeted user, both partner offers and Twitch drops.
GET	/Tokens/Rewards/GetRewardsForUser/{membershipId}/	Returns the bungie rewards for the targeted user.
GET	/Tokens/Rewards/GetRewardsForPlatformUser/{membershipId}/{membershipType}/	Returns the bungie rewards for the targeted user when a platform membership Id and Type are used.
GET	/Tokens/Rewards/BungieRewards/	Returns a list of the current bungie rewards

Destiny2

Method	Path	Description
GET	/Destiny2/Manifest/	Returns the current version of the manifest as a json object.
GET	/Destiny2/Manifest/{entityType}/{hashIdentifier}/	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.
POST	/Destiny2/SearchDestinyPlayerByBungieName/{membershipType}/	Returns a list of Destiny memberships given a global Bungie Display Name. This method will hide overridden memberships due to cross save.
GET	/Destiny2/{membershipType}/Profile/{membershipId}/LinkedProfiles/	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.
GET	/Destiny2/{membershipType}/Profile/{destinyMembershipId}/	Returns Destiny Profile information for the supplied membership.
GET	/Destiny2/{membershipType}/Profile/{destinyMembershipId}/Character/{characterId}/	Returns character information for the supplied character.
GET	/Destiny2/Clan/{groupId}/WeeklyRewardState/	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.
GET	/Destiny2/Clan/ClanBannerDictionary/	Returns the dictionary of values for the Clan Banner
GET	/Destiny2/{membershipType}/Profile/{destinyMembershipId}/Item/{itemInstanceId}/	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.
GET	/Destiny2/{membershipType}/Profile/{destinyMembershipId}/Character/{characterId}/Vendors/

CommunityContent

Method	Path	Description
GET	/CommunityContent/Get/{sort}/{mediaFilter}/{page}/	Returns community content.

Trending

Method	Path	Description
GET	/Trending/Categories/	Returns trending items for Bungie.net, collapsed into the first page of items per category. For pagination within a category, call GetTrendingCategory.
GET	/Trending/Categories/{categoryId}/{pageNumber}/	Returns paginated lists of trending items for a category.
GET	/Trending/Details/{trendingEntryType}/{identifier}/	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.

Fireteam

Method	Path	Description
GET	/Fireteam/Clan/{groupId}/ActiveCount/	Gets a count of all active non-public fireteams for the specified clan. Maximum value returned is 25.
GET	/Fireteam/Clan/{groupId}/Available/{platform}/{activityType}/{dateRange}/{slotFilter}/{publicOnly}/{page}/	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.
GET	/Fireteam/Search/Available/{platform}/{activityType}/{dateRange}/{slotFilter}/{page}/	Gets a listing of all public fireteams starting now with open slots. Caller is not checked for join criteria so caching is maximized.
GET	/Fireteam/Clan/{groupId}/My/{platform}/{includeClosed}/{page}/	Gets a listing of all fireteams that caller is an applicant, a member, or an alternate of.
GET	/Fireteam/Clan/{groupId}/Summary/{fireteamId}/	Gets a specific fireteam.

Social

Method	Path	Description
GET	/Social/Friends/	Returns your Bungie Friend list
GET	/Social/Friends/Requests/	Returns your friend request queue.
POST	/Social/Friends/Add/{membershipId}/	Requests a friend relationship with the target user. Any of the target user's linked membership ids are valid inputs.
POST	/Social/Friends/Requests/Accept/{membershipId}/	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.
POST	/Social/Friends/Requests/Decline/{membershipId}/	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.
POST	/Social/Friends/Remove/{membershipId}/	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.
POST	/Social/Friends/Requests/Remove/{membershipId}/	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.
GET	/Social/PlatformFriends/{friendPlatform}/{page}/	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.

GetAvailableLocales

Method	Path	Description
GET	/GetAvailableLocales/	List of available localization cultures

Settings

Method	Path	Description
GET	/Settings/	Get the common settings used by the Bungie.Net environment.

UserSystemOverrides

Method	Path	Description
GET	/UserSystemOverrides/	Get the user-specific system overrides that should be respected alongside common systems.

GlobalAlerts

Method	Path	Description
GET	/GlobalAlerts/	Gets any active global alert for display in the forum banners, help pages, etc. Usually used for DOC alerts.

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Get ApiUsage details?" -> GET /App/ApiUsage/{applicationId}/
• "List all FirstParty?" -> GET /App/FirstParty/
• "Get GetBungieNetUserById details?" -> GET /User/GetBungieNetUserById/{id}/
• "Get GetSanitizedPlatformDisplayName details?" -> GET /User/GetSanitizedPlatformDisplayNames/{membershipId}/
• "Get GetCredentialTypesForTargetAccount details?" -> GET /User/GetCredentialTypesForTargetAccount/{membershipId}/
• "List all GetAvailableThemes?" -> GET /User/GetAvailableThemes/
• "Get GetMembershipsById details?" -> GET /User/GetMembershipsById/{membershipId}/{membershipType}/
• "List all GetMembershipsForCurrentUser?" -> GET /User/GetMembershipsForCurrentUser/
• "Get GetMembershipFromHardLinkedCredential details?" -> GET /User/GetMembershipFromHardLinkedCredential/{crType}/{credential}/
• "Get Prefix details?" -> GET /User/Search/Prefix/{displayNamePrefix}/{page}/
• "Get GetContentType details?" -> GET /Content/GetContentType/{type}/
• "Get GetContentById details?" -> GET /Content/GetContentById/{id}/{locale}/
• "Get GetContentByTagAndType details?" -> GET /Content/GetContentByTagAndType/{tag}/{type}/{locale}/
• "Get Search details?" -> GET /Content/Search/{locale}/
• "Get SearchContentByTagAndType details?" -> GET /Content/SearchContentByTagAndType/{tag}/{type}/{locale}/
• "Get SearchHelpArticle details?" -> GET /Content/SearchHelpArticles/{searchtext}/{size}/
• "Get NewsArticle details?" -> GET /Content/Rss/NewsArticles/{pageToken}/
• "Get GetTopicsPaged details?" -> GET /Forum/GetTopicsPaged/{page}/{pageSize}/{group}/{sort}/{quickDate}/{categoryFilter}/
• "Get GetCoreTopicsPaged details?" -> GET /Forum/GetCoreTopicsPaged/{page}/{sort}/{quickDate}/{categoryFilter}/
• "Get GetPostsThreadedPaged details?" -> GET /Forum/GetPostsThreadedPaged/{parentPostId}/{page}/{pageSize}/{replySize}/{getParentPost}/{rootThreadMode}/{sortMode}/
• "Get GetPostsThreadedPagedFromChild details?" -> GET /Forum/GetPostsThreadedPagedFromChild/{childPostId}/{page}/{pageSize}/{replySize}/{rootThreadMode}/{sortMode}/
• "Get GetPostAndParent details?" -> GET /Forum/GetPostAndParent/{childPostId}/
• "Get GetPostAndParentAwaitingApproval details?" -> GET /Forum/GetPostAndParentAwaitingApproval/{childPostId}/
• "Get GetTopicForContent details?" -> GET /Forum/GetTopicForContent/{contentId}/
• "List all GetForumTagSuggestions?" -> GET /Forum/GetForumTagSuggestions/
• "Get Poll details?" -> GET /Forum/Poll/{topicId}/
• "Create a Summary?" -> POST /Forum/Recruit/Summaries/
• "List all GetAvailableAvatars?" -> GET /GroupV2/GetAvailableAvatars/
• "List all GetAvailableThemes?" -> GET /GroupV2/GetAvailableThemes/

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP