openapi-directory/api/bungie.net.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"email":"support@bungie.com","name":"Bungie.net API Support","url":"https://github.com/Bungie-net/api"},"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.","license":{"name":"BSD License 2.0","url":"https://github.com/Bungie-net/api/blob/master/LICENSE"},"termsOfService":"https://www.bungie.net/en/View/Bungie/terms","title":"Bungie.Net","version":"2.0.0","x-apisguru-categories":["media"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://pbs.twimg.com/profile_images/560547568992944129/x46z946T_400x400.jpeg"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Bungie-net/api/master/openapi-2.json","version":"2.0"}],"x-providerName":"bungie.net"},"externalDocs":{"description":"Our Wiki page about OAuth through Bungie.net.","url":"https://github.com/Bungie-net/api/wiki/OAuth-Documentation"},"tags":[{"description":"user","name":"User"},{"description":"forum","name":"Forum"},{"description":"groupV2","name":"GroupV2"},{"description":"destiny2","name":"Destiny2"},{"description":"communitycontent","name":"CommunityContent"},{"description":"trending","name":"Trending"}],"paths":{"/CommunityContent/Get/{sort}/{mediaFilter}/{page}/":{"get":{"description":"Returns community content.","operationId":"CommunityContent.GetCommunityContent","parameters":[{"description":"The type of media to get","in":"path","name":"mediaFilter","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1","2","4","8","16","32","64","128"]}},{"description":"Zero based page","in":"path","name":"page","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The sort mode.","in":"path","name":"sort","required":true,"schema":{"type":"integer","format":"uint8","enum":["0","1","2"]}}],"responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"$ref":"#/components/schemas/Forum.PostSearchResponse"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["CommunityContent"]}},"/CommunityContent/Live/All/{partnershipType}/{sort}/{page}/":{"get":{"description":"Returns info about community members who are live streaming.","operationId":"CommunityContent.GetCommunityLiveStatuses","parameters":[{"description":"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.","in":"query","name":"modeHash","schema":{"type":"integer","format":"uint32"}},{"description":"Zero based page.","in":"path","name":"page","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The type of partnership for which the status should be returned.","in":"path","name":"partnershipType","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1"]}},{"description":"The sort mode.","in":"path","name":"sort","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1","2","3"]}},{"description":"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.","in":"query","name":"streamLocale","schema":{"type":"string"}}],"responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"$ref":"#/components/schemas/SearchResultOfCommunityLiveStatus"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["CommunityContent"]}},"/CommunityContent/Live/Clan/{partnershipType}/{sort}/{page}/":{"get":{"description":"Returns info about community members who are live streaming in your clans.","operationId":"CommunityContent.GetCommunityLiveStatusesForClanmates","parameters":[{"description":"Zero based page.","in":"path","name":"page","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The type of partnership for which the status should be returned.","in":"path","name":"partnershipType","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1"]}},{"description":"The sort mode.","in":"path","name":"sort","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1","2","3"]}}],"responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"$ref":"#/components/schemas/SearchResultOfCommunityLiveStatus"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["CommunityContent"]}},"/CommunityContent/Live/Featured/{partnershipType}/{sort}/{page}/":{"get":{"description":"Returns info about Featured live streams.","operationId":"CommunityContent.GetFeaturedCommunityLiveStatuses","parameters":[{"description":"Zero based page.","in":"path","name":"page","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The type of partnership for which the status should be returned.","in":"path","name":"partnershipType","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1"]}},{"description":"The sort mode.","in":"path","name":"sort","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1","2","3"]}},{"description":"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.","in":"query","name":"streamLocale","schema":{"type":"string"}}],"responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"$ref":"#/components/schemas/SearchResultOfCommunityLiveStatus"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["CommunityContent"]}},"/CommunityContent/Live/Friends/{partnershipType}/{sort}/{page}/":{"get":{"description":"Returns info about community members who are live streaming among your friends.","operationId":"CommunityContent.GetCommunityLiveStatusesForFriends","parameters":[{"description":"Zero based page.","in":"path","name":"page","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The type of partnership for which the status should be returned.","in":"path","name":"partnershipType","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1"]}},{"description":"The sort mode.","in":"path","name":"sort","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1","2","3"]}}],"responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"$ref":"#/components/schemas/SearchResultOfCommunityLiveStatus"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["CommunityContent"]}},"/CommunityContent/Live/Users/{partnershipType}/{membershipType}/{membershipId}/":{"get":{"description":"Gets the Live Streaming status of a particular Account and Membership Type.","operationId":"CommunityContent.GetStreamingStatusForMember","parameters":[{"description":"The membershipId related to that type.","in":"path","name":"membershipId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"The type of account for which info will be extracted.","in":"path","name":"membershipType","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1","2","4","10","254","-1"]}},{"description":"The type of partnership for which info will be extracted.","in":"path","name":"partnershipType","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1"]}}],"responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"$ref":"#/components/schemas/Community.CommunityLiveStatus"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["CommunityContent"]}},"/Destiny2/Actions/Items/ActivateTalentNode/":{"post":{"description":"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.","operationId":"Destiny2.ActivateTalentNode","responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"format":"int32","type":"integer"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"security":[{"oauth2":["MoveEquipDestinyItems"]}],"tags":["Destiny2","Preview"],"x-preview":true}},"/Destiny2/Actions/Items/EquipItem/":{"post":{"description":"Equip an item. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline.","operationId":"Destiny2.EquipItem","responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"format":"int32","type":"integer"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"security":[{"oauth2":["MoveEquipDestinyItems"]}],"tags":["Destiny2"]}},"/Destiny2/Actions/Items/EquipItems/":{"post":{"description":"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.","operationId":"Destiny2.EquipItems","responses":{"200":{"description":"The results of a bulk Equipping operation performed through the Destiny API.","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"$ref":"#/components/schemas/Destiny.DestinyEquipItemResults"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"security":[{"oauth2":["MoveEquipDestinyItems"]}],"tags":["Destiny2"]}},"/Destiny2/Actions/Items/InsertSocketPlug/":{"post":{"description":"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.","operationId":"Destiny2.InsertSocketPlug","responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"format":"int32","type":"integer"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"security":[{"oauth2":["MoveEquipDestinyItems"]}],"tags":["Destiny2","Preview"],"x-preview":true}},"/Destiny2/Actions/Items/SetLockState/":{"post":{"description":"Set the Lock State for an instanced item. You must have a valid Destiny Account.","operationId":"Destiny2.SetItemLockState","responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"format":"int32","type":"integer"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"security":[{"oauth2":["MoveEquipDestinyItems"]}],"tags":["Destiny2"]}},"/Destiny2/Actions/Items/TransferItem/":{"post":{"description":"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","operationId":"Destiny2.TransferItem","responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"format":"int32","type":"integer"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"security":[{"oauth2":["MoveEquipDestinyItems"]}],"tags":["Destiny2"]}},"/Destiny2/Armory/Search/{type}/{searchTerm}/":{"get":{"description":"Gets a page list of Destiny items.","operationId":"Destiny2.SearchDestinyEntities","parameters":[{"description":"Page number to return, starting with 0.","in":"query","name":"page","schema":{"type":"integer","format":"int32"}},{"description":"The string to use when searching for Destiny entities.","in":"path","name":"searchTerm","required":true,"schema":{"type":"string"}},{"description":"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.","in":"path","name":"type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The results of a search for Destiny content. This will be improved on over time, I've been doing some experimenting to see what might be useful.","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"$ref":"#/components/schemas/Destiny.Definitions.DestinyEntitySearchResult"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2","Preview"],"x-preview":true}},"/Destiny2/Clan/{groupId}/WeeklyRewardState/":{"get":{"description":"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.","operationId":"Destiny2.GetClanWeeklyRewardState","parameters":[{"description":"A valid group id of clan.","in":"path","name":"groupId","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Represents a runtime instance of a user's milestone status. Live Milestone data should be combined with DestinyMilestoneDefinition data to show the user a picture of what is available for them to do in the game, and their status in regards to said \"things to do.\" Consider it a big, wonky to-do list, or Advisors 3.0 for those who remember the Destiny 1 API.","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"$ref":"#/components/schemas/Destiny.Milestones.DestinyMilestone"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2"]}},"/Destiny2/Manifest/":{"get":{"description":"Returns the current version of the manifest as a json object.","operationId":"Destiny2.GetDestinyManifest","responses":{"200":{"description":"DestinyManifest is the external-facing contract for just the properties needed by those calling the Destiny Platform.","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"$ref":"#/components/schemas/Destiny.Config.DestinyManifest"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2"]}},"/Destiny2/Manifest/{entityType}/{hashIdentifier}/":{"get":{"description":"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.","operationId":"Destiny2.GetDestinyEntityDefinition","parameters":[{"description":"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.","in":"path","name":"entityType","required":true,"schema":{"type":"string"}},{"description":"The hash identifier for the specific Entity you want returned.","in":"path","name":"hashIdentifier","required":true,"schema":{"type":"integer","format":"uint32"}}],"responses":{"200":{"description":"Provides common properties for destiny definitions.","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"$ref":"#/components/schemas/Destiny.Definitions.DestinyDefinition"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2"]}},"/Destiny2/Milestones/":{"get":{"description":"Gets public information about currently available Milestones.","operationId":"Destiny2.GetPublicMilestones","responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"additionalProperties":{"$ref":"#/components/schemas/Destiny.Milestones.DestinyPublicMilestone"},"type":"object"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2"]}},"/Destiny2/Milestones/{milestoneHash}/Content/":{"get":{"description":"Gets custom localized content for the milestone of the given hash, if it exists.","operationId":"Destiny2.GetPublicMilestoneContent","parameters":[{"description":"The identifier for the milestone to be returned.","in":"path","name":"milestoneHash","required":true,"schema":{"type":"integer","format":"uint32"}}],"responses":{"200":{"description":"Represents localized, extended content related to Milestones. This is intentionally returned by a separate endpoint and not with Character-level Milestone data because we do not put localized data into standard Destiny responses, both for brevity of response and for caching purposes. If you really need this data, hit the Milestone Content endpoint.","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"$ref":"#/components/schemas/Destiny.Milestones.DestinyMilestoneContent"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2"]}},"/Destiny2/SearchDestinyPlayer/{membershipType}/{displayName}/":{"get":{"description":"Returns a list of Destiny memberships given a full Gamertag or PSN ID.","operationId":"Destiny2.SearchDestinyPlayer","parameters":[{"description":"The full gamertag or PSN id of the player. Spaces and case are ignored.","in":"path","name":"displayName","required":true,"schema":{"type":"string"}},{"description":"A valid non-BungieNet membership type, or All.","in":"path","name":"membershipType","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1","2","4","10","254","-1"]}}],"responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"items":{"$ref":"#/components/schemas/User.UserInfoCard"},"type":"array"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2"]}},"/Destiny2/Stats/AggregateClanStats/{groupId}/":{"get":{"description":"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.","operationId":"Destiny2.GetClanAggregateStats","parameters":[{"description":"Group ID of the clan whose leaderboards you wish to fetch.","in":"path","name":"groupId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.","in":"query","name":"modes","schema":{"type":"string"}}],"responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"items":{"$ref":"#/components/schemas/Destiny.HistoricalStats.DestinyClanAggregateStat"},"type":"array"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2","Preview"],"x-preview":true}},"/Destiny2/Stats/Definition/":{"get":{"description":"Gets historical stats definitions.","operationId":"Destiny2.GetHistoricalStatsDefinition","responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"additionalProperties":{"$ref":"#/components/schemas/Destiny.HistoricalStats.Definitions.DestinyHistoricalStatsDefinition"},"type":"object"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2"]}},"/Destiny2/Stats/Leaderboards/Clans/{groupId}/":{"get":{"description":"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.","operationId":"Destiny2.GetClanLeaderboards","parameters":[{"description":"Group ID of the clan whose leaderboards you wish to fetch.","in":"path","name":"groupId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"Maximum number of top players to return. Use a large number to get entire leaderboard.","in":"query","name":"maxtop","schema":{"type":"integer","format":"int32"}},{"description":"List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.","in":"query","name":"modes","schema":{"type":"string"}},{"description":"ID of stat to return rather than returning all Leaderboard stats.","in":"query","name":"statid","schema":{"type":"string"}}],"responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/Destiny.HistoricalStats.DestinyLeaderboard"},"type":"object"},"type":"object"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2","Preview"],"x-preview":true}},"/Destiny2/Stats/Leaderboards/{membershipType}/{destinyMembershipId}/{characterId}/":{"get":{"description":"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.","operationId":"Destiny2.GetLeaderboardsForCharacter","parameters":[{"description":"The specific character to build the leaderboard around for the provided Destiny Membership.","in":"path","name":"characterId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"The Destiny membershipId of the user to retrieve.","in":"path","name":"destinyMembershipId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"Maximum number of top players to return. Use a large number to get entire leaderboard.","in":"query","name":"maxtop","schema":{"type":"integer","format":"int32"}},{"description":"A valid non-BungieNet membership type.","in":"path","name":"membershipType","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1","2","4","10","254","-1"]}},{"description":"List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.","in":"query","name":"modes","schema":{"type":"string"}},{"description":"ID of stat to return rather than returning all Leaderboard stats.","in":"query","name":"statid","schema":{"type":"string"}}],"responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/Destiny.HistoricalStats.DestinyLeaderboard"},"type":"object"},"type":"object"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2","Preview"],"x-preview":true}},"/Destiny2/Stats/PostGameCarnageReport/{activityId}/":{"get":{"description":"Gets the available post game carnage report for the activity ID.","operationId":"Destiny2.GetPostGameCarnageReport","parameters":[{"description":"The ID of the activity whose PGCR is requested.","in":"path","name":"activityId","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"$ref":"#/components/schemas/Destiny.HistoricalStats.DestinyPostGameCarnageReportData"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2"]}},"/Destiny2/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Stats/":{"get":{"description":"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.","operationId":"Destiny2.GetHistoricalStats","parameters":[{"description":"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.","in":"path","name":"characterId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"Last day to return when daily stats are requested. Use the format YYYY-MM-DD.","in":"query","name":"dayend","schema":{"type":"string","format":"date-time"}},{"description":"First day to return when daily stats are requested. Use the format YYYY-MM-DD","in":"query","name":"daystart","schema":{"type":"string","format":"date-time"}},{"description":"The Destiny membershipId of the user to retrieve.","in":"path","name":"destinyMembershipId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"Group of stats to include, otherwise only general stats are returned. Comma separated list is allowed. Values: General, Weapons, Medals","in":"query","name":"groups","schema":{"type":"array","items":{"$ref":"#/components/schemas/Destiny.HistoricalStats.Definitions.DestinyStatsGroupType"}}},{"description":"A valid non-BungieNet membership type.","in":"path","name":"membershipType","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1","2","4","10","254","-1"]}},{"description":"Game modes to return. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.","in":"query","name":"modes","schema":{"type":"array","items":{"$ref":"#/components/schemas/Destiny.HistoricalStats.Definitions.DestinyActivityModeType"}}},{"description":"Indicates a specific period type to return. Optional. May be: Daily, AllTime, or Activity","in":"query","name":"periodType","schema":{"type":"integer","format":"int32","enum":["0","1","2","3"]}}],"responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"additionalProperties":{"$ref":"#/components/schemas/Destiny.HistoricalStats.DestinyHistoricalStatsByPeriod"},"type":"object"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2","Preview"],"x-preview":true}},"/Destiny2/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Stats/Activities/":{"get":{"description":"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.","operationId":"Destiny2.GetActivityHistory","parameters":[{"description":"The id of the character to retrieve.","in":"path","name":"characterId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"Number of rows to return","in":"query","name":"count","schema":{"type":"integer","format":"int32"}},{"description":"The Destiny membershipId of the user to retrieve.","in":"path","name":"destinyMembershipId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"A valid non-BungieNet membership type.","in":"path","name":"membershipType","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1","2","4","10","254","-1"]}},{"description":"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.","in":"query","name":"mode","schema":{"type":"integer","format":"int32","enum":["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"]}},{"description":"Page number to return, starting with 0.","in":"query","name":"page","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"$ref":"#/components/schemas/Destiny.HistoricalStats.DestinyActivityHistoryResults"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2","Preview"],"x-preview":true}},"/Destiny2/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Stats/AggregateActivityStats/":{"get":{"description":"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.","operationId":"Destiny2.GetDestinyAggregateActivityStats","parameters":[{"description":"The specific character whose activities should be returned.","in":"path","name":"characterId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"The Destiny membershipId of the user to retrieve.","in":"path","name":"destinyMembershipId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"A valid non-BungieNet membership type.","in":"path","name":"membershipType","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1","2","4","10","254","-1"]}}],"responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"$ref":"#/components/schemas/Destiny.HistoricalStats.DestinyAggregateActivityResults"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2","Preview"],"x-preview":true}},"/Destiny2/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Stats/UniqueWeapons/":{"get":{"description":"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.","operationId":"Destiny2.GetUniqueWeaponHistory","parameters":[{"description":"The id of the character to retrieve.","in":"path","name":"characterId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"The Destiny membershipId of the user to retrieve.","in":"path","name":"destinyMembershipId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"A valid non-BungieNet membership type.","in":"path","name":"membershipType","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1","2","4","10","254","-1"]}}],"responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"$ref":"#/components/schemas/Destiny.HistoricalStats.DestinyHistoricalWeaponStatsData"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2","Preview"],"x-preview":true}},"/Destiny2/{membershipType}/Account/{destinyMembershipId}/Stats/":{"get":{"description":"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.","operationId":"Destiny2.GetHistoricalStatsForAccount","parameters":[{"description":"The Destiny membershipId of the user to retrieve.","in":"path","name":"destinyMembershipId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"Groups of stats to include, otherwise only general stats are returned. Comma separated list is allowed. Values: General, Weapons, Medals.","in":"query","name":"groups","schema":{"type":"array","items":{"$ref":"#/components/schemas/Destiny.HistoricalStats.Definitions.DestinyStatsGroupType"}}},{"description":"A valid non-BungieNet membership type.","in":"path","name":"membershipType","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1","2","4","10","254","-1"]}}],"responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"$ref":"#/components/schemas/Destiny.HistoricalStats.DestinyHistoricalStatsAccountResult"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2","Preview"],"x-preview":true}},"/Destiny2/{membershipType}/Account/{destinyMembershipId}/Stats/Leaderboards/":{"get":{"description":"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.","operationId":"Destiny2.GetLeaderboards","parameters":[{"description":"The Destiny membershipId of the user to retrieve.","in":"path","name":"destinyMembershipId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"Maximum number of top players to return. Use a large number to get entire leaderboard.","in":"query","name":"maxtop","schema":{"type":"integer","format":"int32"}},{"description":"A valid non-BungieNet membership type.","in":"path","name":"membershipType","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1","2","4","10","254","-1"]}},{"description":"List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.","in":"query","name":"modes","schema":{"type":"string"}},{"description":"ID of stat to return rather than returning all Leaderboard stats.","in":"query","name":"statid","schema":{"type":"string"}}],"responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/Destiny.HistoricalStats.DestinyLeaderboard"},"type":"object"},"type":"object"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2","Preview"],"x-preview":true}},"/Destiny2/{membershipType}/Profile/{destinyMembershipId}/":{"get":{"description":"Returns Destiny Profile information for the supplied membership.","operationId":"Destiny2.GetProfile","parameters":[{"description":"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.","in":"query","name":"components","schema":{"type":"array","items":{"$ref":"#/components/schemas/Destiny.DestinyComponentType"}}},{"description":"Destiny membership ID.","in":"path","name":"destinyMembershipId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"A valid non-BungieNet membership type.","in":"path","name":"membershipType","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1","2","4","10","254","-1"]}}],"responses":{"200":{"description":"The response for GetDestinyProfile, with components for character and item-level data.","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"$ref":"#/components/schemas/Destiny.Responses.DestinyProfileResponse"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2"]}},"/Destiny2/{membershipType}/Profile/{destinyMembershipId}/Character/{characterId}/":{"get":{"description":"Returns character information for the supplied character.","operationId":"Destiny2.GetCharacter","parameters":[{"description":"ID of the character.","in":"path","name":"characterId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"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.","in":"query","name":"components","schema":{"type":"array","items":{"$ref":"#/components/schemas/Destiny.DestinyComponentType"}}},{"description":"Destiny membership ID.","in":"path","name":"destinyMembershipId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"A valid non-BungieNet membership type.","in":"path","name":"membershipType","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1","2","4","10","254","-1"]}}],"responses":{"200":{"description":"The response contract for GetDestinyCharacter, with components that can be returned for character and item-level data.","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"$ref":"#/components/schemas/Destiny.Responses.DestinyCharacterResponse"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2"]}},"/Destiny2/{membershipType}/Profile/{destinyMembershipId}/Character/{characterId}/Vendors/":{"get":{"description":"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.","operationId":"Destiny2.GetVendors","parameters":[{"description":"The Destiny Character ID of the character for whom we're getting vendor info.","in":"path","name":"characterId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"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.","in":"query","name":"components","schema":{"type":"array","items":{"$ref":"#/components/schemas/Destiny.DestinyComponentType"}}},{"description":"Destiny membership ID of another user. You may be denied.","in":"path","name":"destinyMembershipId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"A valid non-BungieNet membership type.","in":"path","name":"membershipType","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1","2","4","10","254","-1"]}}],"responses":{"200":{"description":"Look at the Response property for more information about the nature of this response","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"items":{"$ref":"#/components/schemas/Destiny.Responses.DestinyVendorResponse"},"type":"array"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2","Preview"],"x-preview":true}},"/Destiny2/{membershipType}/Profile/{destinyMembershipId}/Character/{characterId}/Vendors/{vendorHash}/":{"get":{"description":"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.","operationId":"Destiny2.GetVendor","parameters":[{"description":"The Destiny Character ID of the character for whom we're getting vendor info.","in":"path","name":"characterId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"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.","in":"query","name":"components","schema":{"type":"array","items":{"$ref":"#/components/schemas/Destiny.DestinyComponentType"}}},{"description":"Destiny membership ID of another user. You may be denied.","in":"path","name":"destinyMembershipId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"A valid non-BungieNet membership type.","in":"path","name":"membershipType","required":true,"schema":{"type":"integer","format":"int32","enum":["0","1","2","4","10","254","-1"]}},{"description":"The Hash identifier of the Vendor to be returned.","in":"path","name":"vendorHash","required":true,"schema":{"type":"integer","format":"uint32"}}],"responses":{"200":{"description":"A response containing all of the components for a vendor.","content":{"*/*":{"schema":{"properties":{"ErrorCode":{"$ref":"#/components/schemas/Exceptions.PlatformErrorCodes"},"ErrorStatus":{"type":"string"},"Message":{"type":"string"},"MessageData":{"additionalProperties":{"type":"string"},"type":"object"},"Response":{"$ref":"#/components/schemas/Destiny.Responses.DestinyVendorResponse"},"ThrottleSeconds":{"format":"int32","type":"integer"}},"type":"object"}}}}},"tags":["Destiny2","Preview"],"x-preview":true}},"/Destiny2/{membershipType}/Profile/{destinyMembershipId}/Item/{itemInstanceId}/":{"get":{"description":"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.","operationId":"Destiny2.GetItem","parameters":[{"description":"A comma separated list of components to return (as strings or numeric values). See the DestinyComponentType e