Bungie

Bungie.Net API

These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games…

Media & content#openapi#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.

Endpoints 134

App

  • GETApp.GetApplicationApiUsage/App/ApiUsage/:applicationId/?end=2024-01-01T00:00:00Z&start=2024-01-01T00:00:00ZGet 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…
  • GETApp.GetBungieApplications/App/FirstParty/Get list of applications created by Bungie.

User

  • GETUser.GetAvailableThemes/User/GetAvailableThemes/Returns a list of all available user themes.
  • GETUser.GetBungieNetUserById/User/GetBungieNetUserById/:id/Loads a bungienet user by membership id.
  • GETUser.GetCredentialTypesForTargetAccount/User/GetCredentialTypesForTargetAccount/:membershipId/Returns a list of credential types attached to the requested account
  • GETUser.GetMembershipFromHardLinkedCredential/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.
  • GETUser.GetMembershipDataById/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…
  • GETUser.GetMembershipDataForCurrentUser/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.
  • GETUser.GetSanitizedPlatformDisplayNames/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…
  • POSTUser.SearchByGlobalNamePost/User/Search/GlobalName/:page/Given the prefix of a global display name, returns all users who share that name.
  • GETUser.SearchByGlobalNamePrefix/User/Search/Prefix/:displayNamePrefix/:page/[OBSOLETE] Do not use this to search users, use SearchByGlobalNamePost instead.

Content

  • GETContent.GetContentById/Content/GetContentById/:id/:locale/?head=trueReturns a content item referenced by id
  • GETContent.GetContentByTagAndType/Content/GetContentByTagAndType/:tag/:type/:locale/?head=trueReturns the newest item that matches a given tag and Content Type.
  • GETContent.GetContentType/Content/GetContentType/:type/Gets an object describing a particular variant of content.
  • GETContent.RssNewsArticles/Content/Rss/NewsArticles/:pageToken/?categoryfilter=string&includebody=trueReturns a JSON string response that is the RSS feed for news articles.
  • GETContent.SearchContentWithText/Content/Search/:locale/?ctype=string&currentpage=0&head=true&searchtext=string&source=string&tag=stringGets content based on querystring information passed in. Provides basic search and text search capabilities.
  • GETContent.SearchContentByTagAndType/Content/SearchContentByTagAndType/:tag/:type/:locale/?currentpage=0&head=true&itemsperpage=0Searches for Content Items that match the given Tag and Content Type.
  • GETContent.SearchHelpArticles/Content/SearchHelpArticles/:searchtext/:size/Search for Help Articles.

Forum

  • GETForum.GetCoreTopicsPaged/Forum/GetCoreTopicsPaged/:page/:sort/:quickDate/:categoryFilter/?locales=stringGets a listing of all topics marked as part of the core group.
  • GETForum.GetForumTagSuggestions/Forum/GetForumTagSuggestions/?partialtag=stringGets tag suggestions based on partial text entry, matching them with other tags previously used in the forums.
  • GETForum.GetPostAndParent/Forum/GetPostAndParent/:childPostId/?showbanned=stringReturns the post specified and its immediate parent.
  • GETForum.GetPostAndParentAwaitingApproval/Forum/GetPostAndParentAwaitingApproval/:childPostId/?showbanned=stringReturns the post specified and its immediate parent of posts that are awaiting approval.
  • GETForum.GetPostsThreadedPaged/Forum/GetPostsThreadedPaged/:parentPostId/:page/:pageSize/:replySize/:getParentPost/:rootThreadMode/:sortMode/?showbanned=stringReturns a thread of posts at the given parent, optionally returning replies to those posts as well as the original parent.
  • GETForum.GetPostsThreadedPagedFromChild/Forum/GetPostsThreadedPagedFromChild/:childPostId/:page/:pageSize/:replySize/:rootThreadMode/:sortMode/?showbanned=stringReturns a thread of posts starting at the topicId of the input childPostId, optionally returning replies to those posts as well as the original parent.
  • GETForum.GetTopicForContent/Forum/GetTopicForContent/:contentId/Gets the post Id for the given content item's comments, if it exists.
  • GETForum.GetTopicsPaged/Forum/GetTopicsPaged/:page/:pageSize/:group/:sort/:quickDate/:categoryFilter/?locales=string&tagstring=stringGet topics from any forum.
  • GETForum.GetPoll/Forum/Poll/:topicId/Gets the specified forum poll.
  • POSTForum.GetRecruitmentThreadSummaries/Forum/Recruit/Summaries/Allows the caller to get a list of to 25 recruitment thread summary information objects.

GroupV2

  • GETGroupV2.GetAvailableAvatars/GroupV2/GetAvailableAvatars/Returns a list of all available group avatars for the signed-in user.
  • GETGroupV2.GetAvailableThemes/GroupV2/GetAvailableThemes/Returns a list of all available group themes.
  • GETGroupV2.GetUserClanInviteSetting/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.
  • GETGroupV2.GetGroupByName/GroupV2/Name/:groupName/:groupType/Get information about a specific group with the given name and type.
  • POSTGroupV2.GetGroupByNameV2/GroupV2/NameV2/Get information about a specific group with the given name and type. The POST version.
  • POSTGroupV2.GetRecommendedGroups/GroupV2/Recommended/:groupType/:createDateRange/Gets groups recommended for you based on the groups to whom those you follow belong.
  • GETGroupV2.RecoverGroupForFounder/GroupV2/Recover/:membershipType/:membershipId/:groupType/Allows a founder to manually recover a group they can see in game but not on bungie.net
  • POSTGroupV2.GroupSearch/GroupV2/Search/Search for Groups.
  • GETGroupV2.GetPotentialGroupsForMember/GroupV2/User/Potential/:membershipType/:membershipId/:filter/:groupType/Get information about the groups that a given member has applied to or been invited to.
  • GETGroupV2.GetGroupsForMember/GroupV2/User/:membershipType/:membershipId/:filter/:groupType/Get information about the groups that a given member has joined.
  • GETGroupV2.GetGroup/GroupV2/:groupId/Get information about a specific group of the given ID.
  • POSTGroupV2.AbdicateFoundership/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.
  • GETGroupV2.GetAdminsAndFounderOfGroup/GroupV2/:groupId/AdminsAndFounder/?currentpage=0Get the list of members in a given group who are of admin level or higher.
  • GETGroupV2.GetBannedMembersOfGroup/GroupV2/:groupId/Banned/?currentpage=0Get the list of banned members in a given group. Only accessible to group Admins and above. Not applicable to all groups. Check group features.
  • POSTGroupV2.EditGroup/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…
  • POSTGroupV2.EditClanBanner/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.
  • POSTGroupV2.EditFounderOptions/GroupV2/:groupId/EditFounderOptions/Edit group options only available to a founder. You must have suitable permissions in the group to perform this operation.
  • GETGroupV2.GetMembersOfGroup/GroupV2/:groupId/Members/?currentpage=0&memberType=0&nameSearch=stringGet the list of members in a given group.
  • POSTGroupV2.ApprovePending/GroupV2/:groupId/Members/Approve/:membershipType/:membershipId/Approve the given membershipId to join the group/clan as long as they have applied.
  • POSTGroupV2.ApproveAllPending/GroupV2/:groupId/Members/ApproveAll/Approve all of the pending users for the given group.
  • POSTGroupV2.ApprovePendingForList/GroupV2/:groupId/Members/ApproveList/Approve all of the pending users for the given group.
  • POSTGroupV2.DenyAllPending/GroupV2/:groupId/Members/DenyAll/Deny all of the pending users for the given group.
  • POSTGroupV2.DenyPendingForList/GroupV2/:groupId/Members/DenyList/Deny all of the pending users for the given group that match the passed-in .
  • POSTGroupV2.IndividualGroupInvite/GroupV2/:groupId/Members/IndividualInvite/:membershipType/:membershipId/Invite a user to join this group.
  • POSTGroupV2.IndividualGroupInviteCancel/GroupV2/:groupId/Members/IndividualInviteCancel/:membershipType/:membershipId/Cancels a pending invitation to join a group.
  • GETGroupV2.GetInvitedIndividuals/GroupV2/:groupId/Members/InvitedIndividuals/?currentpage=0Get the list of users who have been invited into the group.
  • GETGroupV2.GetPendingMemberships/GroupV2/:groupId/Members/Pending/?currentpage=0Get the list of users who are awaiting a decision on their application to join a given group. Modified to include application info.
  • POSTGroupV2.BanMember/GroupV2/:groupId/Members/:membershipType/:membershipId/Ban/Bans the requested member from the requested group for the specified period of time.
  • POSTGroupV2.KickMember/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…
  • POSTGroupV2.EditGroupMembership/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.
  • POSTGroupV2.UnbanMember/GroupV2/:groupId/Members/:membershipType/:membershipId/Unban/Unbans the requested member, allowing them to re-apply for membership.
  • GETGroupV2.GetGroupOptionalConversations/GroupV2/:groupId/OptionalConversations/Gets a list of available optional conversation channels and their settings.
  • POSTGroupV2.AddOptionalConversation/GroupV2/:groupId/OptionalConversations/Add/Add a new optional conversation/chat channel. Requires admin permissions to the group.
  • POSTGroupV2.EditOptionalConversation/GroupV2/:groupId/OptionalConversations/Edit/:conversationId/Edit the settings of an optional conversation/chat channel. Requires admin permissions to the group.

Tokens

  • POSTTokens.ApplyMissingPartnerOffersWithoutClaim/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.
  • POSTTokens.ClaimPartnerOffer/Tokens/Partner/ClaimOffer/Claim a partner offer as the authenticated user.
  • POSTTokens.ForceDropsRepair/Tokens/Partner/ForceDropsRepair/Twitch Drops self-repair function - scans twitch for drops not marked as fulfilled and resyncs them.
  • GETTokens.GetPartnerOfferSkuHistory/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.
  • GETTokens.GetPartnerRewardHistory/Tokens/Partner/History/:targetBnetMembershipId/Application/:partnerApplicationId/Returns the partner rewards history of the targeted user, both partner offers and Twitch drops.
  • GETTokens.GetBungieRewardsList/Tokens/Rewards/BungieRewards/Returns a list of the current bungie rewards
  • GETTokens.GetBungieRewardsForPlatformUser/Tokens/Rewards/GetRewardsForPlatformUser/:membershipId/:membershipType/Returns the bungie rewards for the targeted user when a platform membership Id and Type are used.
  • GETTokens.GetBungieRewardsForUser/Tokens/Rewards/GetRewardsForUser/:membershipId/Returns the bungie rewards for the targeted user.

Destiny2

  • POSTDestiny2.EquipItem/Destiny2/Actions/Items/EquipItem/Equip an item. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline.
  • POSTDestiny2.EquipItems/Destiny2/Actions/Items/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…
  • POSTDestiny2.InsertSocketPlug/Destiny2/Actions/Items/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…
  • POSTDestiny2.InsertSocketPlugFree/Destiny2/Actions/Items/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…
  • POSTDestiny2.PullFromPostmaster/Destiny2/Actions/Items/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…
  • POSTDestiny2.SetItemLockState/Destiny2/Actions/Items/SetLockState/Set the Lock State for an instanced item. You must have a valid Destiny Account.
  • POSTDestiny2.SetQuestTrackedState/Destiny2/Actions/Items/SetTrackedState/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.
  • POSTDestiny2.TransferItem/Destiny2/Actions/Items/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.…
  • POSTDestiny2.ClearLoadout/Destiny2/Actions/Loadouts/ClearLoadout/Clear the identifiers and items of a loadout.
  • POSTDestiny2.EquipLoadout/Destiny2/Actions/Loadouts/EquipLoadout/Equip a loadout. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline.
  • POSTDestiny2.SnapshotLoadout/Destiny2/Actions/Loadouts/SnapshotLoadout/Snapshot a loadout with the currently equipped items.
  • POSTDestiny2.UpdateLoadoutIdentifiers/Destiny2/Actions/Loadouts/UpdateLoadoutIdentifiers/Update the color, icon, and name of a loadout.
  • GETDestiny2.SearchDestinyEntities/Destiny2/Armory/Search/:type/:searchTerm/?page=0Gets a page list of Destiny items.
  • POSTDestiny2.AwaProvideAuthorizationResult/Destiny2/Awa/AwaProvideAuthorizationResult/Provide the result of the user interaction. Called by the Bungie Destiny App to approve or reject a request.
  • GETDestiny2.AwaGetActionToken/Destiny2/Awa/GetActionToken/:correlationId/Returns the action token if user approves the request.
  • POSTDestiny2.AwaInitializeRequest/Destiny2/Awa/Initialize/Initialize a request to perform an advanced write action.
  • GETDestiny2.GetClanBannerSource/Destiny2/Clan/ClanBannerDictionary/Returns the dictionary of values for the Clan Banner
  • GETDestiny2.GetClanWeeklyRewardState/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.
  • GETDestiny2.GetDestinyManifest/Destiny2/Manifest/Returns the current version of the manifest as a json object.
  • GETDestiny2.GetDestinyEntityDefinition/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…
  • GETDestiny2.GetPublicMilestones/Destiny2/Milestones/Gets public information about currently available Milestones.
  • GETDestiny2.GetPublicMilestoneContent/Destiny2/Milestones/:milestoneHash/Content/Gets custom localized content for the milestone of the given hash, if it exists.
  • POSTDestiny2.SearchDestinyPlayerByBungieName/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.
  • GETDestiny2.GetClanAggregateStats/Destiny2/Stats/AggregateClanStats/:groupId/?modes=stringGets 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.…
  • GETDestiny2.GetHistoricalStatsDefinition/Destiny2/Stats/Definition/Gets historical stats definitions.
  • GETDestiny2.GetClanLeaderboards/Destiny2/Stats/Leaderboards/Clans/:groupId/?maxtop=0&modes=string&statid=stringGets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint is still in beta, and may…
  • GETDestiny2.GetLeaderboardsForCharacter/Destiny2/Stats/Leaderboards/:membershipType/:destinyMembershipId/:characterId/?maxtop=0&modes=string&statid=stringGets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint is still in beta, and may…
  • GETDestiny2.GetPostGameCarnageReport/Destiny2/Stats/PostGameCarnageReport/:activityId/Gets the available post game carnage report for the activity ID.
  • POSTDestiny2.ReportOffensivePostGameCarnageReportPlayer/Destiny2/Stats/PostGameCarnageReport/:activityId/Report/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…
  • GETDestiny2.GetPublicVendors/Destiny2/Vendors/?components=0Get 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…
  • GETDestiny2.GetHistoricalStats/Destiny2/:membershipType/Account/:destinyMembershipId/Character/:characterId/Stats/?dayend=2024-01-01T00:00:00Z&daystart=2024-01-01T00:00:00Z&groups=0&modes=0&periodType=0Gets historical stats for indicated character.
  • GETDestiny2.GetActivityHistory/Destiny2/:membershipType/Account/:destinyMembershipId/Character/:characterId/Stats/Activities/?count=0&mode=0&page=0Gets activity history stats for indicated character.
  • GETDestiny2.GetDestinyAggregateActivityStats/Destiny2/:membershipType/Account/:destinyMembershipId/Character/:characterId/Stats/AggregateActivityStats/Gets all activities the character has participated in together with aggregate statistics for those activities.
  • GETDestiny2.GetUniqueWeaponHistory/Destiny2/:membershipType/Account/:destinyMembershipId/Character/:characterId/Stats/UniqueWeapons/Gets details about unique weapon usage, including all exotic weapons.
  • GETDestiny2.GetHistoricalStatsForAccount/Destiny2/:membershipType/Account/:destinyMembershipId/Stats/?groups=0Gets aggregate historical stats organized around each character for a given account.
  • GETDestiny2.GetLeaderboards/Destiny2/:membershipType/Account/:destinyMembershipId/Stats/Leaderboards/?maxtop=0&modes=string&statid=stringGets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint has not yet been implemented. It…
  • GETDestiny2.GetProfile/Destiny2/:membershipType/Profile/:destinyMembershipId/?components=0Returns Destiny Profile information for the supplied membership.
  • GETDestiny2.GetCharacter/Destiny2/:membershipType/Profile/:destinyMembershipId/Character/:characterId/?components=0Returns character information for the supplied character.
  • GETDestiny2.GetCollectibleNodeDetails/Destiny2/:membershipType/Profile/:destinyMembershipId/Character/:characterId/Collectibles/:collectiblePresentationNodeHash/?components=0Given a Presentation Node that has Collectibles as direct descendants, this will return item details about those descendants in the context of the requesting…
  • GETDestiny2.GetVendors/Destiny2/:membershipType/Profile/:destinyMembershipId/Character/:characterId/Vendors/?components=0&filter=0Get currently available vendors from the list of vendors that can possibly have rotating inventory. Note that this does not include things like preview…
  • GETDestiny2.GetVendor/Destiny2/:membershipType/Profile/:destinyMembershipId/Character/:characterId/Vendors/:vendorHash/?components=0Get the details of a specific Vendor.
  • GETDestiny2.GetItem/Destiny2/:membershipType/Profile/:destinyMembershipId/Item/:itemInstanceId/?components=0Retrieve the details of an instanced Destiny Item. An instanced Destiny item is one with an ItemInstanceId. Non-instanced items, such as materials, have no…
  • GETDestiny2.GetLinkedProfiles/Destiny2/:membershipType/Profile/:membershipId/LinkedProfiles/?getAllMemberships=trueReturns a summary information about all profiles linked to the requesting membership type/membership ID that have valid Destiny information. The passed-in…

CommunityContent

  • GETCommunityContent.GetCommunityContent/CommunityContent/Get/:sort/:mediaFilter/:page/Returns community content.

Trending

  • GETTrending.GetTrendingCategories/Trending/Categories/Returns trending items for Bungie.net, collapsed into the first page of items per category. For pagination within a category, call GetTrendingCategory.
  • GETTrending.GetTrendingCategory/Trending/Categories/:categoryId/:pageNumber/Returns paginated lists of trending items for a category.
  • GETTrending.GetTrendingEntryDetail/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…

Fireteam

  • GETFireteam.GetActivePrivateClanFireteamCount/Fireteam/Clan/:groupId/ActiveCount/Gets a count of all active non-public fireteams for the specified clan. Maximum value returned is 25.
  • GETFireteam.GetAvailableClanFireteams/Fireteam/Clan/:groupId/Available/:platform/:activityType/:dateRange/:slotFilter/:publicOnly/:page/?excludeImmediate=true&langFilter=stringGets 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.
  • GETFireteam.GetMyClanFireteams/Fireteam/Clan/:groupId/My/:platform/:includeClosed/:page/?groupFilter=true&langFilter=stringGets a listing of all fireteams that caller is an applicant, a member, or an alternate of.
  • GETFireteam.GetClanFireteam/Fireteam/Clan/:groupId/Summary/:fireteamId/Gets a specific fireteam.
  • GETFireteam.SearchPublicAvailableClanFireteams/Fireteam/Search/Available/:platform/:activityType/:dateRange/:slotFilter/:page/?excludeImmediate=true&langFilter=stringGets a listing of all public fireteams starting now with open slots. Caller is not checked for join criteria so caching is maximized.

Social

  • GETSocial.GetFriendList/Social/Friends/Returns your Bungie Friend list
  • POSTSocial.IssueFriendRequest/Social/Friends/Add/:membershipId/Requests a friend relationship with the target user. Any of the target user's linked membership ids are valid inputs.
  • POSTSocial.RemoveFriend/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.
  • GETSocial.GetFriendRequestList/Social/Friends/Requests/Returns your friend request queue.
  • POSTSocial.AcceptFriendRequest/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.
  • POSTSocial.DeclineFriendRequest/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.
  • POSTSocial.RemoveFriendRequest/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.
  • GETSocial.GetPlatformFriendList/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.
  • GET.GetAvailableLocales/GetAvailableLocales/List of available localization cultures
  • GET.GetGlobalAlerts/GlobalAlerts/?includestreaming=trueGets any active global alert for display in the forum banners, help pages, etc. Usually used for DOC alerts.
  • GET.GetCommonSettings/Settings/Get the common settings used by the Bungie.Net environment.
  • GET.GetUserSystemOverrides/UserSystemOverrides/Get the user-specific system overrides that should be respected alongside common systems.

API details

Base URL
https://www.bungie.net/Platform
Authentication
An API key in the X-API-Key header
OAuth 2.0 (authorization code flow) with 15 scopes
Operations
134 operations on 134 pathsGET 88POST 46
Main resources
Destiny2 43GroupV2 34Forum 10User 9Social 8Tokens 8Content 7Preview 7Fireteam 5Trending 3
Response formats
*/*
Description format
OpenAPI 3.0.0, API version 2.18.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Bungie.Net API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Bungie.Net API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “App.GetApplicationApiUsage” (GET /App/ApiUsage/:applicationId/?end=2024-01-01T00:00:00Z&start=2024-01-01T00:00:00Z), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Bungie.Net API?

These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games… It is listed under Media & content and has 134 endpoints.

Who publishes the Bungie.Net API?

It is listed from Bungie's public API description (an OpenAPI document), not published by Bungie on Swastik Codes. Anyone who controls bungie.net can claim the profile by adding a DNS TXT record.

What is the base URL of the Bungie.Net API?

Requests go to https://www.bungie.net/Platform. Endpoint paths are added to this base URL.

How do I authenticate with the Bungie.Net API?

It accepts 2 methods: an API key in the X-API-Key header; OAuth 2.0 (authorization code flow) with 15 scopes.

How many endpoints does the Bungie.Net API have?

134 operations on 134 paths (88 GET, 46 POST). The largest groups are Destiny2, GroupV2, Forum, User.

Is forking the Bungie.Net API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.