← Back to catalog

Other

Bungie.Net

auto-generated
swirls add bungie …
actionGETv1.0.0

.GetCommonSettings

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

Source
actionGETv1.0.0

.GetGlobalAlerts

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

Source
actionGETv1.0.0

.GetUserSystemOverrides

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

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

Content.GetContentType

Gets an object describing a particular variant of content.

Source
actionGETv1.0.0

Content.RssNewsArticles

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

Source
actionGETv1.0.0

Content.SearchContentWithText

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

Source
actionPOSTv1.0.0

Destiny2.AwaProvideAuthorizationResult

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

Source
actionPOSTv1.0.0

Destiny2.EquipItem

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

Source
actionPOSTv1.0.0

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.

Source
actionPOSTv1.0.0

Destiny2.EquipLoadout

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

Source
actionGETv1.0.0

Destiny2.GetCharacter

Returns character information for the supplied character.

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

Destiny2.GetDestinyAggregateActivityStats

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

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

Destiny2.GetProfile

Returns Destiny Profile information for the supplied membership.

Source
actionGETv1.0.0

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

Source
actionGETv1.0.0

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.

Source
actionPOSTv1.0.0

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.

Source
actionPOSTv1.0.0

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.

Source
actionPOSTv1.0.0

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.

Source
actionPOSTv1.0.0

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.

Source
actionPOSTv1.0.0

Destiny2.SearchDestinyPlayerByBungieName

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

Source
actionPOSTv1.0.0

Destiny2.SetItemLockState

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

Source
actionPOSTv1.0.0

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.

Source
actionPOSTv1.0.0

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

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

Fireteam.GetMyClanFireteams

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

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

Forum.GetCoreTopicsPaged

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

Source
actionGETv1.0.0

Forum.GetForumTagSuggestions

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

Source
actionGETv1.0.0

Forum.GetPoll

Gets the specified forum poll.

Source
actionGETv1.0.0

Forum.GetPostsThreadedPaged

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

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

Forum.GetTopicForContent

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

Source
actionPOSTv1.0.0

GroupV2.AbdicateFoundership

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

Source
actionGETv1.0.0

GroupV2.GetAvailableAvatars

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

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

GroupV2.GetGroup

Get information about a specific group of the given ID.

Source
actionGETv1.0.0

GroupV2.GetGroupByName

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

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

GroupV2.RecoverGroupForFounder

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

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

Trending.GetTrendingCategories

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

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

User.GetMembershipFromHardLinkedCredential

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

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

User.SearchByGlobalNamePrefix

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

Source
Beyond the catalog

Any provider, on request.

01

Request it

Tell us which provider you need, and we will ship it in the registry.

02

Generate it

Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.

Request a providerRead the actions docs
acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
 
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec