bungieapi.generated.clients package

Submodules

bungieapi.generated.clients.app module

class bungieapi.generated.clients.app.Client(session: aiohttp.client.ClientSession, path: str)

Bases: bungieapi.base.BaseClient

async get_application_api_usage(application_id: Optional[int] = None, end: Optional[str] = None, start: Optional[str] = None) → bungieapi.generated.components.responses.applications.ApiUsageClientResponse

Get API usage by application for time frame specified.

You can go as far back as 30 days ago, and can ask for up to a 48 hour window of time in a single request. You must be authenticated with at least the ReadUserData permission to access this endpoint. Parameters:

application_id: ID of the application to get usage statistics. end: End time for query. Goes to now if not specified. start: Start time for query. Goes to 24 hours ago if not specified.

async get_bungie_applications() → bungieapi.generated.components.responses.IEnumerableOfApplicationClientResponse

Get list of applications created by Bungie.

bungieapi.generated.clients.community_content module

class bungieapi.generated.clients.community_content.Client(session: aiohttp.client.ClientSession, path: str)

Bases: bungieapi.base.BaseClient

async get_community_content(media_filter: Optional[bungieapi.generated.components.schemas.forum.ForumTopicsCategoryFiltersEnum] = None, page: Optional[int] = None, sort: Optional[bungieapi.generated.components.schemas.forum.CommunityContentSortMode] = None) → bungieapi.generated.components.responses.forum.PostSearchClientResponse

Returns community content.

Parameters:

media_filter: The type of media to get page: Zero based page sort: The sort mode.

bungieapi.generated.clients.content module

class bungieapi.generated.clients.content.Client(session: aiohttp.client.ClientSession, path: str)

Bases: bungieapi.base.BaseClient

async get_content_by_id(head: Optional[bool] = None, id: Optional[int] = None, locale: Optional[str] = None) → bungieapi.generated.components.responses.content.ContentItemPublicContractClientResponse

Returns a content item referenced by id Parameters:

head: false

async get_content_by_tag_and_type(head: Optional[bool] = None, locale: Optional[str] = None, tag: Optional[str] = None, type: Optional[str] = None) → bungieapi.generated.components.responses.content.ContentItemPublicContractClientResponse

Returns the newest item that matches a given tag and Content Type.

Parameters:

head: Not used.

async get_content_type(type: Optional[str] = None) → bungieapi.generated.components.responses.content.models.ContentTypeDescriptionClientResponse

Gets an object describing a particular variant of content.

async search_content_by_tag_and_type(currentpage: Optional[int] = None, head: Optional[bool] = None, itemsperpage: Optional[int] = None, locale: Optional[str] = None, tag: Optional[str] = None, type: Optional[str] = None) → bungieapi.generated.components.responses.SearchResultOfContentItemPublicContractClientResponse

Searches for Content Items that match the given Tag and Content Type.

Parameters:

currentpage: Page number for the search results starting with page 1. head: Not used. itemsperpage: Not used.

async search_content_with_text(ctype: Optional[str] = None, currentpage: Optional[int] = None, head: Optional[bool] = None, locale: Optional[str] = None, searchtext: Optional[str] = None, source: Optional[str] = None, tag: Optional[str] = None) → bungieapi.generated.components.responses.SearchResultOfContentItemPublicContractClientResponse

Gets content based on querystring information passed in.

Provides basic search and text search capabilities. Parameters:

ctype: Content type tag: Help, News, etc. Supply multiple ctypes separated by space. currentpage: Page number for the search results, starting with page 1. head: Not used. searchtext: Word or phrase for the search. source: For analytics, hint at the part of the app that triggered the search. Optional. tag: Tag used on the content to be searched.

async search_help_articles(searchtext: Optional[str] = None, size: Optional[str] = None) → bungieapi.generated.components.responses.IReadOnlyCollectionOfContentItemPublicContractClientResponse

Search for Help Articles.

bungieapi.generated.clients.destiny2 module

class bungieapi.generated.clients.destiny2.Client(session: aiohttp.client.ClientSession, path: str)

Bases: bungieapi.base.BaseClient

async awa_get_action_token(correlation_id: Optional[str] = None) → bungieapi.generated.components.responses.destiny.advanced.AwaAuthorizationResultClientResponse

Returns the action token if user approves the request.

Parameters:

correlation_id: The identifier for the advanced write action request.

async awa_initialize_request(request: Optional[bungieapi.generated.components.schemas.destiny.advanced.AwaPermissionRequested]) → bungieapi.generated.components.responses.destiny.advanced.AwaInitializeClientResponse

Initialize a request to perform an advanced write action.

async awa_provide_authorization_result(request: Optional[bungieapi.generated.components.schemas.destiny.advanced.AwaUserResponse]) → bungieapi.generated.components.responses.int32ClientResponse

Provide the result of the user interaction.

Called by the Bungie Destiny App to approve or reject a request.

async equip_item(request: Optional[bungieapi.generated.components.schemas.destiny.requests.actions.DestinyItemActionRequest]) → bungieapi.generated.components.responses.int32ClientResponse

Equip an item.

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

async equip_items(request: Optional[bungieapi.generated.components.schemas.destiny.requests.actions.DestinyItemSetActionRequest]) → bungieapi.generated.components.responses.destiny.DestinyEquipItemResultsClientResponse

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.

async get_activity_history(character_id: Optional[int] = None, count: Optional[int] = None, destiny_membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None, mode: Optional[bungieapi.generated.components.schemas.destiny.historical_stats.definitions.DestinyActivityModeType] = None, page: Optional[int] = None) → bungieapi.generated.components.responses.destiny.historical_stats.DestinyActivityHistoryResultsClientResponse

Gets activity history stats for indicated character.

Parameters:

character_id: The id of the character to retrieve. count: Number of rows to return destiny_membership_id: The Destiny membershipId of the user to retrieve. membership_type: A valid non-BungieNet membership type. mode: 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: Page number to return, starting with 0.

async get_character(character_id: Optional[int] = None, components: Optional[Sequence[bungieapi.generated.components.schemas.destiny.DestinyComponentType]] = None, destiny_membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.destiny.responses.DestinyCharacterClientResponse

Returns character information for the supplied character.

Parameters:

character_id: ID of the character. components: 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. destiny_membership_id: Destiny membership ID. membership_type: A valid non-BungieNet membership type.

async get_clan_aggregate_stats(group_id: Optional[int] = None, modes: Optional[str] = None) → bungieapi.generated.components.responses.ListOfDestinyClanAggregateStatClientResponse

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. Parameters:

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

async get_clan_banner_source() → bungieapi.generated.components.responses.config.clan_banner.ClanBannerSourceClientResponse

Returns the dictionary of values for the Clan Banner.

async get_clan_leaderboards(group_id: Optional[int] = None, maxtop: Optional[int] = None, modes: Optional[str] = None, statid: Optional[str] = None) → bungieapi.generated.components.responses.destiny.historical_stats.DestinyLeaderboardResultsClientResponse

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. Parameters:

group_id: Group ID of the clan whose leaderboards you wish to fetch. maxtop: Maximum number of top players to return. Use a large number to get entire leaderboard. modes: 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: ID of stat to return rather than returning all Leaderboard stats.

async get_clan_weekly_reward_state(group_id: Optional[int] = None) → bungieapi.generated.components.responses.destiny.milestones.DestinyMilestoneClientResponse

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. Parameters:

group_id: A valid group id of clan.

async get_collectible_node_details(character_id: Optional[int] = None, collectible_presentation_node_hash: Optional[int] = None, components: Optional[Sequence[bungieapi.generated.components.schemas.destiny.DestinyComponentType]] = None, destiny_membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.destiny.responses.DestinyCollectibleNodeDetailClientResponse

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.

Parameters:

character_id: The Destiny Character ID of the character for whom we’re getting collectible detail info. collectible_presentation_node_hash: The hash identifier of the Presentation Node for whom we should return collectible details. Details will only be returned for collectibles that are direct descendants of this node. components: 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. destiny_membership_id: Destiny membership ID of another user. You may be denied. membership_type: A valid non-BungieNet membership type.

async get_destiny_aggregate_activity_stats(character_id: Optional[int] = None, destiny_membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.destiny.historical_stats.DestinyAggregateActivityResultsClientResponse

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

Parameters:

character_id: The specific character whose activities should be returned. destiny_membership_id: The Destiny membershipId of the user to retrieve. membership_type: A valid non-BungieNet membership type.

async get_destiny_entity_definition(entity_type: Optional[str] = None, hash_identifier: Optional[int] = None) → bungieapi.generated.components.responses.destiny.definitions.DestinyDefinitionClientResponse

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. Parameters:

entity_type: 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. hash_identifier: The hash identifier for the specific Entity you want returned.

async get_destiny_manifest() → bungieapi.generated.components.responses.destiny.config.DestinyManifestClientResponse

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

async get_historical_stats(character_id: Optional[int] = None, dayend: Optional[str] = None, daystart: Optional[str] = None, destiny_membership_id: Optional[int] = None, groups: Optional[Sequence[bungieapi.generated.components.schemas.destiny.historical_stats.definitions.DestinyStatsGroupType]] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None, modes: Optional[Sequence[bungieapi.generated.components.schemas.destiny.historical_stats.definitions.DestinyActivityModeType]] = None, period_type: Optional[bungieapi.generated.components.schemas.destiny.historical_stats.definitions.PeriodType] = None) → bungieapi.generated.components.responses.destiny.historical_stats.DestinyHistoricalStatsResultsClientResponse

Gets historical stats for indicated character.

Parameters:

character_id: 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: Last day to return when daily stats are requested. Use the format YYYY-MM-DD. Currently, we cannot allow more than 31 days of daily data to be requested in a single request. daystart: First day to return when daily stats are requested. Use the format YYYY-MM-DD. Currently, we cannot allow more than 31 days of daily data to be requested in a single request. destiny_membership_id: The Destiny membershipId of the user to retrieve. groups: Group of stats to include, otherwise only general stats are returned. Comma separated list is allowed. Values: General, Weapons, Medals membership_type: A valid non-BungieNet membership type. modes: Game modes to return. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited. period_type: Indicates a specific period type to return. Optional. May be: Daily, AllTime, or Activity

async get_historical_stats_definition() → bungieapi.generated.components.responses.ReadOnlyDictionaryOfstringAndDestinyHistoricalStatsDefinitionClientResponse

Gets historical stats definitions.

async get_historical_stats_for_account(destiny_membership_id: Optional[int] = None, groups: Optional[Sequence[bungieapi.generated.components.schemas.destiny.historical_stats.definitions.DestinyStatsGroupType]] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.destiny.historical_stats.DestinyHistoricalStatsAccountResultClientResponse

Gets aggregate historical stats organized around each character for a given account.

Parameters:

destiny_membership_id: The Destiny membershipId of the user to retrieve. groups: Groups of stats to include, otherwise only general stats are returned. Comma separated list is allowed. Values: General, Weapons, Medals. membership_type: A valid non-BungieNet membership type.

async get_item(components: Optional[Sequence[bungieapi.generated.components.schemas.destiny.DestinyComponentType]] = None, destiny_membership_id: Optional[int] = None, item_instance_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.destiny.responses.DestinyItemClientResponse

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. Parameters:

components: 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. destiny_membership_id: The membership ID of the destiny profile. item_instance_id: The Instance ID of the destiny item. membership_type: A valid non-BungieNet membership type.

async get_leaderboards(destiny_membership_id: Optional[int] = None, maxtop: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None, modes: Optional[str] = None, statid: Optional[str] = None) → bungieapi.generated.components.responses.destiny.historical_stats.DestinyLeaderboardResultsClientResponse

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. Parameters:

destiny_membership_id: The Destiny membershipId of the user to retrieve. maxtop: Maximum number of top players to return. Use a large number to get entire leaderboard. membership_type: A valid non-BungieNet membership type. modes: 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: ID of stat to return rather than returning all Leaderboard stats.

async get_leaderboards_for_character(character_id: Optional[int] = None, destiny_membership_id: Optional[int] = None, maxtop: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None, modes: Optional[str] = None, statid: Optional[str] = None) → bungieapi.generated.components.responses.destiny.historical_stats.DestinyLeaderboardResultsClientResponse

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. Parameters:

character_id: The specific character to build the leaderboard around for the provided Destiny Membership. destiny_membership_id: The Destiny membershipId of the user to retrieve. maxtop: Maximum number of top players to return. Use a large number to get entire leaderboard. membership_type: A valid non-BungieNet membership type. modes: 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: ID of stat to return rather than returning all Leaderboard stats.

async get_linked_profiles(get_all_memberships: Optional[bool] = None, membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.destiny.responses.DestinyLinkedProfilesClientResponse

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. Parameters:

get_all_memberships: (optional) if set to ‘true’, all memberships regardless of whether they’re obscured by overrides will be returned. Normal privacy restrictions on account linking will still apply no matter what. membership_id: The ID of the membership whose linked Destiny accounts you want returned. Make sure your membership ID matches its Membership Type: don’t pass us a PSN membership ID and the XBox membership type, it’s not going to work! membership_type: The type for the membership whose linked Destiny accounts you want returned.

async get_post_game_carnage_report(activity_id: Optional[int] = None) → bungieapi.generated.components.responses.destiny.historical_stats.DestinyPostGameCarnageReportDataClientResponse

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

Parameters:

activity_id: The ID of the activity whose PGCR is requested.

async get_profile(components: Optional[Sequence[bungieapi.generated.components.schemas.destiny.DestinyComponentType]] = None, destiny_membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.destiny.responses.DestinyProfileClientResponse

Returns Destiny Profile information for the supplied membership.

Parameters:

components: 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. destiny_membership_id: Destiny membership ID. membership_type: A valid non-BungieNet membership type.

async get_public_milestone_content(milestone_hash: Optional[int] = None) → bungieapi.generated.components.responses.destiny.milestones.DestinyMilestoneContentClientResponse

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

Parameters:

milestone_hash: The identifier for the milestone to be returned.

async get_public_milestones() → bungieapi.generated.components.responses.DictionaryOfuint32AndDestinyPublicMilestoneClientResponse

Gets public information about currently available Milestones.

async get_public_vendors(components: Optional[Sequence[bungieapi.generated.components.schemas.destiny.DestinyComponentType]] = None) → bungieapi.generated.components.responses.destiny.responses.DestinyPublicVendorsClientResponse

Get items available from vendors where the vendors have items for sale that are common for everyone.

If any portion of the Vendor’s available inventory is character or account specific, we will be unable to return their data from this endpoint due to the way that available inventory is computed. As I am often guilty of saying: ‘It’s a long story…’ Parameters:

components: 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.

async get_unique_weapon_history(character_id: Optional[int] = None, destiny_membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.destiny.historical_stats.DestinyHistoricalWeaponStatsDataClientResponse

Gets details about unique weapon usage, including all exotic weapons.

Parameters:

character_id: The id of the character to retrieve. destiny_membership_id: The Destiny membershipId of the user to retrieve. membership_type: A valid non-BungieNet membership type.

async get_vendor(character_id: Optional[int] = None, components: Optional[Sequence[bungieapi.generated.components.schemas.destiny.DestinyComponentType]] = None, destiny_membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None, vendor_hash: Optional[int] = None) → bungieapi.generated.components.responses.destiny.responses.DestinyVendorClientResponse

Get the details of a specific Vendor.

Parameters:

character_id: The Destiny Character ID of the character for whom we’re getting vendor info. components: 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. destiny_membership_id: Destiny membership ID of another user. You may be denied. membership_type: A valid non-BungieNet membership type. vendor_hash: The Hash identifier of the Vendor to be returned.

async get_vendors(character_id: Optional[int] = None, components: Optional[Sequence[bungieapi.generated.components.schemas.destiny.DestinyComponentType]] = None, destiny_membership_id: Optional[int] = None, filter: Optional[bungieapi.generated.components.schemas.destiny.DestinyVendorFilter] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.destiny.responses.DestinyVendorsClientResponse

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. Parameters:

character_id: The Destiny Character ID of the character for whom we’re getting vendor info. components: 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. destiny_membership_id: Destiny membership ID of another user. You may be denied. filter: The filter of what vendors and items to return, if any. membership_type: A valid non-BungieNet membership type.

async insert_socket_plug(request: Optional[bungieapi.generated.components.schemas.destiny.requests.actions.DestinyInsertPlugsActionRequest]) → bungieapi.generated.components.responses.destiny.responses.DestinyItemChangeClientResponse

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.

async insert_socket_plug_free(request: Optional[bungieapi.generated.components.schemas.destiny.requests.actions.DestinyInsertPlugsFreeActionRequest]) → bungieapi.generated.components.responses.destiny.responses.DestinyItemChangeClientResponse

Insert a ‘free’ plug into an item’s socket.

This does not require ‘Advanced Write Action’ authorization and is available to 3rd-party apps, but will only work on ‘free and reversible’ socket actions (Perks, Armor Mods, Shaders, Ornaments, etc.). You must have a valid Destiny Account, and the character must either be in a social space, in orbit, or offline.

async pull_from_postmaster(request: Optional[bungieapi.generated.components.schemas.destiny.requests.actions.DestinyPostmasterTransferRequest]) → bungieapi.generated.components.responses.int32ClientResponse

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.

async report_offensive_post_game_carnage_report_player(request: Optional[bungieapi.generated.components.schemas.destiny.reporting.requests.DestinyReportOffensePgcrRequest], activity_id: Optional[int] = None) → bungieapi.generated.components.responses.int32ClientResponse

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. Parameters:

activity_id: The ID of the activity where you ran into the brigand that you’re reporting.

async search_destiny_entities(page: Optional[int] = None, search_term: Optional[str] = None, type: Optional[str] = None) → bungieapi.generated.components.responses.destiny.definitions.DestinyEntitySearchResultClientResponse

Gets a page list of Destiny items.

Parameters:

page: Page number to return, starting with 0. search_term: The string to use when searching for Destiny entities. type: 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’.

async search_destiny_player_by_bungie_name(request: Optional[bungieapi.generated.components.schemas.user.ExactSearchRequest], membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.IEnumerableOfUserInfoCardClientResponse

Returns a list of Destiny memberships given a global Bungie Display Name.

This method will hide overridden memberships due to cross save. Parameters:

membership_type: A valid non-BungieNet membership type, or All. Indicates which memberships to return. You probably want this set to All.

async set_item_lock_state(request: Optional[bungieapi.generated.components.schemas.destiny.requests.actions.DestinyItemStateRequest]) → bungieapi.generated.components.responses.int32ClientResponse

Set the Lock State for an instanced item.

You must have a valid Destiny Account.

async set_quest_tracked_state(request: Optional[bungieapi.generated.components.schemas.destiny.requests.actions.DestinyItemStateRequest]) → bungieapi.generated.components.responses.int32ClientResponse

Set the Tracking State for an instanced item, if that item is a Quest or Bounty.

You must have a valid Destiny Account. Yeah, it’s an item.

async transfer_item(request: Optional[bungieapi.generated.components.schemas.destiny.requests.DestinyItemTransferRequest]) → bungieapi.generated.components.responses.int32ClientResponse

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

bungieapi.generated.clients.fireteam module

class bungieapi.generated.clients.fireteam.Client(session: aiohttp.client.ClientSession, path: str)

Bases: bungieapi.base.BaseClient

async get_active_private_clan_fireteam_count(group_id: Optional[int] = None) → bungieapi.generated.components.responses.int32ClientResponse

Gets a count of all active non-public fireteams for the specified clan.

Maximum value returned is 25. Parameters:

group_id: The group id of the clan.

async get_available_clan_fireteams(activity_type: Optional[int] = None, date_range: Optional[bungieapi.generated.components.schemas.fireteam.FireteamDateRange] = None, group_id: Optional[int] = None, lang_filter: Optional[str] = None, page: Optional[int] = None, platform: Optional[bungieapi.generated.components.schemas.fireteam.FireteamPlatform] = None, public_only: Optional[bungieapi.generated.components.schemas.fireteam.FireteamPublicSearchOption] = None, slot_filter: Optional[bungieapi.generated.components.schemas.fireteam.FireteamSlotSearch] = None) → bungieapi.generated.components.responses.SearchResultOfFireteamSummaryClientResponse

Gets a listing of all of this clan’s fireteams that are have available slots.

Caller is not checked for join criteria so caching is maximized. Parameters:

activity_type: The activity type to filter by. date_range: The date range to grab available fireteams. group_id: The group id of the clan. lang_filter: An optional language filter. page: Zero based page platform: The platform filter. public_only: Determines public/private filtering. slot_filter: Filters based on available slots

async get_clan_fireteam(fireteam_id: Optional[int] = None, group_id: Optional[int] = None) → bungieapi.generated.components.responses.fireteam.FireteamClientResponse

Gets a specific fireteam.

Parameters:

fireteam_id: The unique id of the fireteam. group_id: The group id of the clan.

async get_my_clan_fireteams(group_filter: Optional[bool] = None, group_id: Optional[int] = None, include_closed: Optional[bool] = None, lang_filter: Optional[str] = None, page: Optional[int] = None, platform: Optional[bungieapi.generated.components.schemas.fireteam.FireteamPlatform] = None) → bungieapi.generated.components.responses.SearchResultOfFireteamClientResponse

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

Parameters:

group_filter: If true, filter by clan. Otherwise, ignore the clan and show all of the user’s fireteams. group_id: The group id of the clan. (This parameter is ignored unless the optional query parameter groupFilter is true). include_closed: If true, return fireteams that have been closed. lang_filter: An optional language filter. page: Deprecated parameter, ignored. platform: The platform filter.

async search_public_available_clan_fireteams(activity_type: Optional[int] = None, date_range: Optional[bungieapi.generated.components.schemas.fireteam.FireteamDateRange] = None, lang_filter: Optional[str] = None, page: Optional[int] = None, platform: Optional[bungieapi.generated.components.schemas.fireteam.FireteamPlatform] = None, slot_filter: Optional[bungieapi.generated.components.schemas.fireteam.FireteamSlotSearch] = None) → bungieapi.generated.components.responses.SearchResultOfFireteamSummaryClientResponse

Gets a listing of all public fireteams starting now with open slots.

Caller is not checked for join criteria so caching is maximized. Parameters:

activity_type: The activity type to filter by. date_range: The date range to grab available fireteams. lang_filter: An optional language filter. page: Zero based page platform: The platform filter. slot_filter: Filters based on available slots

bungieapi.generated.clients.forum module

class bungieapi.generated.clients.forum.Client(session: aiohttp.client.ClientSession, path: str)

Bases: bungieapi.base.BaseClient

async get_core_topics_paged(category_filter: Optional[bungieapi.generated.components.schemas.forum.ForumTopicsCategoryFiltersEnum] = None, locales: Optional[str] = None, page: Optional[int] = None, quick_date: Optional[bungieapi.generated.components.schemas.forum.ForumTopicsQuickDateEnum] = None, sort: Optional[bungieapi.generated.components.schemas.forum.ForumTopicsSortEnum] = None) → bungieapi.generated.components.responses.forum.PostSearchClientResponse

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

Parameters:

category_filter: The category filter. locales: Comma seperated list of locales posts must match to return in the result list. Default ‘en’ page: Zero base page quick_date: The date filter. sort: The sort mode.

async get_forum_tag_suggestions(partialtag: Optional[str] = None) → bungieapi.generated.components.responses.ListOfTagClientResponse

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

Parameters:

partialtag: The partial tag input to generate suggestions from.

async get_poll(topic_id: Optional[int] = None) → bungieapi.generated.components.responses.forum.PostSearchClientResponse

Gets the specified forum poll.

Parameters:

topic_id: The post id of the topic that has the poll.

async get_post_and_parent(child_post_id: Optional[int] = None, showbanned: Optional[str] = None) → bungieapi.generated.components.responses.forum.PostSearchClientResponse

Returns the post specified and its immediate parent.

Parameters:

showbanned: If this value is not null or empty, banned posts are requested to be returned

async get_post_and_parent_awaiting_approval(child_post_id: Optional[int] = None, showbanned: Optional[str] = None) → bungieapi.generated.components.responses.forum.PostSearchClientResponse

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

Parameters:

showbanned: If this value is not null or empty, banned posts are requested to be returned

async get_posts_threaded_paged(get_parent_post: Optional[bool] = None, page: Optional[int] = None, page_size: Optional[int] = None, parent_post_id: Optional[int] = None, reply_size: Optional[int] = None, root_thread_mode: Optional[bool] = None, showbanned: Optional[str] = None, sort_mode: Optional[bungieapi.generated.components.schemas.forum.ForumPostSortEnum] = None) → bungieapi.generated.components.responses.forum.PostSearchClientResponse

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

Parameters:

showbanned: If this value is not null or empty, banned posts are requested to be returned

async get_posts_threaded_paged_from_child(child_post_id: Optional[int] = None, page: Optional[int] = None, page_size: Optional[int] = None, reply_size: Optional[int] = None, root_thread_mode: Optional[bool] = None, showbanned: Optional[str] = None, sort_mode: Optional[bungieapi.generated.components.schemas.forum.ForumPostSortEnum] = None) → bungieapi.generated.components.responses.forum.PostSearchClientResponse

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.

Parameters:

showbanned: If this value is not null or empty, banned posts are requested to be returned

async get_recruitment_thread_summaries(request: Optional[Sequence[int]]) → bungieapi.generated.components.responses.CEListOfForumRecruitmentDetailClientResponse

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

async get_topic_for_content(content_id: Optional[int] = None) → bungieapi.generated.components.responses.int64ClientResponse

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

async get_topics_paged(category_filter: Optional[bungieapi.generated.components.schemas.forum.ForumTopicsCategoryFiltersEnum] = None, group: Optional[int] = None, locales: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, quick_date: Optional[bungieapi.generated.components.schemas.forum.ForumTopicsQuickDateEnum] = None, sort: Optional[bungieapi.generated.components.schemas.forum.ForumTopicsSortEnum] = None, tagstring: Optional[str] = None) → bungieapi.generated.components.responses.forum.PostSearchClientResponse

Get topics from any forum.

Parameters:

category_filter: A category filter group: The group, if any. locales: Comma seperated list of locales posts must match to return in the result list. Default ‘en’ page: Zero paged page number page_size: Unused quick_date: A date filter. sort: The sort mode. tagstring: The tags to search, if any.

bungieapi.generated.clients.group_v2 module

class bungieapi.generated.clients.group_v2.Client(session: aiohttp.client.ClientSession, path: str)

Bases: bungieapi.base.BaseClient

async abdicate_foundership(founder_id_new: Optional[int] = None, group_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.booleanClientResponse

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

Parameters:

founder_id_new: The new founder for this group. Must already be a group admin. group_id: The target group id. membership_type: Membership type of the provided founderIdNew.

async add_optional_conversation(request: Optional[bungieapi.generated.components.schemas.groups_v2.GroupOptionalConversationAddRequest], group_id: Optional[int] = None) → bungieapi.generated.components.responses.int64ClientResponse

Add a new optional conversation/chat channel.

Requires admin permissions to the group. Parameters:

group_id: Group ID of the group to edit.

async approve_all_pending(request: Optional[bungieapi.generated.components.schemas.groups_v2.GroupApplicationRequest], group_id: Optional[int] = None) → bungieapi.generated.components.responses.ListOfEntityActionResultClientResponse

Approve all of the pending users for the given group.

Parameters:

group_id: ID of the group.

async approve_pending(request: Optional[bungieapi.generated.components.schemas.groups_v2.GroupApplicationRequest], group_id: Optional[int] = None, membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.booleanClientResponse

Approve the given membershipId to join the group/clan as long as they have applied.

Parameters:

group_id: ID of the group. membership_id: The membership id being approved. membership_type: Membership type of the supplied membership ID.

async approve_pending_for_list(request: Optional[bungieapi.generated.components.schemas.groups_v2.GroupApplicationListRequest], group_id: Optional[int] = None) → bungieapi.generated.components.responses.ListOfEntityActionResultClientResponse

Approve all of the pending users for the given group.

Parameters:

group_id: ID of the group.

async ban_member(request: Optional[bungieapi.generated.components.schemas.groups_v2.GroupBanRequest], group_id: Optional[int] = None, membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.int32ClientResponse

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

Parameters:

group_id: Group ID that has the member to ban. membership_id: Membership ID of the member to ban from the group. membership_type: Membership type of the provided membership ID.

async deny_all_pending(request: Optional[bungieapi.generated.components.schemas.groups_v2.GroupApplicationRequest], group_id: Optional[int] = None) → bungieapi.generated.components.responses.ListOfEntityActionResultClientResponse

Deny all of the pending users for the given group.

Parameters:

group_id: ID of the group.

async deny_pending_for_list(request: Optional[bungieapi.generated.components.schemas.groups_v2.GroupApplicationListRequest], group_id: Optional[int] = None) → bungieapi.generated.components.responses.ListOfEntityActionResultClientResponse

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

Parameters:

group_id: ID of the group.

async edit_clan_banner(request: Optional[bungieapi.generated.components.schemas.groups_v2.ClanBanner], group_id: Optional[int] = None) → bungieapi.generated.components.responses.int32ClientResponse

Edit an existing group’s clan banner.

You must have suitable permissions in the group to perform this operation. All fields are required. Parameters:

group_id: Group ID of the group to edit.

async edit_founder_options(request: Optional[bungieapi.generated.components.schemas.groups_v2.GroupOptionsEditAction], group_id: Optional[int] = None) → bungieapi.generated.components.responses.int32ClientResponse

Edit group options only available to a founder.

You must have suitable permissions in the group to perform this operation. Parameters:

group_id: Group ID of the group to edit.

async edit_group(request: Optional[bungieapi.generated.components.schemas.groups_v2.GroupEditAction], group_id: Optional[int] = None) → bungieapi.generated.components.responses.int32ClientResponse

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. Parameters:

group_id: Group ID of the group to edit.

async edit_group_membership(group_id: Optional[int] = None, membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None, member_type: Optional[bungieapi.generated.components.schemas.groups_v2.RuntimeGroupMemberType] = None) → bungieapi.generated.components.responses.int32ClientResponse

Edit the membership type of a given member.

You must have suitable permissions in the group to perform this operation. Parameters:

group_id: ID of the group to which the member belongs. membership_id: Membership ID to modify. membership_type: Membership type of the provide membership ID. member_type: New membertype for the specified member.

async edit_optional_conversation(request: Optional[bungieapi.generated.components.schemas.groups_v2.GroupOptionalConversationEditRequest], conversation_id: Optional[int] = None, group_id: Optional[int] = None) → bungieapi.generated.components.responses.int64ClientResponse

Edit the settings of an optional conversation/chat channel.

Requires admin permissions to the group. Parameters:

conversation_id: Conversation Id of the channel being edited. group_id: Group ID of the group to edit.

async get_admins_and_founder_of_group(currentpage: Optional[int] = None, group_id: Optional[int] = None) → bungieapi.generated.components.responses.SearchResultOfGroupMemberClientResponse

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

Parameters:

currentpage: Page number (starting with 1). Each page has a fixed size of 50 items per page. group_id: The ID of the group.

async get_available_avatars() → bungieapi.generated.components.responses.DictionaryOfint32AndstringClientResponse

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

async get_available_themes() → bungieapi.generated.components.responses.ListOfGroupThemeClientResponse

Returns a list of all available group themes.

async get_banned_members_of_group(currentpage: Optional[int] = None, group_id: Optional[int] = None) → bungieapi.generated.components.responses.SearchResultOfGroupBanClientResponse

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. Parameters:

currentpage: Page number (starting with 1). Each page has a fixed size of 50 entries. group_id: Group ID whose banned members you are fetching

async get_group(group_id: Optional[int] = None) → bungieapi.generated.components.responses.groups_v2.GroupClientResponse

Get information about a specific group of the given ID.

Parameters:

group_id: Requested group’s id.

async get_group_by_name(group_name: Optional[str] = None, group_type: Optional[bungieapi.generated.components.schemas.groups_v2.GroupType] = None) → bungieapi.generated.components.responses.groups_v2.GroupClientResponse

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

Parameters:

group_name: Exact name of the group to find. group_type: Type of group to find.

async get_group_by_name_v2(request: Optional[bungieapi.generated.components.schemas.groups_v2.GroupNameSearchRequest]) → bungieapi.generated.components.responses.groups_v2.GroupClientResponse

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

The POST version.

async get_group_optional_conversations(group_id: Optional[int] = None) → bungieapi.generated.components.responses.CEListOfGroupOptionalConversationClientResponse

Gets a list of available optional conversation channels and their settings.

Parameters:

group_id: Requested group’s id.

async get_groups_for_member(filter: Optional[bungieapi.generated.components.schemas.groups_v2.GroupsForMemberFilter] = None, group_type: Optional[bungieapi.generated.components.schemas.groups_v2.GroupType] = None, membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.groups_v2.GetGroupsForMemberClientResponse

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

Parameters:

filter: Filter apply to list of joined groups. group_type: Type of group the supplied member founded. membership_id: Membership ID to for which to find founded groups. membership_type: Membership type of the supplied membership ID.

async get_invited_individuals(currentpage: Optional[int] = None, group_id: Optional[int] = None) → bungieapi.generated.components.responses.SearchResultOfGroupMemberApplicationClientResponse

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

Parameters:

currentpage: Page number (starting with 1). Each page has a fixed size of 50 items per page. group_id: ID of the group.

async get_members_of_group(currentpage: Optional[int] = None, group_id: Optional[int] = None, member_type: Optional[bungieapi.generated.components.schemas.groups_v2.RuntimeGroupMemberType] = None, name_search: Optional[str] = None) → bungieapi.generated.components.responses.SearchResultOfGroupMemberClientResponse

Get the list of members in a given group.

Parameters:

currentpage: Page number (starting with 1). Each page has a fixed size of 50 items per page. group_id: The ID of the group. member_type: Filter out other member types. Use None for all members. name_search: The name fragment upon which a search should be executed for members with matching display or unique names.

async get_pending_memberships(currentpage: Optional[int] = None, group_id: Optional[int] = None) → bungieapi.generated.components.responses.SearchResultOfGroupMemberApplicationClientResponse

Get the list of users who are awaiting a decision on their application to join a given group.

Modified to include application info. Parameters:

currentpage: Page number (starting with 1). Each page has a fixed size of 50 items per page. group_id: ID of the group.

async get_potential_groups_for_member(filter: Optional[bungieapi.generated.components.schemas.groups_v2.GroupPotentialMemberStatus] = None, group_type: Optional[bungieapi.generated.components.schemas.groups_v2.GroupType] = None, membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.groups_v2.GroupPotentialMembershipSearchClientResponse

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

Parameters:

filter: Filter apply to list of potential joined groups. group_type: Type of group the supplied member applied. membership_id: Membership ID to for which to find applied groups. membership_type: Membership type of the supplied membership ID.

async get_recommended_groups(create_date_range: Optional[bungieapi.generated.components.schemas.groups_v2.GroupDateRange] = None, group_type: Optional[bungieapi.generated.components.schemas.groups_v2.GroupType] = None) → bungieapi.generated.components.responses.ListOfGroupV2CardClientResponse

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

Parameters:

create_date_range: Requested range in which to pull recommended groups group_type: Type of groups requested

async get_user_clan_invite_setting(m_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.booleanClientResponse

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. Parameters:

m_type: The Destiny membership type of the account we wish to access settings.

async group_search(request: Optional[bungieapi.generated.components.schemas.groups_v2.GroupQuery]) → bungieapi.generated.components.responses.groups_v2.GroupSearchClientResponse

Search for Groups.

async individual_group_invite(request: Optional[bungieapi.generated.components.schemas.groups_v2.GroupApplicationRequest], group_id: Optional[int] = None, membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.groups_v2.GroupApplicationClientResponse

Invite a user to join this group.

Parameters:

group_id: ID of the group you would like to join. membership_id: Membership id of the account being invited. membership_type: MembershipType of the account being invited.

async individual_group_invite_cancel(group_id: Optional[int] = None, membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.groups_v2.GroupApplicationClientResponse

Cancels a pending invitation to join a group.

Parameters:

group_id: ID of the group you would like to join. membership_id: Membership id of the account being cancelled. membership_type: MembershipType of the account being cancelled.

async kick_member(group_id: Optional[int] = None, membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.groups_v2.GroupMemberLeaveResultClientResponse

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. Parameters:

group_id: Group ID to kick the user from. membership_id: Membership ID to kick. membership_type: Membership type of the provided membership ID.

async recover_group_for_founder(group_type: Optional[bungieapi.generated.components.schemas.groups_v2.GroupType] = None, membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.groups_v2.GroupMembershipSearchClientResponse

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

group_type: Type of group the supplied member founded. membership_id: Membership ID to for which to find founded groups. membership_type: Membership type of the supplied membership ID.

async unban_member(group_id: Optional[int] = None, membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.int32ClientResponse

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

Parameters:

membership_id: Membership ID of the member to unban from the group membership_type: Membership type of the provided membership ID.

bungieapi.generated.clients.root module

class bungieapi.generated.clients.root.Client(session: aiohttp.client.ClientSession, path: str)

Bases: bungieapi.base.BaseClient

property app: bungieapi.generated.clients.app.Client

property community_content: bungieapi.generated.clients.community_content.Client

property content: bungieapi.generated.clients.content.Client

property destiny2: bungieapi.generated.clients.destiny2.Client

property fireteam: bungieapi.generated.clients.fireteam.Client

property forum: bungieapi.generated.clients.forum.Client

async get_available_locales() → bungieapi.generated.components.responses.CEDictionaryOfstringAndstringClientResponse

List of available localization cultures.

async get_common_settings() → bungieapi.generated.components.responses.common.models.CoreSettingsConfigurationClientResponse

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

async get_global_alerts(includestreaming: Optional[bool] = None) → bungieapi.generated.components.responses.CEListOfGlobalAlertClientResponse

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

Usually used for DOC alerts. Parameters:

includestreaming: Determines whether Streaming Alerts are included in results

async get_user_system_overrides() → bungieapi.generated.components.responses.DictionaryOfstringAndCoreSystemClientResponse

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

property group_v2: bungieapi.generated.clients.group_v2.Client

property social: bungieapi.generated.clients.social.Client

property tokens: bungieapi.generated.clients.tokens.Client

property trending: bungieapi.generated.clients.trending.Client

property user: bungieapi.generated.clients.user.Client

bungieapi.generated.clients.social module

class bungieapi.generated.clients.social.Client(session: aiohttp.client.ClientSession, path: str)

Bases: bungieapi.base.BaseClient

async accept_friend_request(membership_id: Optional[str] = None) → bungieapi.generated.components.responses.booleanClientResponse

Accepts a friend relationship with the target user.

The user must be on your incoming friend request list, though no error will occur if they are not. Parameters:

membership_id: The membership id of the user you wish to accept.

async decline_friend_request(membership_id: Optional[str] = None) → bungieapi.generated.components.responses.booleanClientResponse

Declines a friend relationship with the target user.

The user must be on your incoming friend request list, though no error will occur if they are not. Parameters:

membership_id: The membership id of the user you wish to decline.

async get_friend_list() → bungieapi.generated.components.responses.social.friends.BungieFriendListClientResponse

Returns your Bungie Friend list.

async get_friend_request_list() → bungieapi.generated.components.responses.social.friends.BungieFriendRequestListClientResponse

Returns your friend request queue.

async get_platform_friend_list(friend_platform: Optional[bungieapi.generated.components.schemas.social.friends.PlatformFriendType] = None, page: Optional[str] = None) → bungieapi.generated.components.responses.social.friends.PlatformFriendClientResponse

Gets the platform friend of the requested type, with additional information if they have Bungie accounts.

Must have a recent login session with said platform. Parameters:

friend_platform: The platform friend type. page: The zero based page to return. Page size is 100.

async issue_friend_request(membership_id: Optional[str] = None) → bungieapi.generated.components.responses.booleanClientResponse

Requests a friend relationship with the target user.

Any of the target user’s linked membership ids are valid inputs. Parameters:

membership_id: The membership id of the user you wish to add.

async remove_friend(membership_id: Optional[str] = None) → bungieapi.generated.components.responses.booleanClientResponse

Remove a friend relationship with the target user.

The user must be on your friend list, though no error will occur if they are not. Parameters:

membership_id: The membership id of the user you wish to remove.

async remove_friend_request(membership_id: Optional[str] = None) → bungieapi.generated.components.responses.booleanClientResponse

Remove a friend relationship with the target user.

The user must be on your outgoing request friend list, though no error will occur if they are not. Parameters:

membership_id: The membership id of the user you wish to remove.

bungieapi.generated.clients.tokens module

class bungieapi.generated.clients.tokens.Client(session: aiohttp.client.ClientSession, path: str)

Bases: bungieapi.base.BaseClient

async apply_missing_partner_offers_without_claim(partner_application_id: Optional[int] = None, target_bnet_membership_id: Optional[int] = None) → bungieapi.generated.components.responses.booleanClientResponse

Apply a partner offer to the targeted user.

This endpoint does not claim a new offer, but any already claimed offers will be applied to the game if not already. Parameters:

partner_application_id: The partner application identifier. target_bnet_membership_id: The bungie.net user to apply missing offers to. If not self, elevated permissions are required.

async claim_partner_offer(request: Optional[bungieapi.generated.components.schemas.tokens.PartnerOfferClaimRequest]) → bungieapi.generated.components.responses.booleanClientResponse

Claim a partner offer as the authenticated user.

async get_partner_offer_sku_history(partner_application_id: Optional[int] = None, target_bnet_membership_id: Optional[int] = None) → bungieapi.generated.components.responses.CEListOfPartnerOfferSkuHistoryClientResponse

Returns the partner sku and offer history of the targeted user.

Elevated permissions are required to see users that are not yourself. Parameters:

partner_application_id: The partner application identifier. target_bnet_membership_id: The bungie.net user to apply missing offers to. If not self, elevated permissions are required.

bungieapi.generated.clients.trending module

class bungieapi.generated.clients.trending.Client(session: aiohttp.client.ClientSession, path: str)

Bases: bungieapi.base.BaseClient

async get_trending_categories() → bungieapi.generated.components.responses.trending.TrendingCategoriesClientResponse

Returns trending items for Bungie.net, collapsed into the first page of items per category.

For pagination within a category, call GetTrendingCategory.

async get_trending_category(category_id: Optional[str] = None, page_number: Optional[int] = None) → bungieapi.generated.components.responses.SearchResultOfTrendingEntryClientResponse

Returns paginated lists of trending items for a category.

Parameters:

category_id: The ID of the category for whom you want additional results. page_number: The page # of results to return.

async get_trending_entry_detail(identifier: Optional[str] = None, trending_entry_type: Optional[bungieapi.generated.components.schemas.trending.TrendingEntryType] = None) → bungieapi.generated.components.responses.trending.TrendingDetailClientResponse

Returns the detailed results for a specific trending entry.

Note that trending entries are uniquely identified by a combination of both the TrendingEntryType and the identifier: the identifier alone is not guaranteed to be globally unique. Parameters:

identifier: The identifier for the entity to be returned. trending_entry_type: The type of entity to be returned.

bungieapi.generated.clients.user module

class bungieapi.generated.clients.user.Client(session: aiohttp.client.ClientSession, path: str)

Bases: bungieapi.base.BaseClient

async get_available_themes() → bungieapi.generated.components.responses.ListOfUserThemeClientResponse

Returns a list of all available user themes.

async get_bungie_net_user_by_id(id: Optional[int] = None) → bungieapi.generated.components.responses.user.GeneralUserClientResponse

Loads a bungienet user by membership id.

Parameters:

id: The requested Bungie.net membership id.

async get_credential_types_for_target_account(membership_id: Optional[int] = None) → bungieapi.generated.components.responses.ListOfGetCredentialTypesForAccountClientResponse

Returns a list of credential types attached to the requested account Parameters:

membership_id: The user’s membership id

async get_membership_data_by_id(membership_id: Optional[int] = None, membership_type: Optional[bungieapi.generated.components.schemas.BungieMembershipType] = None) → bungieapi.generated.components.responses.user.UserMembershipDataClientResponse

Returns a list of accounts associated with the supplied membership ID and membership type.

This will include all linked accounts (even when hidden) if supplied credentials permit it. Parameters:

membership_id: The membership ID of the target user. membership_type: Type of the supplied membership ID.

async get_membership_data_for_current_user() → bungieapi.generated.components.responses.user.UserMembershipDataClientResponse

Returns a list of accounts associated with signed in user.

This is useful for OAuth implementations that do not give you access to the token response.

async get_membership_from_hard_linked_credential(credential: Optional[str] = None, cr_type: Optional[bungieapi.generated.components.schemas.BungieCredentialType] = None) → bungieapi.generated.components.responses.user.HardLinkedUserMembershipClientResponse

Gets any hard linked membership given a credential.

Only works for credentials that are public (just SteamID64 right now). Cross Save aware. Parameters:

credential: The credential to look up. Must be a valid SteamID64. cr_type: The credential type. ‘SteamId’ is the only valid value at present.

async search_by_global_name_post(request: Optional[bungieapi.generated.components.schemas.user.UserSearchPrefixRequest], page: Optional[int] = None) → bungieapi.generated.components.responses.user.UserSearchClientResponse

Given the prefix of a global display name, returns all users who share that name.

Parameters:

page: The zero-based page of results you desire.

async search_by_global_name_prefix(display_name_prefix: Optional[str] = None, page: Optional[int] = None) → bungieapi.generated.components.responses.user.UserSearchClientResponse

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

Parameters:

display_name_prefix: The display name prefix you’re looking for. page: The zero-based page of results you desire.

Module contents