@datafire/bungie

Client library for Bungie.Net

Installation and Usage

npm install --save @datafire/bungie

let bungie = require('@datafire/bungie').create({
  apiKey: "",
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

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.

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

bungie.oauthCallback({
  "code": ""
}, context)

Input

• input object
  • code required string

Output

• output object
  • access_token string
  • refresh_token string
  • token_type string
  • scope string
  • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

bungie.oauthRefresh(null, context)

Input

This action has no parameters

Output

• output object
  • access_token string
  • refresh_token string
  • token_type string
  • scope string
  • expiration string

CommunityContent.GetCommunityContent

Returns community content.

bungie.CommunityContent.GetCommunityContent({
  "mediaFilter": 0,
  "page": 0,
  "sort": 0
}, context)

Input

• input object
  • mediaFilter required integer (values: 0, 1, 2, 4, 8, 16, 32, 64, 128): The type of media to get
  • page required integer: Zero based page
  • sort required integer (values: 0, 1, 2): The sort mode.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Forum.PostSearchResponse
  • ThrottleSeconds integer

CommunityContent.GetCommunityLiveStatuses

Returns info about community members who are live streaming.

bungie.CommunityContent.GetCommunityLiveStatuses({
  "page": 0,
  "partnershipType": 0,
  "sort": 0
}, context)

Input

• input object
  • modeHash integer: The hash of the Activity Mode for which streams should be retrieved. Don't pass it in or pass 0 to not filter by mode.
  • page required integer: Zero based page.
  • partnershipType required integer (values: 0, 1): The type of partnership for which the status should be returned.
  • sort required integer (values: 0, 1, 2, 3): The sort mode.
  • streamLocale string: The locale for streams you'd like to see. Don't pass this to fall back on your BNet locale. Pass 'ALL' to not filter by locale.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response SearchResultOfCommunityLiveStatus
  • ThrottleSeconds integer

CommunityContent.GetCommunityLiveStatusesForClanmates

Returns info about community members who are live streaming in your clans.

bungie.CommunityContent.GetCommunityLiveStatusesForClanmates({
  "page": 0,
  "partnershipType": 0,
  "sort": 0
}, context)

Input

• input object
  • page required integer: Zero based page.
  • partnershipType required integer (values: 0, 1): The type of partnership for which the status should be returned.
  • sort required integer (values: 0, 1, 2, 3): The sort mode.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response SearchResultOfCommunityLiveStatus
  • ThrottleSeconds integer

CommunityContent.GetFeaturedCommunityLiveStatuses

Returns info about Featured live streams.

bungie.CommunityContent.GetFeaturedCommunityLiveStatuses({
  "page": 0,
  "partnershipType": 0,
  "sort": 0
}, context)

Input

• input object
  • page required integer: Zero based page.
  • partnershipType required integer (values: 0, 1): The type of partnership for which the status should be returned.
  • sort required integer (values: 0, 1, 2, 3): The sort mode.
  • streamLocale string: The locale for streams you'd like to see. Don't pass this to fall back on your BNet locale. Pass 'ALL' to not filter by locale.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response SearchResultOfCommunityLiveStatus
  • ThrottleSeconds integer

CommunityContent.GetCommunityLiveStatusesForFriends

Returns info about community members who are live streaming among your friends.

bungie.CommunityContent.GetCommunityLiveStatusesForFriends({
  "page": 0,
  "partnershipType": 0,
  "sort": 0
}, context)

Input

• input object
  • page required integer: Zero based page.
  • partnershipType required integer (values: 0, 1): The type of partnership for which the status should be returned.
  • sort required integer (values: 0, 1, 2, 3): The sort mode.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response SearchResultOfCommunityLiveStatus
  • ThrottleSeconds integer

CommunityContent.GetStreamingStatusForMember

Gets the Live Streaming status of a particular Account and Membership Type.

bungie.CommunityContent.GetStreamingStatusForMember({
  "membershipId": 0,
  "membershipType": 0,
  "partnershipType": 0
}, context)

Input

• input object
  • membershipId required integer: The membershipId related to that type.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): The type of account for which info will be extracted.
  • partnershipType required integer (values: 0, 1): The type of partnership for which info will be extracted.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Community.CommunityLiveStatus
  • ThrottleSeconds integer

Destiny2.ActivateTalentNode

Activate a Talent Node. Chill out, everyone: we haven't decided yet whether this will be able to activate nodes with costs, 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. PREVIEW: This service is not actually implemented yet, but we are returning the planned schema of the endpoint for review, comment, and preparation for its eventual implementation.

bungie.Destiny2.ActivateTalentNode(null, context)

Input

This action has no parameters

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response integer
  • ThrottleSeconds integer

Destiny2.EquipItem

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

bungie.Destiny2.EquipItem(null, context)

Input

This action has no parameters

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response integer
  • ThrottleSeconds integer

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.

bungie.Destiny2.EquipItems(null, context)

Input

This action has no parameters

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Destiny.DestinyEquipItemResults
  • ThrottleSeconds integer

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. PREVIEW: This service is not yet active, but we are returning the planned schema of the endpoint for review, comment, and preparation for its eventual implementation.

bungie.Destiny2.InsertSocketPlug(null, context)

Input

This action has no parameters

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response integer
  • ThrottleSeconds integer

Destiny2.SetItemLockState

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

bungie.Destiny2.SetItemLockState(null, context)

Input

This action has no parameters

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response integer
  • ThrottleSeconds integer

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

bungie.Destiny2.TransferItem(null, context)

Input

This action has no parameters

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response integer
  • ThrottleSeconds integer

Destiny2.SearchDestinyEntities

Gets a page list of Destiny items.

bungie.Destiny2.SearchDestinyEntities({
  "searchTerm": "",
  "type": ""
}, context)

Input

• input object
  • page integer: Page number to return, starting with 0.
  • searchTerm required string: The string to use when searching for Destiny entities.
  • type required string: The type of entity for whom you would like results. These correspond to the entity's definition contract name. For instance, if you are looking for items, this property should be 'DestinyInventoryItemDefinition'. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is tentatively in final form, but there may be bugs that prevent desirable operation.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Destiny.Definitions.DestinyEntitySearchResult
  • ThrottleSeconds integer

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.

bungie.Destiny2.GetClanWeeklyRewardState({
  "groupId": 0
}, context)

Input

• input object
  • groupId required integer: A valid group id of clan.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Destiny.Milestones.DestinyMilestone
  • ThrottleSeconds integer

Destiny2.GetDestinyManifest

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

bungie.Destiny2.GetDestinyManifest(null, context)

Input

This action has no parameters

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Destiny.Config.DestinyManifest
  • ThrottleSeconds integer

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.

bungie.Destiny2.GetDestinyEntityDefinition({
  "entityType": "",
  "hashIdentifier": 0
}, context)

Input

• input object
  • entityType required string: The type of entity for whom you would like results. These correspond to the entity's definition contract name. For instance, if you are looking for items, this property should be 'DestinyInventoryItemDefinition'. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is tentatively in final form, but there may be bugs that prevent desirable operation.
  • hashIdentifier required integer: The hash identifier for the specific Entity you want returned.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Destiny.Definitions.DestinyDefinition
  • ThrottleSeconds integer

Destiny2.GetPublicMilestones

Gets public information about currently available Milestones.

bungie.Destiny2.GetPublicMilestones(null, context)

Input

This action has no parameters

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response object
  • ThrottleSeconds integer

Destiny2.GetPublicMilestoneContent

Gets custom localized content for the milestone of the given hash, if it exists.

bungie.Destiny2.GetPublicMilestoneContent({
  "milestoneHash": 0
}, context)

Input

• input object
  • milestoneHash required integer: The identifier for the milestone to be returned.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Destiny.Milestones.DestinyMilestoneContent
  • ThrottleSeconds integer

Destiny2.SearchDestinyPlayer

Returns a list of Destiny memberships given a full Gamertag or PSN ID.

bungie.Destiny2.SearchDestinyPlayer({
  "displayName": "",
  "membershipType": 0
}, context)

Input

• input object
  • displayName required string: The full gamertag or PSN id of the player. Spaces and case are ignored.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): A valid non-BungieNet membership type, or All.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response array
    • items User.UserInfoCard
  • ThrottleSeconds integer

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.

bungie.Destiny2.GetClanAggregateStats({
  "groupId": 0
}, context)

Input

• input object
  • groupId required integer: Group ID of the clan whose leaderboards you wish to fetch.
  • modes string: List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response array
    • items Destiny.HistoricalStats.DestinyClanAggregateStat
  • ThrottleSeconds integer

Destiny2.GetHistoricalStatsDefinition

Gets historical stats definitions.

bungie.Destiny2.GetHistoricalStatsDefinition(null, context)

Input

This action has no parameters

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response object
  • ThrottleSeconds integer

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.

bungie.Destiny2.GetClanLeaderboards({
  "groupId": 0
}, context)

Input

• input object
  • groupId required integer: Group ID of the clan whose leaderboards you wish to fetch.
  • maxtop integer: Maximum number of top players to return. Use a large number to get entire leaderboard.
  • modes string: List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.
  • statid string: ID of stat to return rather than returning all Leaderboard stats.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response object
  • ThrottleSeconds integer

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.

bungie.Destiny2.GetLeaderboardsForCharacter({
  "characterId": 0,
  "destinyMembershipId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • characterId required integer: The specific character to build the leaderboard around for the provided Destiny Membership.
  • destinyMembershipId required integer: The Destiny membershipId of the user to retrieve.
  • maxtop integer: Maximum number of top players to return. Use a large number to get entire leaderboard.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): A valid non-BungieNet membership type.
  • modes string: List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.
  • statid string: ID of stat to return rather than returning all Leaderboard stats.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response object
  • ThrottleSeconds integer

Destiny2.GetPostGameCarnageReport

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

bungie.Destiny2.GetPostGameCarnageReport({
  "activityId": 0
}, context)

Input

• input object
  • activityId required integer: The ID of the activity whose PGCR is requested.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Destiny.HistoricalStats.DestinyPostGameCarnageReportData
  • ThrottleSeconds integer

Destiny2.GetHistoricalStats

Gets historical stats for indicated character. 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.

bungie.Destiny2.GetHistoricalStats({
  "characterId": 0,
  "destinyMembershipId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • characterId required integer: The id of the character to retrieve. You can omit this character ID or set it to 0 to get aggregate stats across all characters.
  • dayend string: Last day to return when daily stats are requested. Use the format YYYY-MM-DD.
  • daystart string: First day to return when daily stats are requested. Use the format YYYY-MM-DD
  • destinyMembershipId required integer: The Destiny membershipId of the user to retrieve.
  • groups array: Group of stats to include, otherwise only general stats are returned. Comma separated list is allowed. Values: General, Weapons, Medals
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): A valid non-BungieNet membership type.
  • modes array: Game modes to return. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.
  • periodType integer (values: 0, 1, 2, 3): Indicates a specific period type to return. Optional. May be: Daily, AllTime, or Activity

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response object
  • ThrottleSeconds integer

Destiny2.GetActivityHistory

Gets activity history stats for indicated character. 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.

bungie.Destiny2.GetActivityHistory({
  "characterId": 0,
  "destinyMembershipId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • characterId required integer: The id of the character to retrieve.
  • count integer: Number of rows to return
  • destinyMembershipId required integer: The Destiny membershipId of the user to retrieve.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): A valid non-BungieNet membership type.
  • mode integer (values: 0, 2, 3, 4, 5, 6, 7, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19, 20, 21, 22, 24, 25, 26, 27, 28, 29, 30, 31, 32, 37, 38, 39, 40): A filter for the activity mode to be returned. None returns all activities. See the documentation for DestinyActivityModeType for valid values, and pass in string representation.
  • page integer: Page number to return, starting with 0.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Destiny.HistoricalStats.DestinyActivityHistoryResults
  • ThrottleSeconds integer

Destiny2.GetDestinyAggregateActivityStats

Gets all activities the character has participated in together with aggregate statistics for those activities. 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.

bungie.Destiny2.GetDestinyAggregateActivityStats({
  "characterId": 0,
  "destinyMembershipId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • characterId required integer: The specific character whose activities should be returned.
  • destinyMembershipId required integer: The Destiny membershipId of the user to retrieve.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): A valid non-BungieNet membership type.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Destiny.HistoricalStats.DestinyAggregateActivityResults
  • ThrottleSeconds integer

Destiny2.GetUniqueWeaponHistory

Gets details about unique weapon usage, including all exotic weapons. 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.

bungie.Destiny2.GetUniqueWeaponHistory({
  "characterId": 0,
  "destinyMembershipId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • characterId required integer: The id of the character to retrieve.
  • destinyMembershipId required integer: The Destiny membershipId of the user to retrieve.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): A valid non-BungieNet membership type.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Destiny.HistoricalStats.DestinyHistoricalWeaponStatsData
  • ThrottleSeconds integer

Destiny2.GetHistoricalStatsForAccount

Gets aggregate historical stats organized around each character for a given account. 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.

bungie.Destiny2.GetHistoricalStatsForAccount({
  "destinyMembershipId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • destinyMembershipId required integer: The Destiny membershipId of the user to retrieve.
  • groups array: Groups of stats to include, otherwise only general stats are returned. Comma separated list is allowed. Values: General, Weapons, Medals.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): A valid non-BungieNet membership type.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Destiny.HistoricalStats.DestinyHistoricalStatsAccountResult
  • ThrottleSeconds integer

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.

bungie.Destiny2.GetLeaderboards({
  "destinyMembershipId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • destinyMembershipId required integer: The Destiny membershipId of the user to retrieve.
  • maxtop integer: Maximum number of top players to return. Use a large number to get entire leaderboard.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): A valid non-BungieNet membership type.
  • modes string: List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.
  • statid string: ID of stat to return rather than returning all Leaderboard stats.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response object
  • ThrottleSeconds integer

Destiny2.GetProfile

Returns Destiny Profile information for the supplied membership.

bungie.Destiny2.GetProfile({
  "destinyMembershipId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • components array: A comma separated list of components to return (as strings or numeric values). See the DestinyComponentType enum for valid components to request. You must request at least one component to receive results.
  • destinyMembershipId required integer: Destiny membership ID.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): A valid non-BungieNet membership type.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Destiny.Responses.DestinyProfileResponse
  • ThrottleSeconds integer

Destiny2.GetCharacter

Returns character information for the supplied character.

bungie.Destiny2.GetCharacter({
  "characterId": 0,
  "destinyMembershipId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • characterId required integer: ID of the character.
  • components array: A comma separated list of components to return (as strings or numeric values). See the DestinyComponentType enum for valid components to request. You must request at least one component to receive results.
  • destinyMembershipId required integer: Destiny membership ID.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): A valid non-BungieNet membership type.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Destiny.Responses.DestinyCharacterResponse
  • ThrottleSeconds integer

Destiny2.GetVendors

Get currently available vendors. PREVIEW: This service is not yet active, but we are returning the planned schema of the endpoint for review, comment, and preparation for its eventual implementation.

bungie.Destiny2.GetVendors({
  "characterId": 0,
  "destinyMembershipId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • characterId required integer: The Destiny Character ID of the character for whom we're getting vendor info.
  • components array: A comma separated list of components to return (as strings or numeric values). See the DestinyComponentType enum for valid components to request. You must request at least one component to receive results.
  • destinyMembershipId required integer: Destiny membership ID of another user. You may be denied.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): A valid non-BungieNet membership type.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response array
    • items Destiny.Responses.DestinyVendorResponse
  • ThrottleSeconds integer

Destiny2.GetVendor

Get the details of a specific Vendor. PREVIEW: This service is not yet active, but we are returning the planned schema of the endpoint for review, comment, and preparation for its eventual implementation.

bungie.Destiny2.GetVendor({
  "characterId": 0,
  "destinyMembershipId": 0,
  "membershipType": 0,
  "vendorHash": 0
}, context)

Input

• input object
  • characterId required integer: The Destiny Character ID of the character for whom we're getting vendor info.
  • components array: A comma separated list of components to return (as strings or numeric values). See the DestinyComponentType enum for valid components to request. You must request at least one component to receive results.
  • destinyMembershipId required integer: Destiny membership ID of another user. You may be denied.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): A valid non-BungieNet membership type.
  • vendorHash required integer: The Hash identifier of the Vendor to be returned.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Destiny.Responses.DestinyVendorResponse
  • ThrottleSeconds integer

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.

bungie.Destiny2.GetItem({
  "destinyMembershipId": 0,
  "itemInstanceId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • components array: A comma separated list of components to return (as strings or numeric values). See the DestinyComponentType enum for valid components to request. You must request at least one component to receive results.
  • destinyMembershipId required integer: The membership ID of the destiny profile.
  • itemInstanceId required integer: The Instance ID of the destiny item.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): A valid non-BungieNet membership type.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Destiny.Responses.DestinyItemResponse
  • ThrottleSeconds integer

Forum.GetCoreTopicsPaged

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

bungie.Forum.GetCoreTopicsPaged({
  "categoryFilter": 0,
  "page": 0,
  "quickDate": 0,
  "sort": 0
}, context)

Input

• input object
  • categoryFilter required integer (values: 0, 1, 2, 4, 8, 16, 32, 64, 128): The category filter.
  • locales string: Comma seperated list of locales posts must match to return in the result list. Default 'en'
  • page required integer: Zero base page
  • quickDate required integer (values: 0, 1, 2, 3, 4): The date filter.
  • sort required integer (values: 0, 1, 2, 3, 4, 5, 6, 7): The sort mode.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Forum.PostSearchResponse
  • ThrottleSeconds integer

Forum.GetForumTagSuggestions

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

bungie.Forum.GetForumTagSuggestions({}, context)

Input

• input object
  • partialtag string: The partial tag input to generate suggestions from.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response array
    • items Tags.Models.Contracts.TagResponse
  • ThrottleSeconds integer

Forum.GetPostAndParent

Returns the post specified and its immediate parent.

bungie.Forum.GetPostAndParent({
  "childPostId": 0
}, context)

Input

• input object
  • childPostId required integer
  • showbanned string: If this value is not null or empty, banned posts are requested to be returned

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Forum.PostSearchResponse
  • ThrottleSeconds integer

Forum.GetPostAndParentAwaitingApproval

Returns the post specified and its immediate parent of posts that are awaiting approval.

bungie.Forum.GetPostAndParentAwaitingApproval({
  "childPostId": 0
}, context)

Input

• input object
  • childPostId required integer
  • showbanned string: If this value is not null or empty, banned posts are requested to be returned

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Forum.PostSearchResponse
  • ThrottleSeconds integer

Forum.GetPostsThreadedPaged

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

bungie.Forum.GetPostsThreadedPaged({
  "getParentPost": true,
  "page": 0,
  "pageSize": 0,
  "parentPostId": 0,
  "replySize": 0,
  "rootThreadMode": true,
  "sortMode": 0
}, context)

Input

• input object
  • getParentPost required boolean
  • page required integer
  • pageSize required integer
  • parentPostId required integer
  • replySize required integer
  • rootThreadMode required boolean
  • showbanned string: If this value is not null or empty, banned posts are requested to be returned
  • sortMode required integer (values: 0, 1)

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Forum.PostSearchResponse
  • ThrottleSeconds integer

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.

bungie.Forum.GetPostsThreadedPagedFromChild({
  "childPostId": 0,
  "page": 0,
  "pageSize": 0,
  "replySize": 0,
  "rootThreadMode": true,
  "sortMode": 0
}, context)

Input

• input object
  • childPostId required integer
  • page required integer
  • pageSize required integer
  • replySize required integer
  • rootThreadMode required boolean
  • showbanned string: If this value is not null or empty, banned posts are requested to be returned
  • sortMode required integer (values: 0, 1)

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Forum.PostSearchResponse
  • ThrottleSeconds integer

Forum.GetTopicForContent

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

bungie.Forum.GetTopicForContent({
  "contentId": 0
}, context)

Input

• input object
  • contentId required integer

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response integer
  • ThrottleSeconds integer

Forum.GetTopicsPaged

Get topics from any forum.

bungie.Forum.GetTopicsPaged({
  "categoryFilter": 0,
  "group": 0,
  "page": 0,
  "pageSize": 0,
  "quickDate": 0,
  "sort": 0
}, context)

Input

• input object
  • categoryFilter required integer (values: 0, 1, 2, 4, 8, 16, 32, 64, 128): A category filter
  • group required integer: The group, if any.
  • locales string: Comma seperated list of locales posts must match to return in the result list. Default 'en'
  • page required integer: Zero paged page number
  • pageSize required integer: Unused
  • quickDate required integer (values: 0, 1, 2, 3, 4): A date filter.
  • sort required integer (values: 0, 1, 2, 3, 4, 5, 6, 7): The sort mode.
  • tagstring string: The tags to search, if any.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Forum.PostSearchResponse
  • ThrottleSeconds integer

Forum.GetPoll

Gets the specified forum poll.

bungie.Forum.GetPoll({
  "topicId": 0
}, context)

Input

• input object
  • topicId required integer: The post id of the topic that has the poll.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Forum.PostSearchResponse
  • ThrottleSeconds integer

Forum.ApproveFireteamThread

Allows the owner of a fireteam thread to approve all joined members and start a private message conversation with them.

bungie.Forum.ApproveFireteamThread({
  "topicId": 0
}, context)

Input

• input object
  • topicId required integer: The post id of the recruitment topic to approve.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Messages.Responses.SaveMessageResult
  • ThrottleSeconds integer

Forum.JoinFireteamThread

Allows a user to slot themselves into a recruitment thread fireteam slot. Returns the new state of the fireteam.

bungie.Forum.JoinFireteamThread({
  "topicId": 0
}, context)

Input

• input object
  • topicId required integer: The post id of the recruitment topic you wish to join.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Forum.ForumRecruitmentDetail
  • ThrottleSeconds integer

Forum.KickBanFireteamApplicant

Allows a recruitment thread owner to kick a join user from the fireteam. Returns the new state of the fireteam.

bungie.Forum.KickBanFireteamApplicant({
  "targetMembershipId": 0,
  "topicId": 0
}, context)

Input

• input object
  • targetMembershipId required integer: The id of the user you wish to kick.
  • topicId required integer: The post id of the recruitment topic you wish to join.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Forum.ForumRecruitmentDetail
  • ThrottleSeconds integer

Forum.LeaveFireteamThread

Allows a user to remove themselves from a recruitment thread fireteam slot. Returns the new state of the fireteam.

bungie.Forum.LeaveFireteamThread({
  "topicId": 0
}, context)

Input

• input object
  • topicId required integer: The post id of the recruitment topic you wish to leave.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response Forum.ForumRecruitmentDetail
  • ThrottleSeconds integer

Forum.GetRecruitmentThreadSummaries

Allows the caller to get a list of to 25 recruitment thread summary information objects.

bungie.Forum.GetRecruitmentThreadSummaries(null, context)

Input

This action has no parameters

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response array
    • items Forum.ForumRecruitmentDetail
  • ThrottleSeconds integer

GroupV2.CreateGroup

Create a new group.

bungie.GroupV2.CreateGroup(null, context)

Input

This action has no parameters

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response GroupsV2.GroupCreationResponse
  • ThrottleSeconds integer

GroupV2.GetAvailableAvatars

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

bungie.GroupV2.GetAvailableAvatars(null, context)

Input

This action has no parameters

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response object
  • ThrottleSeconds integer

GroupV2.GetAvailableThemes

Returns a list of all available group themes.

bungie.GroupV2.GetAvailableThemes(null, context)

Input

This action has no parameters

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response array
    • items Config.GroupTheme
  • ThrottleSeconds integer

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.

bungie.GroupV2.GetUserClanInviteSetting({
  "mType": 0
}, context)

Input

• input object
  • mType required integer (values: 0, 1, 2, 4, 10, 254, -1): The Destiny membership type of the account we wish to access settings.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response boolean
  • ThrottleSeconds integer

GroupV2.GetGroupByName

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

bungie.GroupV2.GetGroupByName({
  "groupName": "",
  "groupType": 0
}, context)

Input

• input object
  • groupName required string: Exact name of the group to find.
  • groupType required integer (values: 0, 1): Type of group to find.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response GroupsV2.GroupResponse
  • ThrottleSeconds integer

GroupV2.GetRecommendedGroups

Gets groups recommended for you based on the groups to whom those you follow belong.

bungie.GroupV2.GetRecommendedGroups(null, context)

Input

This action has no parameters

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response GroupsV2.GroupSearchResponse
  • ThrottleSeconds integer

GroupV2.GroupSearch

Search for Groups.

bungie.GroupV2.GroupSearch(null, context)

Input

This action has no parameters

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response GroupsV2.GroupSearchResponse
  • ThrottleSeconds integer

GroupV2.SetUserClanInviteSetting

Sets the state of the user's clan invite preferences - true if they wish to be invited to clans, false otherwise.

bungie.GroupV2.SetUserClanInviteSetting({
  "allowInvites": true,
  "mType": 0
}, context)

Input

• input object
  • allowInvites required boolean: True to allow invites of this user to clans, false otherwise.
  • mType required integer (values: 0, 1, 2, 4, 10, 254, -1): The Destiny membership type of linked account we are manipulating.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response integer
  • ThrottleSeconds integer

GroupV2.GetPotentialGroupsForMember

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

bungie.GroupV2.GetPotentialGroupsForMember({
  "filter": 0,
  "groupType": 0,
  "membershipId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • filter required integer (values: 0, 1, 2): Filter apply to list of potential joined groups.
  • groupType required integer (values: 0, 1): Type of group the supplied member applied.
  • membershipId required integer: Membership ID to for which to find applied groups.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): Membership type of the supplied membership ID.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response GroupsV2.GroupPotentialMembershipSearchResponse
  • ThrottleSeconds integer

GroupV2.GetGroupsForMember

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

bungie.GroupV2.GetGroupsForMember({
  "filter": 0,
  "groupType": 0,
  "membershipId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • filter required integer (values: 0, 1, 2): Filter apply to list of joined groups.
  • groupType required integer (values: 0, 1): Type of group the supplied member founded.
  • membershipId required integer: Membership ID to for which to find founded groups.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): Membership type of the supplied membership ID.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response GroupsV2.GroupMembershipSearchResponse
  • ThrottleSeconds integer

GroupV2.GetGroup

Get information about a specific group of the given ID.

bungie.GroupV2.GetGroup({
  "groupId": 0
}, context)

Input

• input object
  • groupId required integer: Requested group's id.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response GroupsV2.GroupResponse
  • ThrottleSeconds integer

GroupV2.AbdicateFoundership

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

bungie.GroupV2.AbdicateFoundership({
  "founderIdNew": 0,
  "groupId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • founderIdNew required integer: The new founder for this group. Must already be a group admin.
  • groupId required integer: The target group id.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): Membership type of the provided founderIdNew.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response boolean
  • ThrottleSeconds integer

GroupV2.GetAdminsAndFounderOfGroup

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

bungie.GroupV2.GetAdminsAndFounderOfGroup({
  "groupId": 0
}, context)

Input

• input object
  • groupId required integer: The ID of the group.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response SearchResultOfGroupMember
  • ThrottleSeconds integer

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.

bungie.GroupV2.GetBannedMembersOfGroup({
  "groupId": 0
}, context)

Input

• input object
  • groupId required integer: Group ID whose banned members you are fetching

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response SearchResultOfGroupBan
  • ThrottleSeconds integer

GroupV2.EditGroup

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.

bungie.GroupV2.EditGroup({
  "groupId": 0
}, context)

Input

• input object
  • groupId required integer: Group ID of the group to edit.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response integer
  • ThrottleSeconds integer

GroupV2.EditClanBanner

Edit an existing group's clan banner. You must have suitable permissions in the group to perform this operation. All fields are required.

bungie.GroupV2.EditClanBanner({
  "groupId": 0
}, context)

Input

• input object
  • groupId required integer: Group ID of the group to edit.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response integer
  • ThrottleSeconds integer

GroupV2.EditFounderOptions

Edit group options only available to a founder. You must have suitable permissions in the group to perform this operation.

bungie.GroupV2.EditFounderOptions({
  "groupId": 0
}, context)

Input

• input object
  • groupId required integer: Group ID of the group to edit.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response integer
  • ThrottleSeconds integer

GroupV2.GetMembersOfGroup

Get the list of members in a given group.

bungie.GroupV2.GetMembersOfGroup({
  "groupId": 0
}, context)

Input

• input object
  • groupId required integer: The ID of the group.
  • memberType integer (values: 0, 1, 2, 3, 4, 5): Filter out other member types. Use None for all members.
  • nameSearch string: The name fragment upon which a search should be executed for members with matching display or unique names.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response SearchResultOfGroupMember
  • ThrottleSeconds integer

GroupV2.RequestGroupMembership

Request permission to join the given group.

bungie.GroupV2.RequestGroupMembership({
  "groupId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • groupId required integer: ID of the group you would like to join.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): MembershipType of the account to use when joining.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response GroupsV2.GroupApplicationResponse
  • ThrottleSeconds integer

GroupV2.ApproveAllPending

Approve all of the pending users for the given group.

bungie.GroupV2.ApproveAllPending({
  "groupId": 0
}, context)

Input

• input object
  • groupId required integer: ID of the group.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response array
    • items Entities.EntityActionResult
  • ThrottleSeconds integer

GroupV2.ApprovePendingForList

Approve all of the pending users for the given group.

bungie.GroupV2.ApprovePendingForList({
  "groupId": 0
}, context)

Input

• input object
  • groupId required integer: ID of the group.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response array
    • items Entities.EntityActionResult
  • ThrottleSeconds integer

GroupV2.DenyAllPending

Deny all of the pending users for the given group.

bungie.GroupV2.DenyAllPending({
  "groupId": 0
}, context)

Input

• input object
  • groupId required integer: ID of the group.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response array
    • items Entities.EntityActionResult
  • ThrottleSeconds integer

GroupV2.DenyPendingForList

Deny all of the pending users for the given group that match the passed-in .

bungie.GroupV2.DenyPendingForList({
  "groupId": 0
}, context)

Input

• input object
  • groupId required integer: ID of the group.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response array
    • items Entities.EntityActionResult
  • ThrottleSeconds integer

GroupV2.IndividualGroupInvite

Invite a user to join this group.

bungie.GroupV2.IndividualGroupInvite({
  "groupId": 0,
  "membershipId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • groupId required integer: ID of the group you would like to join.
  • membershipId required integer: Membership id of the account being invited.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): MembershipType of the account being invited.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response GroupsV2.GroupApplicationResponse
  • ThrottleSeconds integer

GroupV2.IndividualGroupInviteCancel

Cancels a pending invitation to join a group.

bungie.GroupV2.IndividualGroupInviteCancel({
  "groupId": 0,
  "membershipId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • groupId required integer: ID of the group you would like to join.
  • membershipId required integer: Membership id of the account being cancelled.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): MembershipType of the account being cancelled.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response GroupsV2.GroupApplicationResponse
  • ThrottleSeconds integer

GroupV2.GetInvitedIndividuals

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

bungie.GroupV2.GetInvitedIndividuals({
  "groupId": 0
}, context)

Input

• input object
  • groupId required integer: ID of the group.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response SearchResultOfGroupMemberApplication
  • ThrottleSeconds integer

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.

bungie.GroupV2.GetPendingMemberships({
  "groupId": 0
}, context)

Input

• input object
  • groupId required integer: ID of the group.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response SearchResultOfGroupMemberApplication
  • ThrottleSeconds integer

GroupV2.RescindGroupMembership

Rescind your application to join the given group or leave the group if you are already a member..

bungie.GroupV2.RescindGroupMembership({
  "groupId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • groupId required integer: ID of the group.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): MembershipType of the account to leave.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response GroupsV2.GroupMemberLeaveResult
  • ThrottleSeconds integer

GroupV2.BanMember

Bans the requested member from the requested group for the specified period of time.

bungie.GroupV2.BanMember({
  "groupId": 0,
  "membershipId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • groupId required integer: Group ID that has the member to ban.
  • membershipId required integer: Membership ID of the member to ban from the group.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): Membership type of the provided membership ID.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response integer
  • ThrottleSeconds integer

GroupV2.KickMember

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.

bungie.GroupV2.KickMember({
  "groupId": 0,
  "membershipId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • groupId required integer: Group ID to kick the user from.
  • membershipId required integer: Membership ID to kick.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): Membership type of the provided membership ID.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response GroupsV2.GroupMemberLeaveResult
  • ThrottleSeconds integer

GroupV2.EditGroupMembership

Edit the membership type of a given member. You must have suitable permissions in the group to perform this operation.

bungie.GroupV2.EditGroupMembership({
  "groupId": 0,
  "membershipId": 0,
  "membershipType": 0,
  "memberType": 0
}, context)

Input

• input object
  • groupId required integer: ID of the group to which the member belongs.
  • membershipId required integer: Membership ID to modify.
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): Membership type of the provide membership ID.
  • memberType required integer (values: 0, 1, 2, 3, 4, 5): New membertype for the specified member.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response integer
  • ThrottleSeconds integer

GroupV2.UnbanMember

Unbans the requested member, allowing them to re-apply for membership.

bungie.GroupV2.UnbanMember({
  "groupId": 0,
  "membershipId": 0,
  "membershipType": 0
}, context)

Input

• input object
  • groupId required integer
  • membershipId required integer: Membership ID of the member to unban from the group
  • membershipType required integer (values: 0, 1, 2, 4, 10, 254, -1): Membership type of the provided membership ID.

Output

• output object
  • ErrorCode Exceptions.PlatformErrorCodes
  • ErrorStatus string
  • Message string
  • MessageData object
  • Response integer
  • ThrottleSeconds integer

GroupV2.