api library

Classes

AwaGetActionTokenParams
GetActivityHistoryParams
GetCharacterParams
GetClanAggregateStatsParams
GetClanLeaderboardsParams
GetClanWeeklyRewardStateParams
GetCollectibleNodeDetailsParams
GetDestinyAggregateActivityStatsParams
GetDestinyEntityDefinitionParams
GetHistoricalStatsForAccountParams
GetHistoricalStatsParams
GetItemParams
GetLeaderboardsForCharacterParams
GetLeaderboardsParams
GetLinkedProfilesParams
GetPostGameCarnageReportParams
GetProfileParams
GetPublicMilestoneContentParams
GetUniqueWeaponHistoryParams
GetVendorParams
GetVendorsParams
ReportOffensivePostGameCarnageReportPlayerParams
SearchDestinyEntitiesParams
SearchDestinyPlayerParams

Functions

awaGetActionToken(HttpClient http, AwaGetActionTokenParams params) → Future<ServerResponse<AwaAuthorizationResult>>
Returns the action token if user approves the request.
awaInitializeRequest(HttpClient http, AwaPermissionRequested body) → Future<ServerResponse<AwaInitializeResponse>>
Initialize a request to perform an advanced write action.
awaProvideAuthorizationResult(HttpClient http, AwaUserResponse body) → Future<ServerResponse<int>>
Provide the result of the user interaction. Called by the Bungie Destiny App to approve or reject a request.
equipItem(HttpClient http, DestinyItemActionRequest body) → Future<ServerResponse<int>>
Equip an item. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline.
equipItems(HttpClient http, DestinyItemSetActionRequest body) → Future<ServerResponse<DestinyEquipItemResults>>
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.
getActivityHistory(HttpClient http, GetActivityHistoryParams params) → Future<ServerResponse<DestinyActivityHistoryResults>>
Gets activity history stats for indicated character.
getCharacter(HttpClient http, GetCharacterParams params) → Future<ServerResponse<DestinyCharacterResponse>>
Returns character information for the supplied character.
getClanAggregateStats(HttpClient http, GetClanAggregateStatsParams params) → Future<ServerResponse<List<DestinyClanAggregateStat>>>
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.
getClanLeaderboards(HttpClient http, GetClanLeaderboardsParams params) → Future<ServerResponse<Map<String, Map<String, DestinyLeaderboard>>>>
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.
getClanWeeklyRewardState(HttpClient http, GetClanWeeklyRewardStateParams params) → Future<ServerResponse<DestinyMilestone>>
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.
getCollectibleNodeDetails(HttpClient http, GetCollectibleNodeDetailsParams params) → Future<ServerResponse<DestinyCollectibleNodeDetailResponse>>
Given a Presentation Node that has Collectibles as direct descendants, this will return item details about those descendants in the context of the requesting character.
getDestinyAggregateActivityStats(HttpClient http, GetDestinyAggregateActivityStatsParams params) → Future<ServerResponse<DestinyAggregateActivityResults>>
Gets all activities the character has participated in together with aggregate statistics for those activities.
getDestinyEntityDefinition(HttpClient http, GetDestinyEntityDefinitionParams params) → Future<ServerResponse<DestinyDefinition>>
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.
getDestinyManifest(HttpClient http) → Future<ServerResponse<DestinyManifest>>
Returns the current version of the manifest as a json object.
getHistoricalStats(HttpClient http, GetHistoricalStatsParams params) → Future<ServerResponse<Map<String, DestinyHistoricalStatsByPeriod>>>
Gets historical stats for indicated character.
getHistoricalStatsDefinition(HttpClient http) → Future<ServerResponse<Map<String, DestinyHistoricalStatsDefinition>>>
Gets historical stats definitions.
getHistoricalStatsForAccount(HttpClient http, GetHistoricalStatsForAccountParams params) → Future<ServerResponse<DestinyHistoricalStatsAccountResult>>
Gets aggregate historical stats organized around each character for a given account.
getItem(HttpClient http, GetItemParams params) → Future<ServerResponse<DestinyItemResponse>>
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.
getLeaderboards(HttpClient http, GetLeaderboardsParams params) → Future<ServerResponse<Map<String, Map<String, DestinyLeaderboard>>>>
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.
getLeaderboardsForCharacter(HttpClient http, GetLeaderboardsForCharacterParams params) → Future<ServerResponse<Map<String, Map<String, DestinyLeaderboard>>>>
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.
getLinkedProfiles(HttpClient http, GetLinkedProfilesParams params) → Future<ServerResponse<DestinyLinkedProfilesResponse>>
Returns a summary information about all profiles linked to the requesting membership type/membership ID that have valid Destiny information. The passed-in Membership Type/Membership ID may be a Bungie.Net membership or a Destiny membership. It only returns the minimal amount of data to begin making more substantive requests, but will hopefully serve as a useful alternative to UserServices for people who just care about Destiny data. Note that it will only return linked accounts whose linkages you are allowed to view.
getPostGameCarnageReport(HttpClient http, GetPostGameCarnageReportParams params) → Future<ServerResponse<DestinyPostGameCarnageReportData>>
Gets the available post game carnage report for the activity ID.
getProfile(HttpClient http, GetProfileParams params) → Future<ServerResponse<DestinyProfileResponse>>
Returns Destiny Profile information for the supplied membership.
getPublicMilestoneContent(HttpClient http, GetPublicMilestoneContentParams params) → Future<ServerResponse<DestinyMilestoneContent>>
Gets custom localized content for the milestone of the given hash, if it exists.
getPublicMilestones(HttpClient http) → Future<ServerResponse<Map<int, DestinyPublicMilestone>>>
Gets public information about currently available Milestones.
getUniqueWeaponHistory(HttpClient http, GetUniqueWeaponHistoryParams params) → Future<ServerResponse<DestinyHistoricalWeaponStatsData>>
Gets details about unique weapon usage, including all exotic weapons.
getVendor(HttpClient http, GetVendorParams params) → Future<ServerResponse<DestinyVendorResponse>>
Get the details of a specific Vendor.
getVendors(HttpClient http, GetVendorsParams params) → Future<ServerResponse<DestinyVendorsResponse>>
Get currently available vendors from the list of vendors that can possibly have rotating inventory. Note that this does not include things like preview vendors and vendors-as-kiosks, neither of whom have rotating/dynamic inventories. Use their definitions as-is for those.
insertSocketPlug(HttpClient http, DestinyInsertPlugsActionRequest body) → Future<ServerResponse<DestinyItemChangeResponse>>
Insert a plug into a socketed item. I know how it sounds, but I assure you it's much more G-rated than you might be guessing. We haven't decided yet whether this will be able to insert plugs that have side effects, but if we do it will require special scope permission for an application attempting to do so. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline. Request must include proof of permission for 'InsertPlugs' from the account owner.
pullFromPostmaster(HttpClient http, DestinyPostmasterTransferRequest body) → Future<ServerResponse<int>>
Extract an item from the Postmaster, with whatever implications that may entail. You must have a valid Destiny account. You must also pass BOTH a reference AND an instance ID if it's an instanced item.
reportOffensivePostGameCarnageReportPlayer(HttpClient http, ReportOffensivePostGameCarnageReportPlayerParams params, DestinyReportOffensePgcrRequest body) → Future<ServerResponse<int>>
Report a player that you met in an activity that was engaging in ToS-violating activities. Both you and the offending player must have played in the activityId passed in. Please use this judiciously and only when you have strong suspicions of violation, pretty please.
searchDestinyEntities(HttpClient http, SearchDestinyEntitiesParams params) → Future<ServerResponse<DestinyEntitySearchResult>>
Gets a page list of Destiny items.
searchDestinyPlayer(HttpClient http, SearchDestinyPlayerParams params) → Future<ServerResponse<List<UserInfoCard>>>
Returns a list of Destiny memberships given a full Gamertag or PSN ID.
setItemLockState(HttpClient http, DestinyItemStateRequest body) → Future<ServerResponse<int>>
Set the Lock State for an instanced item. You must have a valid Destiny Account.
transferItem(HttpClient http, DestinyItemTransferRequest body) → Future<ServerResponse<int>>
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