bungienet-api — quality + safety report

---
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. |
| GET | /GroupV2/{groupId}/AdminsAndFounder/ | Get the list of members in a given group who are of admin level or higher. |
| POST | /GroupV2/{groupId}/Members/{membershipType}/{membershipId}/SetMembershipType/{memberType}/ | Edit the membership type of a given member. You must have suitable permissions in the group to perform this operation. |
| POST | /GroupV2/{groupId}/Members/{membershipType}/{membershipId}/Kick/ | 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. |
| POST | /GroupV2/{groupId}/Members/{membershipType}/{membershipId}/Ban/ | Bans the requested member from the requested group for the specified period of time. |
| POST | /GroupV2/{groupId}/Members/{membershipType}/{membershipId}/Unban/ | Unbans the requested member, allowing them to re-apply for membership. |
| GET | /GroupV2/{groupId}/Banned/ | 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. |
| GET | /GroupV2/{groupId}/EditHistory/ | Get the list of edits made to a given group. Only accessible to group Admins and above. |
| POST | /GroupV2/{groupId}/Admin/AbdicateFoundership/{membershipType}/{founderIdNew}/ | An administrative method to allow the founder of a group or clan to give up their position to another admin permanently. |
| GET | /GroupV2/{groupId}/Members/Pending/ | Get the list of users who are awaiting a decision on their application to join a given group. Modified to include application info. |
| GET | /GroupV2/{groupId}/Members/InvitedIndividuals/ | Get the list of users who have been invited into the group. |
| POST | /GroupV2/{groupId}/Members/ApproveAll/ | Approve all of the pending users for the given group. |
| POST | /GroupV2/{groupId}/Members/DenyAll/ | Deny all of the pending users for the given group. |
| POST | /GroupV2/{groupId}/Members/ApproveList/ | Approve all of the pending users for the given group. |
| POST | /GroupV2/{groupId}/Members/Approve/{membershipType}/{membershipId}/ | Approve the given membershipId to join the group/clan as long as they have applied. |
| POST | /GroupV2/{groupId}/Members/DenyList/ | Deny all of the pending users for the given group that match the passed-in . |
| GET | /GroupV2/User/{membershipType}/{membershipId}/{filter}/{groupType}/ | Get information about the groups that a given member has joined. |
| GET | /GroupV2/Recover/{membershipType}/{membershipId}/{groupType}/ | Allows a founder to manually recover a group they can see in game but not on bungie.net |
| GET | /GroupV2/User/Potential/{membershipType}/{membershipId}/{filter}/{groupType}/ | Get information about the groups that a given member has applied to or been invited to. |
| POST | /GroupV2/{groupId}/Members/IndividualInvite/{membershipType}/{membershipId}/ | Invite a user to join this group. |
| POST | /GroupV2/{groupId}/Members/IndividualInviteCancel/{membershipType}/{membershipId}/ | Cancels a pending invitation to join a 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 Do

… (truncated)