HTTP Client

Singleton

This is a singleton, so simply import this wherever you need to do API calls.

This is used for all raw http communication with the bungie.net api, since it implements correct rate limiting and error handling.

HttpClient

Bases: AllRouteHttpRequests, AuthHttpRequests, ClientMixin, Singleton

The singleton http client doing all communication with bungie

Attributes:

Name	Type	Description
bungie_headers		Headers to use for bungie requests
bungie_auth_headers		Headers to use for bungie auth requests
max_attempts		Max retries before failure

Source code in src/bungio/http/client.py

@custom_define(init=False)
class HttpClient(AllRouteHttpRequests, AuthHttpRequests, ClientMixin, Singleton):
    """
    The singleton http client doing all communication with bungie

    Attributes:
        bungie_headers: Headers to use for bungie requests
        bungie_auth_headers: Headers to use for bungie auth requests
        max_attempts: Max retries before failure
    """

    _bungie_headers: dict[str, str] = custom_field()
    _bungie_auth_headers: dict[str, str] = custom_field()
    _max_attempts: int = custom_field(default=5)

    ratelimiter: RateLimiter = custom_field(init=False, default=RateLimiter())
    semaphore: Semaphore = custom_field(init=False, default=Semaphore(100))
    _session: "CachedSession | ClientSession" = custom_field(init=False, default=None)

    _initialised: bool = custom_field(init=False, default=False)

    def __init__(self, *args, **kwargs):
        if not getattr(self, "_initialised", False):
            self.__attrs_init__(*args, **kwargs)
        self._initialised = True

    def __del__(self):
        # clean up the session
        if self._session is not None:
            # noinspection PyProtectedMember
            self._session._connector.close()

    @property
    def session(self) -> "CachedSession | ClientSession":
        """Get the aiohttp session"""

        if not self._session:
            self.__setup_session()
        return self._session

    async def request(self, route: Route) -> dict:
        """
        Handle all web requests.

        Args:
            route: The route / method / params the request should have

        Raises:
            NotFound: 404 request
            BadRequest: 400 request
            InvalidAuthentication: If authentication is invalid
            TimeoutException: If no connection could be made
            BungieDead: Servers are down
            AuthenticationTooSlow: The authentication key has expired
            BungieException: Relaying the bungie error

        Returns:
            The json response
        """

        # make sure all is set up
        if not hasattr(self, "_client"):
            raise ValueError("You have to instantiate the `bungio.Client` before using this")

        headers = self._bungie_headers if not route.auth else await self._get_auth_headers(auth=route.auth)

        async with self.semaphore:
            return await self._request(
                route=route.path,
                method=route.method,
                headers=headers,
                params=route.params,
                data=route.data,
                auth=route.auth,
                use_ratelimiter=True,
            )

    async def _request(
        self,
        route: str,
        method: str,
        headers: dict,
        params: Optional[dict] = None,
        data: Optional[dict | list] = None,
        form_data: Optional[dict] = None,
        auth: Optional[AuthData] = None,
        use_ratelimiter: bool = True,
    ) -> dict:
        """
        Internal request function. Use HttpClient.request() instead!

        Args:
            route: The route
            method: The method
            headers: The headers
            params: The query params
            data: The body data
            form_data: The form data
            use_ratelimiter: If the ratelimiter should be used

        Raises:
            NotFound: 404 request
            BadRequest: 400 request
            InvalidAuthentication: If authentication is invalid
            TimeoutException: If no connection could be made
            BungieDead: Servers are down
            AuthenticationTooSlow: The authentication key has expired
            BungieException: Relaying the bungie error
            _RouteError: Getting redirected to a different url

        Returns:
            The json response.
        """

        route_with_params = f"{route}?{urlencode(params or {})}"

        for attempt in range(self._max_attempts):
            # wait for a token
            if use_ratelimiter:
                await self.ratelimiter.wait_for_token()

            try:
                async with self.session.request(
                    method=method,
                    url=route,
                    headers=headers,
                    params=params,
                    json=data,
                    data=form_data,
                ) as response:
                    self._client.logger.debug(f"[{response.status}] - {route_with_params}")

                    # cached responses do not have the content type field
                    content_type = getattr(response, "content_type", None) or response.headers.get(
                        "Content-Type", "NOT SET"
                    )

                    # get the json
                    content = (
                        await response.json(loads=self._client.json_loads) if "application/json" in content_type else {}
                    )

                    # make sure the response is not None
                    if content.get("Response", MISSING) is None:
                        content["Response"] = {}

                    if not await self._handle_response(
                        route_with_params=route_with_params, response=response, content=content
                    ):
                        continue

                    return content

            except _RouteError as e:
                route = e.route

            except _InvalidAuthentication:
                # noinspection PyProtectedMember
                self._client._invalidate_token(auth=auth)
                raise InvalidAuthentication(auth=auth)

            except (
                asyncio.exceptions.TimeoutError,
                ConnectionResetError,
                ServerDisconnectedError,
                ClientConnectorCertificateError,
                ClientOSError,
            ):
                self._client.logger.debug(
                    f"Retrying... - Timeout error for `{route}?{urlencode({} if params is None else params)}`"
                )
                await asyncio.sleep(2 + attempt * 3)
                continue

        self._client.logger.exception(
            f"{route_with_params}- Aborting. Failed {self._max_attempts} times. Infos: {method=} | {auth=} | {data=} | {form_data=}"
        )
        raise TimeoutException

    async def _handle_response(self, route_with_params: str, response: ClientResponse, content: dict) -> bool:
        """
        Handle the response returned by bungie

        Args:
            route_with_params: The full route for logging’s sake
            response: The response
            content: The json content returned or an empty dict

        Raises:
            NotFound: 404 request
            BadRequest: 400 request
            BungieDead: Servers are down
            AuthenticationTooSlow: The authentication key has expired
            BungieException: Relaying the bungie error
            _InvalidAuthentication: If authentication is invalid
            _RouteError: Getting redirected to a different url

        Returns:
            If the response was OK
        """

        # get the bungie errors from the json
        if (error := content.get("error", None)) is None:
            error = content.get("ErrorStatus", "MISSING")
            error_message = content.get("Message", "MISSING")
        else:
            # auth routes have different error code locations which are undocumented
            error_message = content.get("error_description", "MISSING")
            if error == "server_error":
                error = content.get("error_description", error)

        error_code = content.get("ErrorCode", -1)
        error_data = content.get("MessageData", {})

        match (response.status, error):
            case (_, "SystemDisabled"):
                raise BungieDead

            case (_, "invalid_grant"):
                # unauthorized
                self._client.logger.warning(
                    f"`{response.status} - {error} | {error_code}`: Unauthorized (too slow, user fault) request for `{route_with_params}`\n{content=}"
                )
                raise AuthenticationTooSlow

            case (200, _):
                # make sure we got a json
                if not content:
                    self._client.logger.warning(f"Wrong content type returned text: '{await response.text()}'")
                    await asyncio.sleep(3)
                    return False
                return True

            case (301, _):
                # this is issued with a 301 when bungie is of the opinion that resource this moved
                # just retrying fixes it with the new url fixes it
                new_route = response.headers.get("Location")
                self._client.logger.debug(
                    f"Wrong location, retrying with the correct one: `{response.url}` -> `{new_route}`"
                )
                raise _RouteError(route=new_route)

            case (502, _):
                # bad gateway
                self._client.logger.warning(
                    f"Retrying... - `{response.status}` Bad gateway error for `{route_with_params}`"
                )
                await asyncio.sleep(5)

            case (524, _):
                # cloudflare error, retry
                self._client.logger.warning(
                    f"Retrying... - `{response.status}` Cloudflare error for `{route_with_params}`"
                )
                await asyncio.sleep(2)

            case (429, _) | (_, "PerEndpointRequestThrottleExceeded" | "DestinyDirectBabelClientTimeout"):
                # we are getting throttled (should never be called in theory)
                self._client.logger.warning(
                    f"`{response.status} - {error} | {error_code}`: Retrying... - Getting throttled for `{route_with_params}`\n{content=}"
                )

                throttle_seconds = content["ThrottleSeconds"]

                # reset the ratelimit giver
                self.ratelimiter.tokens = 0
                await asyncio.sleep(max(throttle_seconds, 2))

            case (_, "DestinyDirectBabelClientTimeout"):
                # timeout
                self._client.logger.warning(
                    f"`{response.status} - {error} | {error_code}`: Retrying... - Getting timeouts for `{route_with_params}`\n{content=}"
                )
                await asyncio.sleep(60)

            case (_, "DestinyServiceFailure" | "DestinyInternalError" | "UnhandledException"):
                # timeout
                self._client.logger.warning(
                    f"`{response.status} - {error} | {error_code}`: Retrying... - Bungie is having problems `{route_with_params}`\n{content=}"
                )
                await asyncio.sleep(60)

            case (
                _,
                "AuthorizationRecordRevoked" | "AuthorizationRecordExpired",
            ):
                # users tokens are no longer valid
                raise _InvalidAuthentication()

            case (404, _):
                # not found
                self._client.logger.warning(
                    f"`{response.status} - {error} | {error_code}`: Not found for `{route_with_params}`\n{content=}"
                )

                if error != "MISSING":
                    raise BungieException(error=error, message=error_message, code=error_code, data=error_data)
                else:
                    raise NotFound

            case ((400 | 401), _):
                # generic bad request, such as wrong format
                self._client.logger.warning(
                    f"`{response.status} - {error} | {error_code}`: Generic bad request for `{route_with_params}`\n{content=}"
                )

                if error != "MISSING":
                    raise BungieException(error=error, message=error_message, code=error_code, data=error_data)
                else:
                    raise BadRequest

            case (503, _):
                self._client.logger.warning(
                    f"`{response.status} - {error} | {error_code}`: Retrying... - Server is overloaded for `{route_with_params}`\n{content=}"
                )
                await asyncio.sleep(10)

            case (status, _):
                # retry if we didn't get an error message
                retry = error == "Success"

                # catch the rest
                self._client.logger.warning(
                    f"`{status} - {error} | {error_code}` - Request failed for `{route_with_params}` - `{error_message}`"
                )

                if retry:
                    await asyncio.sleep(2)
                else:
                    raise BungieException(error=error, message=error_message, code=error_code, data=error_data)

        return False

    async def _get_auth_headers(self, auth: AuthData) -> dict:
        """
        Update the auth headers to include a working token. Raise an error if that doesn't exist

        Args:
            auth: The potentially old authentication info.

        Raises:
            InvalidAuthentication: If authentication is invalid

        Returns:
            User specific headers
        """

        headers = self._bungie_headers.copy()

        # get a working token or abort
        await self._client.get_working_auth(auth=auth)

        headers.update(
            {
                "Authorization": f"Bearer {auth.token}",
            }
        )

        return headers

    def __setup_session(self) -> None:
        """
        Sets up the session to use for http requests
        """

        try:
            from aiohttp_client_cache import CachedSession

            self._session = CachedSession(
                json_serialize=self._client.json_dumps, cookie_jar=DummyCookieJar(), cache=self._client.cache
            )
        except ModuleNotFoundError:
            self._session = ClientSession(json_serialize=self._client.json_dumps, cookie_jar=DummyCookieJar())

session property

Get the aiohttp session

__setup_session()

Sets up the session to use for http requests

Source code in src/bungio/http/client.py

def __setup_session(self) -> None:
    """
    Sets up the session to use for http requests
    """

    try:
        from aiohttp_client_cache import CachedSession

        self._session = CachedSession(
            json_serialize=self._client.json_dumps, cookie_jar=DummyCookieJar(), cache=self._client.cache
        )
    except ModuleNotFoundError:
        self._session = ClientSession(json_serialize=self._client.json_dumps, cookie_jar=DummyCookieJar())

_get_auth_headers(auth) async

Update the auth headers to include a working token. Raise an error if that doesn't exist

Parameters:

Name	Type	Description	Default
auth	AuthData	The potentially old authentication info.	required

Raises:

Type	Description
InvalidAuthentication	If authentication is invalid

Returns:

Type	Description
dict	User specific headers

Source code in src/bungio/http/client.py

async def _get_auth_headers(self, auth: AuthData) -> dict:
    """
    Update the auth headers to include a working token. Raise an error if that doesn't exist

    Args:
        auth: The potentially old authentication info.

    Raises:
        InvalidAuthentication: If authentication is invalid

    Returns:
        User specific headers
    """

    headers = self._bungie_headers.copy()

    # get a working token or abort
    await self._client.get_working_auth(auth=auth)

    headers.update(
        {
            "Authorization": f"Bearer {auth.token}",
        }
    )

    return headers

_handle_response(route_with_params, response, content) async

Handle the response returned by bungie

Parameters:

Name	Type	Description	Default
route_with_params	str	The full route for logging’s sake	required
response	ClientResponse	The response	required
content	dict	The json content returned or an empty dict	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error
_InvalidAuthentication	If authentication is invalid
_RouteError	Getting redirected to a different url

Returns:

Type	Description
bool	If the response was OK

Source code in src/bungio/http/client.py

async def _handle_response(self, route_with_params: str, response: ClientResponse, content: dict) -> bool:
    """
    Handle the response returned by bungie

    Args:
        route_with_params: The full route for logging’s sake
        response: The response
        content: The json content returned or an empty dict

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error
        _InvalidAuthentication: If authentication is invalid
        _RouteError: Getting redirected to a different url

    Returns:
        If the response was OK
    """

    # get the bungie errors from the json
    if (error := content.get("error", None)) is None:
        error = content.get("ErrorStatus", "MISSING")
        error_message = content.get("Message", "MISSING")
    else:
        # auth routes have different error code locations which are undocumented
        error_message = content.get("error_description", "MISSING")
        if error == "server_error":
            error = content.get("error_description", error)

    error_code = content.get("ErrorCode", -1)
    error_data = content.get("MessageData", {})

    match (response.status, error):
        case (_, "SystemDisabled"):
            raise BungieDead

        case (_, "invalid_grant"):
            # unauthorized
            self._client.logger.warning(
                f"`{response.status} - {error} | {error_code}`: Unauthorized (too slow, user fault) request for `{route_with_params}`\n{content=}"
            )
            raise AuthenticationTooSlow

        case (200, _):
            # make sure we got a json
            if not content:
                self._client.logger.warning(f"Wrong content type returned text: '{await response.text()}'")
                await asyncio.sleep(3)
                return False
            return True

        case (301, _):
            # this is issued with a 301 when bungie is of the opinion that resource this moved
            # just retrying fixes it with the new url fixes it
            new_route = response.headers.get("Location")
            self._client.logger.debug(
                f"Wrong location, retrying with the correct one: `{response.url}` -> `{new_route}`"
            )
            raise _RouteError(route=new_route)

        case (502, _):
            # bad gateway
            self._client.logger.warning(
                f"Retrying... - `{response.status}` Bad gateway error for `{route_with_params}`"
            )
            await asyncio.sleep(5)

        case (524, _):
            # cloudflare error, retry
            self._client.logger.warning(
                f"Retrying... - `{response.status}` Cloudflare error for `{route_with_params}`"
            )
            await asyncio.sleep(2)

        case (429, _) | (_, "PerEndpointRequestThrottleExceeded" | "DestinyDirectBabelClientTimeout"):
            # we are getting throttled (should never be called in theory)
            self._client.logger.warning(
                f"`{response.status} - {error} | {error_code}`: Retrying... - Getting throttled for `{route_with_params}`\n{content=}"
            )

            throttle_seconds = content["ThrottleSeconds"]

            # reset the ratelimit giver
            self.ratelimiter.tokens = 0
            await asyncio.sleep(max(throttle_seconds, 2))

        case (_, "DestinyDirectBabelClientTimeout"):
            # timeout
            self._client.logger.warning(
                f"`{response.status} - {error} | {error_code}`: Retrying... - Getting timeouts for `{route_with_params}`\n{content=}"
            )
            await asyncio.sleep(60)

        case (_, "DestinyServiceFailure" | "DestinyInternalError" | "UnhandledException"):
            # timeout
            self._client.logger.warning(
                f"`{response.status} - {error} | {error_code}`: Retrying... - Bungie is having problems `{route_with_params}`\n{content=}"
            )
            await asyncio.sleep(60)

        case (
            _,
            "AuthorizationRecordRevoked" | "AuthorizationRecordExpired",
        ):
            # users tokens are no longer valid
            raise _InvalidAuthentication()

        case (404, _):
            # not found
            self._client.logger.warning(
                f"`{response.status} - {error} | {error_code}`: Not found for `{route_with_params}`\n{content=}"
            )

            if error != "MISSING":
                raise BungieException(error=error, message=error_message, code=error_code, data=error_data)
            else:
                raise NotFound

        case ((400 | 401), _):
            # generic bad request, such as wrong format
            self._client.logger.warning(
                f"`{response.status} - {error} | {error_code}`: Generic bad request for `{route_with_params}`\n{content=}"
            )

            if error != "MISSING":
                raise BungieException(error=error, message=error_message, code=error_code, data=error_data)
            else:
                raise BadRequest

        case (503, _):
            self._client.logger.warning(
                f"`{response.status} - {error} | {error_code}`: Retrying... - Server is overloaded for `{route_with_params}`\n{content=}"
            )
            await asyncio.sleep(10)

        case (status, _):
            # retry if we didn't get an error message
            retry = error == "Success"

            # catch the rest
            self._client.logger.warning(
                f"`{status} - {error} | {error_code}` - Request failed for `{route_with_params}` - `{error_message}`"
            )

            if retry:
                await asyncio.sleep(2)
            else:
                raise BungieException(error=error, message=error_message, code=error_code, data=error_data)

    return False

_request(route, method, headers, params=None, data=None, form_data=None, auth=None, use_ratelimiter=True) async

Internal request function. Use HttpClient.request() instead!

Parameters:

Name	Type	Description	Default
route	str	The route	required
method	str	The method	required
headers	dict	The headers	required
params	Optional[dict]	The query params	None
data	Optional[dict | list]	The body data	None
form_data	Optional[dict]	The form data	None
use_ratelimiter	bool	If the ratelimiter should be used	True

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error
_RouteError	Getting redirected to a different url

Returns:

Type	Description
dict	The json response.

Source code in src/bungio/http/client.py

async def _request(
    self,
    route: str,
    method: str,
    headers: dict,
    params: Optional[dict] = None,
    data: Optional[dict | list] = None,
    form_data: Optional[dict] = None,
    auth: Optional[AuthData] = None,
    use_ratelimiter: bool = True,
) -> dict:
    """
    Internal request function. Use HttpClient.request() instead!

    Args:
        route: The route
        method: The method
        headers: The headers
        params: The query params
        data: The body data
        form_data: The form data
        use_ratelimiter: If the ratelimiter should be used

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error
        _RouteError: Getting redirected to a different url

    Returns:
        The json response.
    """

    route_with_params = f"{route}?{urlencode(params or {})}"

    for attempt in range(self._max_attempts):
        # wait for a token
        if use_ratelimiter:
            await self.ratelimiter.wait_for_token()

        try:
            async with self.session.request(
                method=method,
                url=route,
                headers=headers,
                params=params,
                json=data,
                data=form_data,
            ) as response:
                self._client.logger.debug(f"[{response.status}] - {route_with_params}")

                # cached responses do not have the content type field
                content_type = getattr(response, "content_type", None) or response.headers.get(
                    "Content-Type", "NOT SET"
                )

                # get the json
                content = (
                    await response.json(loads=self._client.json_loads) if "application/json" in content_type else {}
                )

                # make sure the response is not None
                if content.get("Response", MISSING) is None:
                    content["Response"] = {}

                if not await self._handle_response(
                    route_with_params=route_with_params, response=response, content=content
                ):
                    continue

                return content

        except _RouteError as e:
            route = e.route

        except _InvalidAuthentication:
            # noinspection PyProtectedMember
            self._client._invalidate_token(auth=auth)
            raise InvalidAuthentication(auth=auth)

        except (
            asyncio.exceptions.TimeoutError,
            ConnectionResetError,
            ServerDisconnectedError,
            ClientConnectorCertificateError,
            ClientOSError,
        ):
            self._client.logger.debug(
                f"Retrying... - Timeout error for `{route}?{urlencode({} if params is None else params)}`"
            )
            await asyncio.sleep(2 + attempt * 3)
            continue

    self._client.logger.exception(
        f"{route_with_params}- Aborting. Failed {self._max_attempts} times. Infos: {method=} | {auth=} | {data=} | {form_data=}"
    )
    raise TimeoutException

abdicate_foundership(founder_id_new, group_id, membership_type, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
founder_id_new	int	The new founder for this group. Must already be a group admin.	required
group_id	int	The target group id.	required
membership_type	int	Membership type of the provided founderIdNew.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def abdicate_foundership(
    self, founder_id_new: int, group_id: int, membership_type: int, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    An administrative method to allow the founder of a group or clan to give up their position to another admin permanently.

    Args:
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/GroupV2/{group_id}/Admin/AbdicateFoundership/{membership_type}/{founder_id_new}/",
            method="POST",
            auth=auth,
        )
    )

accept_friend_request(membership_id, auth, *args, **kwargs) async

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.

Requires Authentication.

Required oauth2 scopes: BnetWrite

Parameters:

Name	Type	Description	Default
membership_id	str	The membership id of the user you wish to accept.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/social.py

async def accept_friend_request(self, membership_id: str, auth: AuthData, *args, **kwargs) -> dict:
    """
    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.

    Warning: Requires Authentication.
        Required oauth2 scopes: BnetWrite

    Args:
        membership_id: The membership id of the user you wish to accept.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/Social/Friends/Requests/Accept/{membership_id}/", method="POST", auth=auth)
    )

add_optional_conversation(chat_name, chat_security, group_id, auth, *args, **kwargs) async

Add a new optional conversation/chat channel. Requires admin permissions to the group.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
chat_name	str	No description given by bungie.	required
chat_security	Union[Any, int]	No description given by bungie.	required
group_id	int	Group ID of the group to edit.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def add_optional_conversation(
    self, chat_name: str, chat_security: Union[Any, int], group_id: int, auth: AuthData, *args, **kwargs
) -> dict:
    """
    Add a new optional conversation/chat channel. Requires admin permissions to the group.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        chat_name: _No description given by bungie._
        chat_security: _No description given by bungie._
        group_id: Group ID of the group to edit.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "chatName": chat_name,
        "chatSecurity": chat_security,
    }

    return await self.request(
        Route(path=f"/GroupV2/{group_id}/OptionalConversations/Add/", method="POST", data=data, auth=auth)
    )

apply_missing_partner_offers_without_claim(partner_application_id, target_bnet_membership_id, auth, *args, **kwargs) async

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.

Requires Authentication.

Required oauth2 scopes: PartnerOfferGrant

Parameters:

Name	Type	Description	Default
partner_application_id	int	The partner application identifier.	required
target_bnet_membership_id	int	The bungie.net user to apply missing offers to. If not self, elevated permissions are required.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/tokens.py

async def apply_missing_partner_offers_without_claim(
    self, partner_application_id: int, target_bnet_membership_id: int, auth: AuthData, *args, **kwargs
) -> dict:
    """
    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.

    Warning: Requires Authentication.
        Required oauth2 scopes: PartnerOfferGrant

    Args:
        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.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Tokens/Partner/ApplyMissingOffers/{partner_application_id}/{target_bnet_membership_id}/",
            method="POST",
            auth=auth,
        )
    )

approve_all_pending(message, group_id, auth, *args, **kwargs) async

Approve all of the pending users for the given group.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
message	str	No description given by bungie.	required
group_id	int	ID of the group.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def approve_all_pending(self, message: str, group_id: int, auth: AuthData, *args, **kwargs) -> dict:
    """
    Approve all of the pending users for the given group.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        message: _No description given by bungie._
        group_id: ID of the group.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "message": message,
    }

    return await self.request(
        Route(path=f"/GroupV2/{group_id}/Members/ApproveAll/", method="POST", data=data, auth=auth)
    )

approve_pending(message, group_id, membership_id, membership_type, auth, *args, **kwargs) async

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

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
message	str	No description given by bungie.	required
group_id	int	ID of the group.	required
membership_id	int	The membership id being approved.	required
membership_type	int	Membership type of the supplied membership ID.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def approve_pending(
    self, message: str, group_id: int, membership_id: int, membership_type: int, auth: AuthData, *args, **kwargs
) -> dict:
    """
    Approve the given membershipId to join the group/clan as long as they have applied.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        message: _No description given by bungie._
        group_id: ID of the group.
        membership_id: The membership id being approved.
        membership_type: Membership type of the supplied membership ID.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "message": message,
    }

    return await self.request(
        Route(
            path=f"/GroupV2/{group_id}/Members/Approve/{membership_type}/{membership_id}/",
            method="POST",
            data=data,
            auth=auth,
        )
    )

approve_pending_for_list(memberships, message, group_id, auth, *args, **kwargs) async

Approve all of the pending users for the given group.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
memberships	list[Any]	No description given by bungie.	required
message	str	No description given by bungie.	required
group_id	int	ID of the group.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def approve_pending_for_list(
    self, memberships: list[Any], message: str, group_id: int, auth: AuthData, *args, **kwargs
) -> dict:
    """
    Approve all of the pending users for the given group.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        memberships: _No description given by bungie._
        message: _No description given by bungie._
        group_id: ID of the group.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "memberships": memberships,
        "message": message,
    }

    return await self.request(
        Route(path=f"/GroupV2/{group_id}/Members/ApproveList/", method="POST", data=data, auth=auth)
    )

awa_get_action_token(correlation_id, auth, *args, **kwargs) async

Returns the action token if user approves the request.

Requires Authentication.

Required oauth2 scopes: AdvancedWriteActions

Parameters:

Name	Type	Description	Default
correlation_id	str	The identifier for the advanced write action request.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def awa_get_action_token(self, correlation_id: str, auth: AuthData, *args, **kwargs) -> dict:
    """
    Returns the action token if user approves the request.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdvancedWriteActions

    Args:
        correlation_id: The identifier for the advanced write action request.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/Destiny2/Awa/GetActionToken/{correlation_id}/", method="GET", auth=auth)
    )

awa_initialize_request(type, affected_item_id, membership_type, character_id, auth, *args, **kwargs) async

Initialize a request to perform an advanced write action.

Requires Authentication.

Required oauth2 scopes: AdvancedWriteActions

Parameters:

Name	Type	Description	Default
type	Union[Any, int]	Type of advanced write action.	required
affected_item_id	int	Item instance ID the action shall be applied to. This is optional for all but a new AwaType values. Rule of thumb is to provide the item instance ID if one is available.	required
membership_type	Union[Any, int]	Destiny membership type of the account to modify.	required
character_id	int	Destiny character ID, if applicable, that will be affected by the action.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def awa_initialize_request(
    self,
    type: Union[Any, int],
    affected_item_id: int,
    membership_type: Union[Any, int],
    character_id: int,
    auth: AuthData,
    *args,
    **kwargs,
) -> dict:
    """
    Initialize a request to perform an advanced write action.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdvancedWriteActions

    Args:
        type: Type of advanced write action.
        affected_item_id: Item instance ID the action shall be applied to. This is optional for all but a new AwaType values. Rule of thumb is to provide the item instance ID if one is available.
        membership_type: Destiny membership type of the account to modify.
        character_id: Destiny character ID, if applicable, that will be affected by the action.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "type": type,
        "affectedItemId": affected_item_id,
        "membershipType": membership_type,
        "characterId": character_id,
    }

    return await self.request(Route(path="/Destiny2/Awa/Initialize/", method="POST", data=data, auth=auth))

awa_provide_authorization_result(selection, correlation_id, nonce, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
selection	Union[Any, int]	Indication of the selection the user has made (Approving or rejecting the action)	required
correlation_id	str	Correlation ID of the request	required
nonce	list[int]	Secret nonce received via the PUSH notification.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def awa_provide_authorization_result(
    self,
    selection: Union[Any, int],
    correlation_id: str,
    nonce: list[int],
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Provide the result of the user interaction. Called by the Bungie Destiny App to approve or reject a request.

    Args:
        selection: Indication of the selection the user has made (Approving or rejecting the action)
        correlation_id: Correlation ID of the request
        nonce: Secret nonce received via the PUSH notification.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "selection": selection,
        "correlationId": correlation_id,
        "nonce": nonce,
    }

    return await self.request(
        Route(path="/Destiny2/Awa/AwaProvideAuthorizationResult/", method="POST", data=data, auth=auth)
    )

ban_member(comment, length, group_id, membership_id, membership_type, auth, *args, **kwargs) async

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

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
comment	str	No description given by bungie.	required
length	Union[Any, int]	No description given by bungie.	required
group_id	int	Group ID that has the member to ban.	required
membership_id	int	Membership ID of the member to ban from the group.	required
membership_type	int	Membership type of the provided membership ID.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def ban_member(
    self,
    comment: str,
    length: Union[Any, int],
    group_id: int,
    membership_id: int,
    membership_type: int,
    auth: AuthData,
    *args,
    **kwargs,
) -> dict:
    """
    Bans the requested member from the requested group for the specified period of time.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        comment: _No description given by bungie._
        length: _No description given by bungie._
        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.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "comment": comment,
        "length": length,
    }

    return await self.request(
        Route(
            path=f"/GroupV2/{group_id}/Members/{membership_type}/{membership_id}/Ban/",
            method="POST",
            data=data,
            auth=auth,
        )
    )

claim_partner_offer(partner_offer_id, bungie_net_membership_id, transaction_id, auth, *args, **kwargs) async

Claim a partner offer as the authenticated user.

Requires Authentication.

Required oauth2 scopes: PartnerOfferGrant

Parameters:

Name	Type	Description	Default
partner_offer_id	str	No description given by bungie.	required
bungie_net_membership_id	int	No description given by bungie.	required
transaction_id	str	No description given by bungie.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/tokens.py

async def claim_partner_offer(
    self, partner_offer_id: str, bungie_net_membership_id: int, transaction_id: str, auth: AuthData, *args, **kwargs
) -> dict:
    """
    Claim a partner offer as the authenticated user.

    Warning: Requires Authentication.
        Required oauth2 scopes: PartnerOfferGrant

    Args:
        partner_offer_id: _No description given by bungie._
        bungie_net_membership_id: _No description given by bungie._
        transaction_id: _No description given by bungie._
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "PartnerOfferId": partner_offer_id,
        "BungieNetMembershipId": bungie_net_membership_id,
        "TransactionId": transaction_id,
    }

    return await self.request(Route(path="/Tokens/Partner/ClaimOffer/", method="POST", data=data, auth=auth))

clear_loadout(loadout_index, character_id, membership_type, auth, *args, **kwargs) async

Clear the identifiers and items of a loadout.

Requires Authentication.

Required oauth2 scopes: MoveEquipDestinyItems

Parameters:

Name	Type	Description	Default
loadout_index	int	The index of the loadout for this action request.	required
character_id	int	No description given by bungie.	required
membership_type	Union[Any, int]	No description given by bungie.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def clear_loadout(
    self, loadout_index: int, character_id: int, membership_type: Union[Any, int], auth: AuthData, *args, **kwargs
) -> dict:
    """
    Clear the identifiers and items of a loadout.

    Warning: Requires Authentication.
        Required oauth2 scopes: MoveEquipDestinyItems

    Args:
        loadout_index: The index of the loadout for this action request.
        character_id: _No description given by bungie._
        membership_type: _No description given by bungie._
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "loadoutIndex": loadout_index,
        "characterId": character_id,
        "membershipType": membership_type,
    }

    return await self.request(
        Route(path="/Destiny2/Actions/Loadouts/ClearLoadout/", method="POST", data=data, auth=auth)
    )

decline_friend_request(membership_id, auth, *args, **kwargs) async

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.

Requires Authentication.

Required oauth2 scopes: BnetWrite

Parameters:

Name	Type	Description	Default
membership_id	str	The membership id of the user you wish to decline.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/social.py

async def decline_friend_request(self, membership_id: str, auth: AuthData, *args, **kwargs) -> dict:
    """
    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.

    Warning: Requires Authentication.
        Required oauth2 scopes: BnetWrite

    Args:
        membership_id: The membership id of the user you wish to decline.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/Social/Friends/Requests/Decline/{membership_id}/", method="POST", auth=auth)
    )

deny_all_pending(message, group_id, auth, *args, **kwargs) async

Deny all of the pending users for the given group.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
message	str	No description given by bungie.	required
group_id	int	ID of the group.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def deny_all_pending(self, message: str, group_id: int, auth: AuthData, *args, **kwargs) -> dict:
    """
    Deny all of the pending users for the given group.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        message: _No description given by bungie._
        group_id: ID of the group.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "message": message,
    }

    return await self.request(
        Route(path=f"/GroupV2/{group_id}/Members/DenyAll/", method="POST", data=data, auth=auth)
    )

deny_pending_for_list(memberships, message, group_id, auth, *args, **kwargs) async

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

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
memberships	list[Any]	No description given by bungie.	required
message	str	No description given by bungie.	required
group_id	int	ID of the group.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def deny_pending_for_list(
    self, memberships: list[Any], message: str, group_id: int, auth: AuthData, *args, **kwargs
) -> dict:
    """
    Deny all of the pending users for the given group that match the passed-in .

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        memberships: _No description given by bungie._
        message: _No description given by bungie._
        group_id: ID of the group.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "memberships": memberships,
        "message": message,
    }

    return await self.request(
        Route(path=f"/GroupV2/{group_id}/Members/DenyList/", method="POST", data=data, auth=auth)
    )

edit_clan_banner(decal_id, decal_color_id, decal_background_color_id, gonfalon_id, gonfalon_color_id, gonfalon_detail_id, gonfalon_detail_color_id, group_id, auth, *args, **kwargs) async

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

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
decal_id	int	No description given by bungie.	required
decal_color_id	int	No description given by bungie.	required
decal_background_color_id	int	No description given by bungie.	required
gonfalon_id	int	No description given by bungie.	required
gonfalon_color_id	int	No description given by bungie.	required
gonfalon_detail_id	int	No description given by bungie.	required
gonfalon_detail_color_id	int	No description given by bungie.	required
group_id	int	Group ID of the group to edit.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def edit_clan_banner(
    self,
    decal_id: int,
    decal_color_id: int,
    decal_background_color_id: int,
    gonfalon_id: int,
    gonfalon_color_id: int,
    gonfalon_detail_id: int,
    gonfalon_detail_color_id: int,
    group_id: int,
    auth: AuthData,
    *args,
    **kwargs,
) -> dict:
    """
    Edit an existing group's clan banner. You must have suitable permissions in the group to perform this operation. All fields are required.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        decal_id: _No description given by bungie._
        decal_color_id: _No description given by bungie._
        decal_background_color_id: _No description given by bungie._
        gonfalon_id: _No description given by bungie._
        gonfalon_color_id: _No description given by bungie._
        gonfalon_detail_id: _No description given by bungie._
        gonfalon_detail_color_id: _No description given by bungie._
        group_id: Group ID of the group to edit.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "decalId": decal_id,
        "decalColorId": decal_color_id,
        "decalBackgroundColorId": decal_background_color_id,
        "gonfalonId": gonfalon_id,
        "gonfalonColorId": gonfalon_color_id,
        "gonfalonDetailId": gonfalon_detail_id,
        "gonfalonDetailColorId": gonfalon_detail_color_id,
    }

    return await self.request(
        Route(path=f"/GroupV2/{group_id}/EditClanBanner/", method="POST", data=data, auth=auth)
    )

edit_founder_options(invite_permission_override, update_culture_permission_override, host_guided_game_permission_override, update_banner_permission_override, join_level, group_id, auth, *args, **kwargs) async

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

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
invite_permission_override	bool	Minimum Member Level allowed to invite new members to group Always Allowed: Founder, Acting Founder True means admins have this power, false means they don't Default is false for clans, true for groups.	required
update_culture_permission_override	bool	Minimum Member Level allowed to update group culture Always Allowed: Founder, Acting Founder True means admins have this power, false means they don't Default is false for clans, true for groups.	required
host_guided_game_permission_override	Union[Any, int]	Minimum Member Level allowed to host guided games Always Allowed: Founder, Acting Founder, Admin Allowed Overrides: None, Member, Beginner Default is Member for clans, None for groups, although this means nothing for groups.	required
update_banner_permission_override	bool	Minimum Member Level allowed to update banner Always Allowed: Founder, Acting Founder True means admins have this power, false means they don't Default is false for clans, true for groups.	required
join_level	Union[Any, int]	Level to join a member at when accepting an invite, application, or joining an open clan Default is Beginner.	required
group_id	int	Group ID of the group to edit.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def edit_founder_options(
    self,
    invite_permission_override: bool,
    update_culture_permission_override: bool,
    host_guided_game_permission_override: Union[Any, int],
    update_banner_permission_override: bool,
    join_level: Union[Any, int],
    group_id: int,
    auth: AuthData,
    *args,
    **kwargs,
) -> dict:
    """
    Edit group options only available to a founder. You must have suitable permissions in the group to perform this operation.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        invite_permission_override: Minimum Member Level allowed to invite new members to group Always Allowed: Founder, Acting Founder True means admins have this power, false means they don't Default is false for clans, true for groups.
        update_culture_permission_override: Minimum Member Level allowed to update group culture Always Allowed: Founder, Acting Founder True means admins have this power, false means they don't Default is false for clans, true for groups.
        host_guided_game_permission_override: Minimum Member Level allowed to host guided games Always Allowed: Founder, Acting Founder, Admin Allowed Overrides: None, Member, Beginner Default is Member for clans, None for groups, although this means nothing for groups.
        update_banner_permission_override: Minimum Member Level allowed to update banner Always Allowed: Founder, Acting Founder True means admins have this power, false means they don't Default is false for clans, true for groups.
        join_level: Level to join a member at when accepting an invite, application, or joining an open clan Default is Beginner.
        group_id: Group ID of the group to edit.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "InvitePermissionOverride": invite_permission_override,
        "UpdateCulturePermissionOverride": update_culture_permission_override,
        "HostGuidedGamePermissionOverride": host_guided_game_permission_override,
        "UpdateBannerPermissionOverride": update_banner_permission_override,
        "JoinLevel": join_level,
    }

    return await self.request(
        Route(path=f"/GroupV2/{group_id}/EditFounderOptions/", method="POST", data=data, auth=auth)
    )

edit_group(name, about, motto, theme, avatar_image_index, tags, is_public, membership_option, is_public_topic_admin_only, allow_chat, chat_security, callsign, locale, homepage, enable_invitation_messaging_for_admins, default_publicity, group_id, auth, *args, **kwargs) async

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.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
name	str	No description given by bungie.	required
about	str	No description given by bungie.	required
motto	str	No description given by bungie.	required
theme	str	No description given by bungie.	required
avatar_image_index	int	No description given by bungie.	required
tags	str	No description given by bungie.	required
is_public	bool	No description given by bungie.	required
membership_option	Union[Any, int]	No description given by bungie.	required
is_public_topic_admin_only	bool	No description given by bungie.	required
allow_chat	bool	No description given by bungie.	required
chat_security	Union[Any, int]	No description given by bungie.	required
callsign	str	No description given by bungie.	required
locale	str	No description given by bungie.	required
homepage	Union[Any, int]	No description given by bungie.	required
enable_invitation_messaging_for_admins	bool	No description given by bungie.	required
default_publicity	Union[Any, int]	No description given by bungie.	required
group_id	int	Group ID of the group to edit.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def edit_group(
    self,
    name: str,
    about: str,
    motto: str,
    theme: str,
    avatar_image_index: int,
    tags: str,
    is_public: bool,
    membership_option: Union[Any, int],
    is_public_topic_admin_only: bool,
    allow_chat: bool,
    chat_security: Union[Any, int],
    callsign: str,
    locale: str,
    homepage: Union[Any, int],
    enable_invitation_messaging_for_admins: bool,
    default_publicity: Union[Any, int],
    group_id: int,
    auth: AuthData,
    *args,
    **kwargs,
) -> dict:
    """
    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.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        name: _No description given by bungie._
        about: _No description given by bungie._
        motto: _No description given by bungie._
        theme: _No description given by bungie._
        avatar_image_index: _No description given by bungie._
        tags: _No description given by bungie._
        is_public: _No description given by bungie._
        membership_option: _No description given by bungie._
        is_public_topic_admin_only: _No description given by bungie._
        allow_chat: _No description given by bungie._
        chat_security: _No description given by bungie._
        callsign: _No description given by bungie._
        locale: _No description given by bungie._
        homepage: _No description given by bungie._
        enable_invitation_messaging_for_admins: _No description given by bungie._
        default_publicity: _No description given by bungie._
        group_id: Group ID of the group to edit.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "name": name,
        "about": about,
        "motto": motto,
        "theme": theme,
        "avatarImageIndex": avatar_image_index,
        "tags": tags,
        "isPublic": is_public,
        "membershipOption": membership_option,
        "isPublicTopicAdminOnly": is_public_topic_admin_only,
        "allowChat": allow_chat,
        "chatSecurity": chat_security,
        "callsign": callsign,
        "locale": locale,
        "homepage": homepage,
        "enableInvitationMessagingForAdmins": enable_invitation_messaging_for_admins,
        "defaultPublicity": default_publicity,
    }

    return await self.request(Route(path=f"/GroupV2/{group_id}/Edit/", method="POST", data=data, auth=auth))

edit_group_membership(group_id, membership_id, membership_type, member_type, auth, *args, **kwargs) async

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

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
group_id	int	ID of the group to which the member belongs.	required
membership_id	int	Membership ID to modify.	required
membership_type	int	Membership type of the provide membership ID.	required
member_type	int	New membertype for the specified member.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def edit_group_membership(
    self, group_id: int, membership_id: int, membership_type: int, member_type: int, auth: AuthData, *args, **kwargs
) -> dict:
    """
    Edit the membership type of a given member. You must have suitable permissions in the group to perform this operation.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        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.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/GroupV2/{group_id}/Members/{membership_type}/{membership_id}/SetMembershipType/{member_type}/",
            method="POST",
            auth=auth,
        )
    )

edit_optional_conversation(chat_enabled, chat_name, chat_security, conversation_id, group_id, auth, *args, **kwargs) async

Edit the settings of an optional conversation/chat channel. Requires admin permissions to the group.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
chat_enabled	bool	No description given by bungie.	required
chat_name	str	No description given by bungie.	required
chat_security	Union[Any, int]	No description given by bungie.	required
conversation_id	int	Conversation Id of the channel being edited.	required
group_id	int	Group ID of the group to edit.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def edit_optional_conversation(
    self,
    chat_enabled: bool,
    chat_name: str,
    chat_security: Union[Any, int],
    conversation_id: int,
    group_id: int,
    auth: AuthData,
    *args,
    **kwargs,
) -> dict:
    """
    Edit the settings of an optional conversation/chat channel. Requires admin permissions to the group.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        chat_enabled: _No description given by bungie._
        chat_name: _No description given by bungie._
        chat_security: _No description given by bungie._
        conversation_id: Conversation Id of the channel being edited.
        group_id: Group ID of the group to edit.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "chatEnabled": chat_enabled,
        "chatName": chat_name,
        "chatSecurity": chat_security,
    }

    return await self.request(
        Route(
            path=f"/GroupV2/{group_id}/OptionalConversations/Edit/{conversation_id}/",
            method="POST",
            data=data,
            auth=auth,
        )
    )

equip_item(item_id, character_id, membership_type, auth, *args, **kwargs) async

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

Requires Authentication.

Required oauth2 scopes: MoveEquipDestinyItems

Parameters:

Name	Type	Description	Default
item_id	int	The instance ID of the item for this action request.	required
character_id	int	No description given by bungie.	required
membership_type	Union[Any, int]	No description given by bungie.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def equip_item(
    self, item_id: int, character_id: int, membership_type: Union[Any, int], auth: AuthData, *args, **kwargs
) -> dict:
    """
    Equip an item. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline.

    Warning: Requires Authentication.
        Required oauth2 scopes: MoveEquipDestinyItems

    Args:
        item_id: The instance ID of the item for this action request.
        character_id: _No description given by bungie._
        membership_type: _No description given by bungie._
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "itemId": item_id,
        "characterId": character_id,
        "membershipType": membership_type,
    }

    return await self.request(Route(path="/Destiny2/Actions/Items/EquipItem/", method="POST", data=data, auth=auth))

equip_items(item_ids, character_id, membership_type, auth, *args, **kwargs) async

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.

Requires Authentication.

Required oauth2 scopes: MoveEquipDestinyItems

Parameters:

Name	Type	Description	Default
item_ids	list[int]	No description given by bungie.	required
character_id	int	No description given by bungie.	required
membership_type	Union[Any, int]	No description given by bungie.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def equip_items(
    self, item_ids: list[int], character_id: int, membership_type: Union[Any, int], auth: AuthData, *args, **kwargs
) -> dict:
    """
    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.

    Warning: Requires Authentication.
        Required oauth2 scopes: MoveEquipDestinyItems

    Args:
        item_ids: _No description given by bungie._
        character_id: _No description given by bungie._
        membership_type: _No description given by bungie._
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "itemIds": item_ids,
        "characterId": character_id,
        "membershipType": membership_type,
    }

    return await self.request(
        Route(path="/Destiny2/Actions/Items/EquipItems/", method="POST", data=data, auth=auth)
    )

equip_loadout(loadout_index, character_id, membership_type, auth, *args, **kwargs) async

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

Requires Authentication.

Required oauth2 scopes: MoveEquipDestinyItems

Parameters:

Name	Type	Description	Default
loadout_index	int	The index of the loadout for this action request.	required
character_id	int	No description given by bungie.	required
membership_type	Union[Any, int]	No description given by bungie.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def equip_loadout(
    self, loadout_index: int, character_id: int, membership_type: Union[Any, int], auth: AuthData, *args, **kwargs
) -> dict:
    """
    Equip a loadout. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline.

    Warning: Requires Authentication.
        Required oauth2 scopes: MoveEquipDestinyItems

    Args:
        loadout_index: The index of the loadout for this action request.
        character_id: _No description given by bungie._
        membership_type: _No description given by bungie._
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "loadoutIndex": loadout_index,
        "characterId": character_id,
        "membershipType": membership_type,
    }

    return await self.request(
        Route(path="/Destiny2/Actions/Loadouts/EquipLoadout/", method="POST", data=data, auth=auth)
    )

force_drops_repair(auth, *args, **kwargs) async

Twitch Drops self-repair function - scans twitch for drops not marked as fulfilled and resyncs them.

Requires Authentication.

Required oauth2 scopes: PartnerOfferGrant

Parameters:

Name	Type	Description	Default
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/tokens.py

async def force_drops_repair(self, auth: AuthData, *args, **kwargs) -> dict:
    """
    Twitch Drops self-repair function - scans twitch for drops not marked as fulfilled and resyncs them.

    Warning: Requires Authentication.
        Required oauth2 scopes: PartnerOfferGrant

    Args:
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path="/Tokens/Partner/ForceDropsRepair/", method="POST", auth=auth))

get_active_private_clan_fireteam_count(group_id, auth, *args, **kwargs) async

Gets a count of all active non-public fireteams for the specified clan. Maximum value returned is 25.

Requires Authentication.

Required oauth2 scopes: ReadGroups

Parameters:

Name	Type	Description	Default
group_id	int	The group id of the clan.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/fireteam.py

async def get_active_private_clan_fireteam_count(self, group_id: int, auth: AuthData, *args, **kwargs) -> dict:
    """
    Gets a count of all active non-public fireteams for the specified clan. Maximum value returned is 25.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadGroups

    Args:
        group_id: The group id of the clan.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path=f"/Fireteam/Clan/{group_id}/ActiveCount/", method="GET", auth=auth))

get_activity_history(character_id, destiny_membership_id, membership_type, count=None, mode=None, page=None, auth=None, *args, **kwargs) async

Gets activity history stats for indicated character.

Parameters:

Name	Type	Description	Default
character_id	int	The id of the character to retrieve.	required
destiny_membership_id	int	The Destiny membershipId of the user to retrieve.	required
membership_type	int	A valid non-BungieNet membership type.	required
count	Optional[int]	Number of rows to return	None
mode	Optional[int]	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.	None
page	Optional[int]	Page number to return, starting with 0.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_activity_history(
    self,
    character_id: int,
    destiny_membership_id: int,
    membership_type: int,
    count: Optional[int] = None,
    mode: Optional[int] = None,
    page: Optional[int] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Gets activity history stats for indicated character.

    Args:
        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.
        count: Number of rows to return
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Destiny2/{membership_type}/Account/{destiny_membership_id}/Character/{character_id}/Stats/Activities/",
            method="GET",
            count=count,
            mode=mode,
            page=page,
            auth=auth,
        )
    )

get_admins_and_founder_of_group(currentpage, group_id, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
currentpage	int	Page number (starting with 1). Each page has a fixed size of 50 items per page.	required
group_id	int	The ID of the group.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def get_admins_and_founder_of_group(
    self, currentpage: int, group_id: int, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Get the list of members in a given group who are of admin level or higher.

    Args:
        currentpage: Page number (starting with 1). Each page has a fixed size of 50 items per page.
        group_id: The ID of the group.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path=f"/GroupV2/{group_id}/AdminsAndFounder/", method="GET", auth=auth))

get_application_api_usage(application_id, auth, end=None, start=None, *args, **kwargs) async

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.

Requires Authentication.

Required oauth2 scopes: ReadUserData

Parameters:

Name	Type	Description	Default
application_id	int	ID of the application to get usage statistics.	required
auth	AuthData	Authentication information.	required
end	Optional[datetime]	End time for query. Goes to now if not specified.	None
start	Optional[datetime]	Start time for query. Goes to 24 hours ago if not specified.	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/app.py

async def get_application_api_usage(
    self,
    application_id: int,
    auth: AuthData,
    end: Optional[datetime] = None,
    start: Optional[datetime] = None,
    *args,
    **kwargs,
) -> dict:
    """
    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.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadUserData

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

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/App/ApiUsage/{application_id}/", method="GET", auth=auth, end=end, start=start)
    )

get_available_avatars(auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def get_available_avatars(self, auth: Optional[AuthData] = None, *args, **kwargs) -> dict:
    """
    Returns a list of all available group avatars for the signed-in user.

    Args:
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path="/GroupV2/GetAvailableAvatars/", method="GET", auth=auth))

get_available_clan_fireteams(activity_type, date_range, group_id, page, platform, public_only, slot_filter, auth, exclude_immediate=None, lang_filter=None, *args, **kwargs) async

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.

Requires Authentication.

Required oauth2 scopes: ReadGroups

Parameters:

Name	Type	Description	Default
activity_type	int	The activity type to filter by.	required
date_range	int	The date range to grab available fireteams.	required
group_id	int	The group id of the clan.	required
page	int	Zero based page	required
platform	int	The platform filter.	required
public_only	int	Determines public/private filtering.	required
slot_filter	int	Filters based on available slots	required
auth	AuthData	Authentication information.	required
exclude_immediate	Optional[bool]	If you wish the result to exclude immediate fireteams, set this to true. Immediate-only can be forced using the dateRange enum.	None
lang_filter	Optional[str]	An optional language filter.	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/fireteam.py

async def get_available_clan_fireteams(
    self,
    activity_type: int,
    date_range: int,
    group_id: int,
    page: int,
    platform: int,
    public_only: int,
    slot_filter: int,
    auth: AuthData,
    exclude_immediate: Optional[bool] = None,
    lang_filter: Optional[str] = None,
    *args,
    **kwargs,
) -> dict:
    """
    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.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadGroups

    Args:
        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.
        page: Zero based page
        platform: The platform filter.
        public_only: Determines public/private filtering.
        slot_filter: Filters based on available slots
        auth: Authentication information.
        exclude_immediate: If you wish the result to exclude immediate fireteams, set this to true. Immediate-only can be forced using the dateRange enum.
        lang_filter: An optional language filter.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Fireteam/Clan/{group_id}/Available/{platform}/{activity_type}/{date_range}/{slot_filter}/{public_only}/{page}/",
            method="GET",
            auth=auth,
            exclude_immediate=exclude_immediate,
            lang_filter=lang_filter,
        )
    )

get_available_locales(auth=None, *args, **kwargs) async

List of available localization cultures

Parameters:

Name	Type	Description	Default
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/get_available_locales.py

async def get_available_locales(self, auth: Optional[AuthData] = None, *args, **kwargs) -> dict:
    """
    List of available localization cultures

    Args:
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path="/GetAvailableLocales/", method="GET", auth=auth))

get_available_themes(auth=None, *args, **kwargs) async

Returns a list of all available user themes.

Parameters:

Name	Type	Description	Default
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/user.py

async def get_available_themes(self, auth: Optional[AuthData] = None, *args, **kwargs) -> dict:
    """
    Returns a list of all available user themes.

    Args:
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path="/User/GetAvailableThemes/", method="GET", auth=auth))

get_banned_members_of_group(currentpage, group_id, auth, *args, **kwargs) async

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.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
currentpage	int	Page number (starting with 1). Each page has a fixed size of 50 entries.	required
group_id	int	Group ID whose banned members you are fetching	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def get_banned_members_of_group(
    self, currentpage: int, group_id: int, auth: AuthData, *args, **kwargs
) -> dict:
    """
    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.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        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
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path=f"/GroupV2/{group_id}/Banned/", method="GET", auth=auth))

get_bungie_applications(auth=None, *args, **kwargs) async

Get list of applications created by Bungie.

Parameters:

Name	Type	Description	Default
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/app.py

async def get_bungie_applications(self, auth: Optional[AuthData] = None, *args, **kwargs) -> dict:
    """
    Get list of applications created by Bungie.

    Args:
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path="/App/FirstParty/", method="GET", auth=auth))

get_bungie_net_user_by_id(id, auth=None, *args, **kwargs) async

Loads a bungienet user by membership id.

Parameters:

Name	Type	Description	Default
id	int	The requested Bungie.net membership id.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/user.py

async def get_bungie_net_user_by_id(self, id: int, auth: Optional[AuthData] = None, *args, **kwargs) -> dict:
    """
    Loads a bungienet user by membership id.

    Args:
        id: The requested Bungie.net membership id.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path=f"/User/GetBungieNetUserById/{id}/", method="GET", auth=auth))

get_bungie_rewards_for_platform_user(membership_id, membership_type, auth, *args, **kwargs) async

Returns the bungie rewards for the targeted user when a platform membership Id and Type are used.

Requires Authentication.

Required oauth2 scopes: ReadAndApplyTokens

Parameters:

Name	Type	Description	Default
membership_id	int	users platform membershipId for requested user rewards. If not self, elevated permissions are required.	required
membership_type	int	The target Destiny 2 membership type.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/tokens.py

async def get_bungie_rewards_for_platform_user(
    self, membership_id: int, membership_type: int, auth: AuthData, *args, **kwargs
) -> dict:
    """
    Returns the bungie rewards for the targeted user when a platform membership Id and Type are used.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadAndApplyTokens

    Args:
        membership_id: users platform membershipId for requested user rewards. If not self, elevated permissions are required.
        membership_type: The target Destiny 2 membership type.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Tokens/Rewards/GetRewardsForPlatformUser/{membership_id}/{membership_type}/",
            method="GET",
            auth=auth,
        )
    )

get_bungie_rewards_for_user(membership_id, auth, *args, **kwargs) async

Returns the bungie rewards for the targeted user.

Requires Authentication.

Required oauth2 scopes: ReadAndApplyTokens

Parameters:

Name	Type	Description	Default
membership_id	int	bungie.net user membershipId for requested user rewards. If not self, elevated permissions are required.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/tokens.py

async def get_bungie_rewards_for_user(self, membership_id: int, auth: AuthData, *args, **kwargs) -> dict:
    """
    Returns the bungie rewards for the targeted user.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadAndApplyTokens

    Args:
        membership_id: bungie.net user membershipId for requested user rewards. If not self, elevated permissions are required.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/Tokens/Rewards/GetRewardsForUser/{membership_id}/", method="GET", auth=auth)
    )

get_bungie_rewards_list(auth=None, *args, **kwargs) async

Returns a list of the current bungie rewards

Parameters:

Name	Type	Description	Default
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/tokens.py

async def get_bungie_rewards_list(self, auth: Optional[AuthData] = None, *args, **kwargs) -> dict:
    """
    Returns a list of the current bungie rewards

    Args:
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path="/Tokens/Rewards/BungieRewards/", method="GET", auth=auth))

get_character(character_id, destiny_membership_id, membership_type, components=None, auth=None, *args, **kwargs) async

Returns character information for the supplied character.

Parameters:

Name	Type	Description	Default
character_id	int	ID of the character.	required
destiny_membership_id	int	Destiny membership ID.	required
membership_type	int	A valid non-BungieNet membership type.	required
components	Optional[int]	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.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_character(
    self,
    character_id: int,
    destiny_membership_id: int,
    membership_type: int,
    components: Optional[int] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Returns character information for the supplied character.

    Args:
        character_id: ID of the character.
        destiny_membership_id: Destiny membership ID.
        membership_type: A valid non-BungieNet membership type.
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Destiny2/{membership_type}/Profile/{destiny_membership_id}/Character/{character_id}/",
            method="GET",
            components=components,
            auth=auth,
        )
    )

get_clan_aggregate_stats(group_id, modes=None, auth=None, *args, **kwargs) async

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:

Name	Type	Description	Default
group_id	int	Group ID of the clan whose leaderboards you wish to fetch.	required
modes	Optional[str]	List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_clan_aggregate_stats(
    self, group_id: int, modes: Optional[str] = None, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    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.

    Args:
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/Destiny2/Stats/AggregateClanStats/{group_id}/", method="GET", modes=modes, auth=auth)
    )

get_clan_banner_source(auth=None, *args, **kwargs) async

Returns the dictionary of values for the Clan Banner

Parameters:

Name	Type	Description	Default
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_clan_banner_source(self, auth: Optional[AuthData] = None, *args, **kwargs) -> dict:
    """
    Returns the dictionary of values for the Clan Banner

    Args:
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path="/Destiny2/Clan/ClanBannerDictionary/", method="GET", auth=auth))

get_clan_fireteam(fireteam_id, group_id, auth, *args, **kwargs) async

Gets a specific fireteam.

Requires Authentication.

Required oauth2 scopes: ReadGroups

Parameters:

Name	Type	Description	Default
fireteam_id	int	The unique id of the fireteam.	required
group_id	int	The group id of the clan.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/fireteam.py

async def get_clan_fireteam(self, fireteam_id: int, group_id: int, auth: AuthData, *args, **kwargs) -> dict:
    """
    Gets a specific fireteam.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadGroups

    Args:
        fireteam_id: The unique id of the fireteam.
        group_id: The group id of the clan.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/Fireteam/Clan/{group_id}/Summary/{fireteam_id}/", method="GET", auth=auth)
    )

get_clan_leaderboards(group_id, maxtop=None, modes=None, statid=None, auth=None, *args, **kwargs) async

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:

Name	Type	Description	Default
group_id	int	Group ID of the clan whose leaderboards you wish to fetch.	required
maxtop	Optional[int]	Maximum number of top players to return. Use a large number to get entire leaderboard.	None
modes	Optional[str]	List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.	None
statid	Optional[str]	ID of stat to return rather than returning all Leaderboard stats.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_clan_leaderboards(
    self,
    group_id: int,
    maxtop: Optional[int] = None,
    modes: Optional[str] = None,
    statid: Optional[str] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    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.

    Args:
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Destiny2/Stats/Leaderboards/Clans/{group_id}/",
            method="GET",
            maxtop=maxtop,
            modes=modes,
            statid=statid,
            auth=auth,
        )
    )

get_clan_weekly_reward_state(group_id, auth=None, *args, **kwargs) async

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:

Name	Type	Description	Default
group_id	int	A valid group id of clan.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_clan_weekly_reward_state(
    self, group_id: int, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    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.

    Args:
        group_id: A valid group id of clan.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path=f"/Destiny2/Clan/{group_id}/WeeklyRewardState/", method="GET", auth=auth))

get_collectible_node_details(character_id, collectible_presentation_node_hash, destiny_membership_id, membership_type, components=None, auth=None, *args, **kwargs) async

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:

Name	Type	Description	Default
character_id	int	The Destiny Character ID of the character for whom we're getting collectible detail info.	required
collectible_presentation_node_hash	int	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.	required
destiny_membership_id	int	Destiny membership ID of another user. You may be denied.	required
membership_type	int	A valid non-BungieNet membership type.	required
components	Optional[int]	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.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_collectible_node_details(
    self,
    character_id: int,
    collectible_presentation_node_hash: int,
    destiny_membership_id: int,
    membership_type: int,
    components: Optional[int] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    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.

    Args:
        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.
        destiny_membership_id: Destiny membership ID of another user. You may be denied.
        membership_type: A valid non-BungieNet membership type.
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Destiny2/{membership_type}/Profile/{destiny_membership_id}/Character/{character_id}/Collectibles/{collectible_presentation_node_hash}/",
            method="GET",
            components=components,
            auth=auth,
        )
    )

get_common_settings(auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/settings.py

async def get_common_settings(self, auth: Optional[AuthData] = None, *args, **kwargs) -> dict:
    """
    Get the common settings used by the Bungie.Net environment.

    Args:
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path="/Settings/", method="GET", auth=auth))

get_community_content(media_filter, page, sort, auth=None, *args, **kwargs) async

Returns community content.

Parameters:

Name	Type	Description	Default
media_filter	int	The type of media to get	required
page	int	Zero based page	required
sort	int	The sort mode.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/community_content.py

async def get_community_content(
    self, media_filter: int, page: int, sort: int, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Returns community content.

    Args:
        media_filter: The type of media to get
        page: Zero based page
        sort: The sort mode.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/CommunityContent/Get/{sort}/{media_filter}/{page}/", method="GET", auth=auth)
    )

get_content_by_id(id, locale, head=None, auth=None, *args, **kwargs) async

Returns a content item referenced by id

Parameters:

Name	Type	Description	Default
id	int		required
locale	str		required
head	Optional[bool]	false	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/content.py

async def get_content_by_id(
    self, id: int, locale: str, head: Optional[bool] = None, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Returns a content item referenced by id

    Args:
        id:
        locale:
        head: false
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/Content/GetContentById/{id}/{locale}/", method="GET", head=head, auth=auth)
    )

get_content_by_tag_and_type(locale, tag, type, head=None, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
locale	str		required
tag	str		required
type	str		required
head	Optional[bool]	Not used.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/content.py

async def get_content_by_tag_and_type(
    self,
    locale: str,
    tag: str,
    type: str,
    head: Optional[bool] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Returns the newest item that matches a given tag and Content Type.

    Args:
        locale:
        tag:
        type:
        head: Not used.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/Content/GetContentByTagAndType/{tag}/{type}/{locale}/", method="GET", head=head, auth=auth)
    )

get_content_type(type, auth=None, *args, **kwargs) async

Gets an object describing a particular variant of content.

Parameters:

Name	Type	Description	Default
type	str		required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/content.py

async def get_content_type(self, type: str, auth: Optional[AuthData] = None, *args, **kwargs) -> dict:
    """
    Gets an object describing a particular variant of content.

    Args:
        type:
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path=f"/Content/GetContentType/{type}/", method="GET", auth=auth))

get_core_topics_paged(category_filter, page, quick_date, sort, locales=None, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
category_filter	int	The category filter.	required
page	int	Zero base page	required
quick_date	int	The date filter.	required
sort	int	The sort mode.	required
locales	Optional[str]	Comma seperated list of locales posts must match to return in the result list. Default 'en'	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/forum.py

async def get_core_topics_paged(
    self,
    category_filter: int,
    page: int,
    quick_date: int,
    sort: int,
    locales: Optional[str] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Gets a listing of all topics marked as part of the core group.

    Args:
        category_filter: The category filter.
        page: Zero base page
        quick_date: The date filter.
        sort: The sort mode.
        locales: Comma seperated list of locales posts must match to return in the result list. Default 'en'
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Forum/GetCoreTopicsPaged/{page}/{sort}/{quick_date}/{category_filter}/",
            method="GET",
            locales=locales,
            auth=auth,
        )
    )

get_credential_types_for_target_account(membership_id, auth=None, *args, **kwargs) async

Returns a list of credential types attached to the requested account

Parameters:

Name	Type	Description	Default
membership_id	int	The user's membership id	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/user.py

async def get_credential_types_for_target_account(
    self, membership_id: int, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Returns a list of credential types attached to the requested account

    Args:
        membership_id: The user's membership id
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/User/GetCredentialTypesForTargetAccount/{membership_id}/", method="GET", auth=auth)
    )

get_destiny_aggregate_activity_stats(character_id, destiny_membership_id, membership_type, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
character_id	int	The specific character whose activities should be returned.	required
destiny_membership_id	int	The Destiny membershipId of the user to retrieve.	required
membership_type	int	A valid non-BungieNet membership type.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_destiny_aggregate_activity_stats(
    self,
    character_id: int,
    destiny_membership_id: int,
    membership_type: int,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Gets all activities the character has participated in together with aggregate statistics for those activities.

    Args:
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Destiny2/{membership_type}/Account/{destiny_membership_id}/Character/{character_id}/Stats/AggregateActivityStats/",
            method="GET",
            auth=auth,
        )
    )

get_destiny_entity_definition(entity_type, hash_identifier, auth=None, *args, **kwargs) async

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:

Name	Type	Description	Default
entity_type	str	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.	required
hash_identifier	int	The hash identifier for the specific Entity you want returned.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_destiny_entity_definition(
    self, entity_type: str, hash_identifier: int, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    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.

    Args:
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/Destiny2/Manifest/{entity_type}/{hash_identifier}/", method="GET", auth=auth)
    )

get_destiny_manifest(auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_destiny_manifest(self, auth: Optional[AuthData] = None, *args, **kwargs) -> dict:
    """
    Returns the current version of the manifest as a json object.

    Args:
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path="/Destiny2/Manifest/", method="GET", auth=auth))

get_forum_tag_suggestions(partialtag=None, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
partialtag	Optional[str]	The partial tag input to generate suggestions from.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/forum.py

async def get_forum_tag_suggestions(
    self, partialtag: Optional[str] = None, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Gets tag suggestions based on partial text entry, matching them with other tags previously used in the forums.

    Args:
        partialtag: The partial tag input to generate suggestions from.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path="/Forum/GetForumTagSuggestions/", method="GET", partialtag=partialtag, auth=auth)
    )

get_friend_list(auth, *args, **kwargs) async

Returns your Bungie Friend list

Requires Authentication.

Required oauth2 scopes: ReadUserData

Parameters:

Name	Type	Description	Default
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/social.py

async def get_friend_list(self, auth: AuthData, *args, **kwargs) -> dict:
    """
    Returns your Bungie Friend list

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadUserData

    Args:
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path="/Social/Friends/", method="GET", auth=auth))

get_friend_request_list(auth, *args, **kwargs) async

Returns your friend request queue.

Requires Authentication.

Required oauth2 scopes: ReadUserData

Parameters:

Name	Type	Description	Default
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/social.py

async def get_friend_request_list(self, auth: AuthData, *args, **kwargs) -> dict:
    """
    Returns your friend request queue.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadUserData

    Args:
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path="/Social/Friends/Requests/", method="GET", auth=auth))

get_global_alerts(includestreaming=None, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
includestreaming	Optional[bool]	Determines whether Streaming Alerts are included in results	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/global_alerts.py

async def get_global_alerts(
    self, includestreaming: Optional[bool] = None, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Gets any active global alert for display in the forum banners, help pages, etc. Usually used for DOC alerts.

    Args:
        includestreaming: Determines whether Streaming Alerts are included in results
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path="/GlobalAlerts/", method="GET", includestreaming=includestreaming, auth=auth)
    )

get_group(group_id, auth=None, *args, **kwargs) async

Get information about a specific group of the given ID.

Parameters:

Name	Type	Description	Default
group_id	int	Requested group's id.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def get_group(self, group_id: int, auth: Optional[AuthData] = None, *args, **kwargs) -> dict:
    """
    Get information about a specific group of the given ID.

    Args:
        group_id: Requested group's id.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path=f"/GroupV2/{group_id}/", method="GET", auth=auth))

get_group_by_name(group_name, group_type, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
group_name	str	Exact name of the group to find.	required
group_type	int	Type of group to find.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def get_group_by_name(
    self, group_name: str, group_type: int, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Get information about a specific group with the given name and type.

    Args:
        group_name: Exact name of the group to find.
        group_type: Type of group to find.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path=f"/GroupV2/Name/{group_name}/{group_type}/", method="GET", auth=auth))

get_group_by_name_v2(group_name, group_type, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
group_name	str	No description given by bungie.	required
group_type	Union[Any, int]	No description given by bungie.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def get_group_by_name_v2(
    self, group_name: str, group_type: Union[Any, int], auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Get information about a specific group with the given name and type. The POST version.

    Args:
        group_name: _No description given by bungie._
        group_type: _No description given by bungie._
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "groupName": group_name,
        "groupType": group_type,
    }

    return await self.request(Route(path="/GroupV2/NameV2/", method="POST", data=data, auth=auth))

get_group_edit_history(currentpage, group_id, auth, *args, **kwargs) async

Get the list of edits made to a given group. Only accessible to group Admins and above.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
currentpage	int	Page number (starting with 1). Each page has a fixed size of 50 entries.	required
group_id	int	Group ID whose edit history you are fetching	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def get_group_edit_history(self, currentpage: int, group_id: int, auth: AuthData, *args, **kwargs) -> dict:
    """
    Get the list of edits made to a given group. Only accessible to group Admins and above.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        currentpage: Page number (starting with 1). Each page has a fixed size of 50 entries.
        group_id: Group ID whose edit history you are fetching
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path=f"/GroupV2/{group_id}/EditHistory/", method="GET", auth=auth))

get_group_optional_conversations(group_id, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
group_id	int	Requested group's id.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def get_group_optional_conversations(
    self, group_id: int, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Gets a list of available optional conversation channels and their settings.

    Args:
        group_id: Requested group's id.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path=f"/GroupV2/{group_id}/OptionalConversations/", method="GET", auth=auth))

get_groups_for_member(filter, group_type, membership_id, membership_type, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
filter	int	Filter apply to list of joined groups.	required
group_type	int	Type of group the supplied member founded.	required
membership_id	int	Membership ID to for which to find founded groups.	required
membership_type	int	Membership type of the supplied membership ID.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def get_groups_for_member(
    self,
    filter: int,
    group_type: int,
    membership_id: int,
    membership_type: int,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Get information about the groups that a given member has joined.

    Args:
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/GroupV2/User/{membership_type}/{membership_id}/{filter}/{group_type}/", method="GET", auth=auth
        )
    )

get_historical_stats(character_id, destiny_membership_id, membership_type, dayend=None, daystart=None, groups=None, modes=None, period_type=None, auth=None, *args, **kwargs) async

Gets historical stats for indicated character.

Parameters:

Name	Type	Description	Default
character_id	int	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.	required
destiny_membership_id	int	The Destiny membershipId of the user to retrieve.	required
membership_type	int	A valid non-BungieNet membership type.	required
dayend	Optional[datetime]	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.	None
daystart	Optional[datetime]	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.	None
groups	Optional[int]	Group of stats to include, otherwise only general stats are returned. Comma separated list is allowed. Values: General, Weapons, Medals	None
modes	Optional[int]	Game modes to return. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.	None
period_type	Optional[int]	Indicates a specific period type to return. Optional. May be: Daily, AllTime, or Activity	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_historical_stats(
    self,
    character_id: int,
    destiny_membership_id: int,
    membership_type: int,
    dayend: Optional[datetime] = None,
    daystart: Optional[datetime] = None,
    groups: Optional[int] = None,
    modes: Optional[int] = None,
    period_type: Optional[int] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Gets historical stats for indicated character.

    Args:
        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.
        destiny_membership_id: The Destiny membershipId of the user to retrieve.
        membership_type: A valid non-BungieNet membership type.
        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.
        groups: Group of stats to include, otherwise only general stats are returned. Comma separated list is allowed. Values: General, Weapons, Medals
        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
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Destiny2/{membership_type}/Account/{destiny_membership_id}/Character/{character_id}/Stats/",
            method="GET",
            dayend=dayend,
            daystart=daystart,
            groups=groups,
            modes=modes,
            period_type=period_type,
            auth=auth,
        )
    )

get_historical_stats_definition(auth=None, *args, **kwargs) async

Gets historical stats definitions.

Parameters:

Name	Type	Description	Default
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_historical_stats_definition(self, auth: Optional[AuthData] = None, *args, **kwargs) -> dict:
    """
    Gets historical stats definitions.

    Args:
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path="/Destiny2/Stats/Definition/", method="GET", auth=auth))

get_historical_stats_for_account(destiny_membership_id, membership_type, groups=None, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
destiny_membership_id	int	The Destiny membershipId of the user to retrieve.	required
membership_type	int	A valid non-BungieNet membership type.	required
groups	Optional[int]	Groups of stats to include, otherwise only general stats are returned. Comma separated list is allowed. Values: General, Weapons, Medals.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_historical_stats_for_account(
    self,
    destiny_membership_id: int,
    membership_type: int,
    groups: Optional[int] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Gets aggregate historical stats organized around each character for a given account.

    Args:
        destiny_membership_id: The Destiny membershipId of the user to retrieve.
        membership_type: A valid non-BungieNet membership type.
        groups: Groups of stats to include, otherwise only general stats are returned. Comma separated list is allowed. Values: General, Weapons, Medals.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Destiny2/{membership_type}/Account/{destiny_membership_id}/Stats/",
            method="GET",
            groups=groups,
            auth=auth,
        )
    )

get_invited_individuals(currentpage, group_id, auth, *args, **kwargs) async

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

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
currentpage	int	Page number (starting with 1). Each page has a fixed size of 50 items per page.	required
group_id	int	ID of the group.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def get_invited_individuals(self, currentpage: int, group_id: int, auth: AuthData, *args, **kwargs) -> dict:
    """
    Get the list of users who have been invited into the group.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

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

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/GroupV2/{group_id}/Members/InvitedIndividuals/", method="GET", auth=auth)
    )

get_item(destiny_membership_id, item_instance_id, membership_type, components=None, auth=None, *args, **kwargs) async

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:

Name	Type	Description	Default
destiny_membership_id	int	The membership ID of the destiny profile.	required
item_instance_id	int	The Instance ID of the destiny item.	required
membership_type	int	A valid non-BungieNet membership type.	required
components	Optional[int]	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.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_item(
    self,
    destiny_membership_id: int,
    item_instance_id: int,
    membership_type: int,
    components: Optional[int] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    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.

    Args:
        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.
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Destiny2/{membership_type}/Profile/{destiny_membership_id}/Item/{item_instance_id}/",
            method="GET",
            components=components,
            auth=auth,
        )
    )

get_leaderboards(destiny_membership_id, membership_type, maxtop=None, modes=None, statid=None, auth=None, *args, **kwargs) async

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:

Name	Type	Description	Default
destiny_membership_id	int	The Destiny membershipId of the user to retrieve.	required
membership_type	int	A valid non-BungieNet membership type.	required
maxtop	Optional[int]	Maximum number of top players to return. Use a large number to get entire leaderboard.	None
modes	Optional[str]	List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.	None
statid	Optional[str]	ID of stat to return rather than returning all Leaderboard stats.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_leaderboards(
    self,
    destiny_membership_id: int,
    membership_type: int,
    maxtop: Optional[int] = None,
    modes: Optional[str] = None,
    statid: Optional[str] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    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.

    Args:
        destiny_membership_id: The Destiny membershipId of the user to retrieve.
        membership_type: A valid non-BungieNet membership type.
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Destiny2/{membership_type}/Account/{destiny_membership_id}/Stats/Leaderboards/",
            method="GET",
            maxtop=maxtop,
            modes=modes,
            statid=statid,
            auth=auth,
        )
    )

get_leaderboards_for_character(character_id, destiny_membership_id, membership_type, maxtop=None, modes=None, statid=None, auth=None, *args, **kwargs) async

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:

Name	Type	Description	Default
character_id	int	The specific character to build the leaderboard around for the provided Destiny Membership.	required
destiny_membership_id	int	The Destiny membershipId of the user to retrieve.	required
membership_type	int	A valid non-BungieNet membership type.	required
maxtop	Optional[int]	Maximum number of top players to return. Use a large number to get entire leaderboard.	None
modes	Optional[str]	List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.	None
statid	Optional[str]	ID of stat to return rather than returning all Leaderboard stats.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_leaderboards_for_character(
    self,
    character_id: int,
    destiny_membership_id: int,
    membership_type: int,
    maxtop: Optional[int] = None,
    modes: Optional[str] = None,
    statid: Optional[str] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    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.

    Args:
        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.
        membership_type: A valid non-BungieNet membership type.
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Destiny2/Stats/Leaderboards/{membership_type}/{destiny_membership_id}/{character_id}/",
            method="GET",
            maxtop=maxtop,
            modes=modes,
            statid=statid,
            auth=auth,
        )
    )

get_linked_profiles(membership_id, membership_type, get_all_memberships=None, auth=None, *args, **kwargs) async

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:

Name	Type	Description	Default
membership_id	int	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!	required
membership_type	int	The type for the membership whose linked Destiny accounts you want returned.	required
get_all_memberships	Optional[bool]	(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.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_linked_profiles(
    self,
    membership_id: int,
    membership_type: int,
    get_all_memberships: Optional[bool] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    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.

    Args:
        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.
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Destiny2/{membership_type}/Profile/{membership_id}/LinkedProfiles/",
            method="GET",
            get_all_memberships=get_all_memberships,
            auth=auth,
        )
    )

get_members_of_group(currentpage, group_id, member_type=None, name_search=None, auth=None, *args, **kwargs) async

Get the list of members in a given group.

Parameters:

Name	Type	Description	Default
currentpage	int	Page number (starting with 1). Each page has a fixed size of 50 items per page.	required
group_id	int	The ID of the group.	required
member_type	Optional[int]	Filter out other member types. Use None for all members.	None
name_search	Optional[str]	The name fragment upon which a search should be executed for members with matching display or unique names.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def get_members_of_group(
    self,
    currentpage: int,
    group_id: int,
    member_type: Optional[int] = None,
    name_search: Optional[str] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Get the list of members in a given group.

    Args:
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/GroupV2/{group_id}/Members/",
            method="GET",
            member_type=member_type,
            name_search=name_search,
            auth=auth,
        )
    )

get_membership_data_by_id(membership_id, membership_type, auth=None, *args, **kwargs) async

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:

Name	Type	Description	Default
membership_id	int	The membership ID of the target user.	required
membership_type	int	Type of the supplied membership ID.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/user.py

async def get_membership_data_by_id(
    self, membership_id: int, membership_type: int, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    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.

    Args:
        membership_id: The membership ID of the target user.
        membership_type: Type of the supplied membership ID.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/User/GetMembershipsById/{membership_id}/{membership_type}/", method="GET", auth=auth)
    )

get_membership_data_for_current_user(auth, *args, **kwargs) async

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.

Requires Authentication.

Required oauth2 scopes: ReadBasicUserProfile

Parameters:

Name	Type	Description	Default
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/user.py

async def get_membership_data_for_current_user(self, auth: AuthData, *args, **kwargs) -> dict:
    """
    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.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadBasicUserProfile

    Args:
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path="/User/GetMembershipsForCurrentUser/", method="GET", auth=auth))

get_membership_from_hard_linked_credential(credential, cr_type, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
credential	str	The credential to look up. Must be a valid SteamID64.	required
cr_type	int	The credential type. 'SteamId' is the only valid value at present.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/user.py

async def get_membership_from_hard_linked_credential(
    self, credential: str, cr_type: int, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Gets any hard linked membership given a credential. Only works for credentials that are public (just SteamID64 right now). Cross Save aware.

    Args:
        credential: The credential to look up. Must be a valid SteamID64.
        cr_type: The credential type. 'SteamId' is the only valid value at present.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/User/GetMembershipFromHardLinkedCredential/{cr_type}/{credential}/", method="GET", auth=auth)
    )

get_my_clan_fireteams(group_id, include_closed, page, platform, auth, group_filter=None, lang_filter=None, *args, **kwargs) async

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

Requires Authentication.

Required oauth2 scopes: ReadGroups

Parameters:

Name	Type	Description	Default
group_id	int	The group id of the clan. (This parameter is ignored unless the optional query parameter groupFilter is true).	required
include_closed	bool	If true, return fireteams that have been closed.	required
page	int	Deprecated parameter, ignored.	required
platform	int	The platform filter.	required
auth	AuthData	Authentication information.	required
group_filter	Optional[bool]	If true, filter by clan. Otherwise, ignore the clan and show all of the user's fireteams.	None
lang_filter	Optional[str]	An optional language filter.	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/fireteam.py

async def get_my_clan_fireteams(
    self,
    group_id: int,
    include_closed: bool,
    page: int,
    platform: int,
    auth: AuthData,
    group_filter: Optional[bool] = None,
    lang_filter: Optional[str] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Gets a listing of all fireteams that caller is an applicant, a member, or an alternate of.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadGroups

    Args:
        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.
        page: Deprecated parameter, ignored.
        platform: The platform filter.
        auth: Authentication information.
        group_filter: If true, filter by clan. Otherwise, ignore the clan and show all of the user's fireteams.
        lang_filter: An optional language filter.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Fireteam/Clan/{group_id}/My/{platform}/{include_closed}/{page}/",
            method="GET",
            auth=auth,
            group_filter=group_filter,
            lang_filter=lang_filter,
        )
    )

get_partner_offer_sku_history(partner_application_id, target_bnet_membership_id, auth, *args, **kwargs) async

Returns the partner sku and offer history of the targeted user. Elevated permissions are required to see users that are not yourself.

Requires Authentication.

Required oauth2 scopes: PartnerOfferGrant

Parameters:

Name	Type	Description	Default
partner_application_id	int	The partner application identifier.	required
target_bnet_membership_id	int	The bungie.net user to apply missing offers to. If not self, elevated permissions are required.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/tokens.py

async def get_partner_offer_sku_history(
    self, partner_application_id: int, target_bnet_membership_id: int, auth: AuthData, *args, **kwargs
) -> dict:
    """
    Returns the partner sku and offer history of the targeted user. Elevated permissions are required to see users that are not yourself.

    Warning: Requires Authentication.
        Required oauth2 scopes: PartnerOfferGrant

    Args:
        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.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Tokens/Partner/History/{partner_application_id}/{target_bnet_membership_id}/",
            method="GET",
            auth=auth,
        )
    )

get_partner_reward_history(partner_application_id, target_bnet_membership_id, auth, *args, **kwargs) async

Returns the partner rewards history of the targeted user, both partner offers and Twitch drops.

Requires Authentication.

Required oauth2 scopes: PartnerOfferGrant

Parameters:

Name	Type	Description	Default
partner_application_id	int	The partner application identifier.	required
target_bnet_membership_id	int	The bungie.net user to return reward history for.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/tokens.py

async def get_partner_reward_history(
    self, partner_application_id: int, target_bnet_membership_id: int, auth: AuthData, *args, **kwargs
) -> dict:
    """
    Returns the partner rewards history of the targeted user, both partner offers and Twitch drops.

    Warning: Requires Authentication.
        Required oauth2 scopes: PartnerOfferGrant

    Args:
        partner_application_id: The partner application identifier.
        target_bnet_membership_id: The bungie.net user to return reward history for.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Tokens/Partner/History/{target_bnet_membership_id}/Application/{partner_application_id}/",
            method="GET",
            auth=auth,
        )
    )

get_pending_memberships(currentpage, group_id, auth, *args, **kwargs) async

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

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
currentpage	int	Page number (starting with 1). Each page has a fixed size of 50 items per page.	required
group_id	int	ID of the group.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def get_pending_memberships(self, currentpage: int, group_id: int, auth: AuthData, *args, **kwargs) -> dict:
    """
    Get the list of users who are awaiting a decision on their application to join a given group. Modified to include application info.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

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

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path=f"/GroupV2/{group_id}/Members/Pending/", method="GET", auth=auth))

get_platform_friend_list(friend_platform, page, auth=None, *args, **kwargs) async

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:

Name	Type	Description	Default
friend_platform	int	The platform friend type.	required
page	str	The zero based page to return. Page size is 100.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/social.py

async def get_platform_friend_list(
    self, friend_platform: int, page: str, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    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.

    Args:
        friend_platform: The platform friend type.
        page: The zero based page to return. Page size is 100.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/Social/PlatformFriends/{friend_platform}/{page}/", method="GET", auth=auth)
    )

get_poll(topic_id, auth=None, *args, **kwargs) async

Gets the specified forum poll.

Parameters:

Name	Type	Description	Default
topic_id	int	The post id of the topic that has the poll.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/forum.py

async def get_poll(self, topic_id: int, auth: Optional[AuthData] = None, *args, **kwargs) -> dict:
    """
    Gets the specified forum poll.

    Args:
        topic_id: The post id of the topic that has the poll.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path=f"/Forum/Poll/{topic_id}/", method="GET", auth=auth))

get_post_and_parent(child_post_id, showbanned=None, auth=None, *args, **kwargs) async

Returns the post specified and its immediate parent.

Parameters:

Name	Type	Description	Default
child_post_id	int		required
showbanned	Optional[str]	If this value is not null or empty, banned posts are requested to be returned	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/forum.py

async def get_post_and_parent(
    self, child_post_id: int, showbanned: Optional[str] = None, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Returns the post specified and its immediate parent.

    Args:
        child_post_id:
        showbanned: If this value is not null or empty, banned posts are requested to be returned
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/Forum/GetPostAndParent/{child_post_id}/", method="GET", showbanned=showbanned, auth=auth)
    )

get_post_and_parent_awaiting_approval(child_post_id, showbanned=None, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
child_post_id	int		required
showbanned	Optional[str]	If this value is not null or empty, banned posts are requested to be returned	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/forum.py

async def get_post_and_parent_awaiting_approval(
    self, child_post_id: int, showbanned: Optional[str] = None, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Returns the post specified and its immediate parent of posts that are awaiting approval.

    Args:
        child_post_id:
        showbanned: If this value is not null or empty, banned posts are requested to be returned
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Forum/GetPostAndParentAwaitingApproval/{child_post_id}/",
            method="GET",
            showbanned=showbanned,
            auth=auth,
        )
    )

get_post_game_carnage_report(activity_id, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
activity_id	int	The ID of the activity whose PGCR is requested.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_post_game_carnage_report(
    self, activity_id: int, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Gets the available post game carnage report for the activity ID.

    Args:
        activity_id: The ID of the activity whose PGCR is requested.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/Destiny2/Stats/PostGameCarnageReport/{activity_id}/", method="GET", auth=auth)
    )

get_posts_threaded_paged(get_parent_post, page, page_size, parent_post_id, reply_size, root_thread_mode, sort_mode, showbanned=None, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
get_parent_post	bool		required
page	int		required
page_size	int		required
parent_post_id	int		required
reply_size	int		required
root_thread_mode	bool		required
sort_mode	int		required
showbanned	Optional[str]	If this value is not null or empty, banned posts are requested to be returned	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/forum.py

async def get_posts_threaded_paged(
    self,
    get_parent_post: bool,
    page: int,
    page_size: int,
    parent_post_id: int,
    reply_size: int,
    root_thread_mode: bool,
    sort_mode: int,
    showbanned: Optional[str] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Returns a thread of posts at the given parent, optionally returning replies to those posts as well as the original parent.

    Args:
        get_parent_post:
        page:
        page_size:
        parent_post_id:
        reply_size:
        root_thread_mode:
        sort_mode:
        showbanned: If this value is not null or empty, banned posts are requested to be returned
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Forum/GetPostsThreadedPaged/{parent_post_id}/{page}/{page_size}/{reply_size}/{get_parent_post}/{root_thread_mode}/{sort_mode}/",
            method="GET",
            showbanned=showbanned,
            auth=auth,
        )
    )

get_posts_threaded_paged_from_child(child_post_id, page, page_size, reply_size, root_thread_mode, sort_mode, showbanned=None, auth=None, *args, **kwargs) async

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:

Name	Type	Description	Default
child_post_id	int		required
page	int		required
page_size	int		required
reply_size	int		required
root_thread_mode	bool		required
sort_mode	int		required
showbanned	Optional[str]	If this value is not null or empty, banned posts are requested to be returned	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/forum.py

async def get_posts_threaded_paged_from_child(
    self,
    child_post_id: int,
    page: int,
    page_size: int,
    reply_size: int,
    root_thread_mode: bool,
    sort_mode: int,
    showbanned: Optional[str] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    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.

    Args:
        child_post_id:
        page:
        page_size:
        reply_size:
        root_thread_mode:
        sort_mode:
        showbanned: If this value is not null or empty, banned posts are requested to be returned
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Forum/GetPostsThreadedPagedFromChild/{child_post_id}/{page}/{page_size}/{reply_size}/{root_thread_mode}/{sort_mode}/",
            method="GET",
            showbanned=showbanned,
            auth=auth,
        )
    )

get_potential_groups_for_member(filter, group_type, membership_id, membership_type, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
filter	int	Filter apply to list of potential joined groups.	required
group_type	int	Type of group the supplied member applied.	required
membership_id	int	Membership ID to for which to find applied groups.	required
membership_type	int	Membership type of the supplied membership ID.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def get_potential_groups_for_member(
    self,
    filter: int,
    group_type: int,
    membership_id: int,
    membership_type: int,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Get information about the groups that a given member has applied to or been invited to.

    Args:
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/GroupV2/User/Potential/{membership_type}/{membership_id}/{filter}/{group_type}/",
            method="GET",
            auth=auth,
        )
    )

get_profile(destiny_membership_id, membership_type, components=None, auth=None, *args, **kwargs) async

Returns Destiny Profile information for the supplied membership.

Parameters:

Name	Type	Description	Default
destiny_membership_id	int	Destiny membership ID.	required
membership_type	int	A valid non-BungieNet membership type.	required
components	Optional[int]	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.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_profile(
    self,
    destiny_membership_id: int,
    membership_type: int,
    components: Optional[int] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Returns Destiny Profile information for the supplied membership.

    Args:
        destiny_membership_id: Destiny membership ID.
        membership_type: A valid non-BungieNet membership type.
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Destiny2/{membership_type}/Profile/{destiny_membership_id}/",
            method="GET",
            components=components,
            auth=auth,
        )
    )

get_public_milestone_content(milestone_hash, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
milestone_hash	int	The identifier for the milestone to be returned.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_public_milestone_content(
    self, milestone_hash: int, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Gets custom localized content for the milestone of the given hash, if it exists.

    Args:
        milestone_hash: The identifier for the milestone to be returned.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/Destiny2/Milestones/{milestone_hash}/Content/", method="GET", auth=auth)
    )

get_public_milestones(auth=None, *args, **kwargs) async

Gets public information about currently available Milestones.

Parameters:

Name	Type	Description	Default
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_public_milestones(self, auth: Optional[AuthData] = None, *args, **kwargs) -> dict:
    """
    Gets public information about currently available Milestones.

    Args:
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path="/Destiny2/Milestones/", method="GET", auth=auth))

get_public_vendors(components=None, auth=None, *args, **kwargs) async

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:

Name	Type	Description	Default
components	Optional[int]	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.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_public_vendors(
    self, components: Optional[int] = None, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    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...'

    Args:
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path="/Destiny2/Vendors/", method="GET", components=components, auth=auth))

get_recommended_groups(create_date_range, group_type, auth, *args, **kwargs) async

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

Requires Authentication.

Required oauth2 scopes: ReadGroups

Parameters:

Name	Type	Description	Default
create_date_range	int	Requested range in which to pull recommended groups	required
group_type	int	Type of groups requested	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def get_recommended_groups(
    self, create_date_range: int, group_type: int, auth: AuthData, *args, **kwargs
) -> dict:
    """
    Gets groups recommended for you based on the groups to whom those you follow belong.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadGroups

    Args:
        create_date_range: Requested range in which to pull recommended groups
        group_type: Type of groups requested
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/GroupV2/Recommended/{group_type}/{create_date_range}/", method="POST", auth=auth)
    )

get_recruitment_thread_summaries(body_data, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
body_data	list[int]	No description given by bungie.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/forum.py

async def get_recruitment_thread_summaries(
    self, body_data: list[int], auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Allows the caller to get a list of to 25 recruitment thread summary information objects.

    Args:
        body_data: _No description given by bungie._
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = body_data

    return await self.request(Route(path="/Forum/Recruit/Summaries/", method="POST", data=data, auth=auth))

get_sanitized_platform_display_names(membership_id, auth=None, *args, **kwargs) async

Gets a list of all display names linked to this membership id but sanitized (profanity filtered). Obeys all visibility rules of calling user and is heavily cached.

Parameters:

Name	Type	Description	Default
membership_id	int	The requested membership id to load.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/user.py

async def get_sanitized_platform_display_names(
    self, membership_id: int, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Gets a list of all display names linked to this membership id but sanitized (profanity filtered). Obeys all visibility rules of calling user and is heavily cached.

    Args:
        membership_id: The requested membership id to load.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/User/GetSanitizedPlatformDisplayNames/{membership_id}/", method="GET", auth=auth)
    )

get_topic_for_content(content_id, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
content_id	int		required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/forum.py

async def get_topic_for_content(self, content_id: int, auth: Optional[AuthData] = None, *args, **kwargs) -> dict:
    """
    Gets the post Id for the given content item's comments, if it exists.

    Args:
        content_id:
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path=f"/Forum/GetTopicForContent/{content_id}/", method="GET", auth=auth))

get_topics_paged(category_filter, group, page, page_size, quick_date, sort, locales=None, tagstring=None, auth=None, *args, **kwargs) async

Get topics from any forum.

Parameters:

Name	Type	Description	Default
category_filter	int	A category filter	required
group	int	The group, if any.	required
page	int	Zero paged page number	required
page_size	int	Unused	required
quick_date	int	A date filter.	required
sort	int	The sort mode.	required
locales	Optional[str]	Comma seperated list of locales posts must match to return in the result list. Default 'en'	None
tagstring	Optional[str]	The tags to search, if any.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/forum.py

async def get_topics_paged(
    self,
    category_filter: int,
    group: int,
    page: int,
    page_size: int,
    quick_date: int,
    sort: int,
    locales: Optional[str] = None,
    tagstring: Optional[str] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Get topics from any forum.

    Args:
        category_filter: A category filter
        group: The group, if any.
        page: Zero paged page number
        page_size: Unused
        quick_date: A date filter.
        sort: The sort mode.
        locales: Comma seperated list of locales posts must match to return in the result list. Default 'en'
        tagstring: The tags to search, if any.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Forum/GetTopicsPaged/{page}/{page_size}/{group}/{sort}/{quick_date}/{category_filter}/",
            method="GET",
            locales=locales,
            tagstring=tagstring,
            auth=auth,
        )
    )

get_trending_categories(auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/trending.py

async def get_trending_categories(self, auth: Optional[AuthData] = None, *args, **kwargs) -> dict:
    """
    Returns trending items for Bungie.net, collapsed into the first page of items per category. For pagination within a category, call GetTrendingCategory.

    Args:
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path="/Trending/Categories/", method="GET", auth=auth))

get_trending_category(category_id, page_number, auth=None, *args, **kwargs) async

Returns paginated lists of trending items for a category.

Parameters:

Name	Type	Description	Default
category_id	str	The ID of the category for whom you want additional results.	required
page_number	int	The page # of results to return.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/trending.py

async def get_trending_category(
    self, category_id: str, page_number: int, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Returns paginated lists of trending items for a category.

    Args:
        category_id: The ID of the category for whom you want additional results.
        page_number: The page # of results to return.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/Trending/Categories/{category_id}/{page_number}/", method="GET", auth=auth)
    )

get_trending_entry_detail(identifier, trending_entry_type, auth=None, *args, **kwargs) async

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:

Name	Type	Description	Default
identifier	str	The identifier for the entity to be returned.	required
trending_entry_type	int	The type of entity to be returned.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/trending.py

async def get_trending_entry_detail(
    self, identifier: str, trending_entry_type: int, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    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.

    Args:
        identifier: The identifier for the entity to be returned.
        trending_entry_type: The type of entity to be returned.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/Trending/Details/{trending_entry_type}/{identifier}/", method="GET", auth=auth)
    )

get_unique_weapon_history(character_id, destiny_membership_id, membership_type, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
character_id	int	The id of the character to retrieve.	required
destiny_membership_id	int	The Destiny membershipId of the user to retrieve.	required
membership_type	int	A valid non-BungieNet membership type.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_unique_weapon_history(
    self,
    character_id: int,
    destiny_membership_id: int,
    membership_type: int,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Gets details about unique weapon usage, including all exotic weapons.

    Args:
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Destiny2/{membership_type}/Account/{destiny_membership_id}/Character/{character_id}/Stats/UniqueWeapons/",
            method="GET",
            auth=auth,
        )
    )

get_user_clan_invite_setting(m_type, auth, *args, **kwargs) async

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.

Requires Authentication.

Required oauth2 scopes: ReadUserData

Parameters:

Name	Type	Description	Default
m_type	int	The Destiny membership type of the account we wish to access settings.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def get_user_clan_invite_setting(self, m_type: int, auth: AuthData, *args, **kwargs) -> dict:
    """
    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.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadUserData

    Args:
        m_type: The Destiny membership type of the account we wish to access settings.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path=f"/GroupV2/GetUserClanInviteSetting/{m_type}/", method="GET", auth=auth))

get_user_system_overrides(auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/user_system_overrides.py

async def get_user_system_overrides(self, auth: Optional[AuthData] = None, *args, **kwargs) -> dict:
    """
    Get the user-specific system overrides that should be respected alongside common systems.

    Args:
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path="/UserSystemOverrides/", method="GET", auth=auth))

get_vendor(character_id, destiny_membership_id, membership_type, vendor_hash, components=None, auth=None, *args, **kwargs) async

Get the details of a specific Vendor.

Parameters:

Name	Type	Description	Default
character_id	int	The Destiny Character ID of the character for whom we're getting vendor info.	required
destiny_membership_id	int	Destiny membership ID of another user. You may be denied.	required
membership_type	int	A valid non-BungieNet membership type.	required
vendor_hash	int	The Hash identifier of the Vendor to be returned.	required
components	Optional[int]	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.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_vendor(
    self,
    character_id: int,
    destiny_membership_id: int,
    membership_type: int,
    vendor_hash: int,
    components: Optional[int] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Get the details of a specific Vendor.

    Args:
        character_id: The Destiny Character ID of the character for whom we're getting vendor info.
        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.
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Destiny2/{membership_type}/Profile/{destiny_membership_id}/Character/{character_id}/Vendors/{vendor_hash}/",
            method="GET",
            components=components,
            auth=auth,
        )
    )

get_vendors(character_id, destiny_membership_id, membership_type, components=None, filter=None, auth=None, *args, **kwargs) async

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:

Name	Type	Description	Default
character_id	int	The Destiny Character ID of the character for whom we're getting vendor info.	required
destiny_membership_id	int	Destiny membership ID of another user. You may be denied.	required
membership_type	int	A valid non-BungieNet membership type.	required
components	Optional[int]	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.	None
filter	Optional[int]	The filter of what vendors and items to return, if any.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def get_vendors(
    self,
    character_id: int,
    destiny_membership_id: int,
    membership_type: int,
    components: Optional[int] = None,
    filter: Optional[int] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    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.

    Args:
        character_id: The Destiny Character ID of the character for whom we're getting vendor info.
        destiny_membership_id: Destiny membership ID of another user. You may be denied.
        membership_type: A valid non-BungieNet membership type.
        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.
        filter: The filter of what vendors and items to return, if any.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Destiny2/{membership_type}/Profile/{destiny_membership_id}/Character/{character_id}/Vendors/",
            method="GET",
            components=components,
            filter=filter,
            auth=auth,
        )
    )

group_search(name, group_type, creation_date, sort_by, group_member_count_filter, locale_filter, tag_text, items_per_page, current_page, request_continuation_token, auth=None, *args, **kwargs) async

Search for Groups.

Parameters:

Name	Type	Description	Default
name	str	No description given by bungie.	required
group_type	Union[Any, int]	No description given by bungie.	required
creation_date	Union[Any, int]	No description given by bungie.	required
sort_by	Union[Any, int]	No description given by bungie.	required
group_member_count_filter	Union[Any, int]	No description given by bungie.	required
locale_filter	str	No description given by bungie.	required
tag_text	str	No description given by bungie.	required
items_per_page	int	No description given by bungie.	required
current_page	int	No description given by bungie.	required
request_continuation_token	str	No description given by bungie.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def group_search(
    self,
    name: str,
    group_type: Union[Any, int],
    creation_date: Union[Any, int],
    sort_by: Union[Any, int],
    group_member_count_filter: Union[Any, int],
    locale_filter: str,
    tag_text: str,
    items_per_page: int,
    current_page: int,
    request_continuation_token: str,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Search for Groups.

    Args:
        name: _No description given by bungie._
        group_type: _No description given by bungie._
        creation_date: _No description given by bungie._
        sort_by: _No description given by bungie._
        group_member_count_filter: _No description given by bungie._
        locale_filter: _No description given by bungie._
        tag_text: _No description given by bungie._
        items_per_page: _No description given by bungie._
        current_page: _No description given by bungie._
        request_continuation_token: _No description given by bungie._
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "name": name,
        "groupType": group_type,
        "creationDate": creation_date,
        "sortBy": sort_by,
        "groupMemberCountFilter": group_member_count_filter,
        "localeFilter": locale_filter,
        "tagText": tag_text,
        "itemsPerPage": items_per_page,
        "currentPage": current_page,
        "requestContinuationToken": request_continuation_token,
    }

    return await self.request(Route(path="/GroupV2/Search/", method="POST", data=data, auth=auth))

individual_group_invite(message, group_id, membership_id, membership_type, auth, *args, **kwargs) async

Invite a user to join this group.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
message	str	No description given by bungie.	required
group_id	int	ID of the group you would like to join.	required
membership_id	int	Membership id of the account being invited.	required
membership_type	int	MembershipType of the account being invited.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def individual_group_invite(
    self, message: str, group_id: int, membership_id: int, membership_type: int, auth: AuthData, *args, **kwargs
) -> dict:
    """
    Invite a user to join this group.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        message: _No description given by bungie._
        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.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "message": message,
    }

    return await self.request(
        Route(
            path=f"/GroupV2/{group_id}/Members/IndividualInvite/{membership_type}/{membership_id}/",
            method="POST",
            data=data,
            auth=auth,
        )
    )

individual_group_invite_cancel(group_id, membership_id, membership_type, auth, *args, **kwargs) async

Cancels a pending invitation to join a group.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
group_id	int	ID of the group you would like to join.	required
membership_id	int	Membership id of the account being cancelled.	required
membership_type	int	MembershipType of the account being cancelled.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def individual_group_invite_cancel(
    self, group_id: int, membership_id: int, membership_type: int, auth: AuthData, *args, **kwargs
) -> dict:
    """
    Cancels a pending invitation to join a group.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        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.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/GroupV2/{group_id}/Members/IndividualInviteCancel/{membership_type}/{membership_id}/",
            method="POST",
            auth=auth,
        )
    )

insert_socket_plug(action_token, item_instance_id, plug, character_id, membership_type, auth, *args, **kwargs) async

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.

Requires Authentication.

Required oauth2 scopes: AdvancedWriteActions

Parameters:

Name	Type	Description	Default
action_token	str	Action token provided by the AwaGetActionToken API call.	required
item_instance_id	int	The instance ID of the item having a plug inserted. Only instanced items can have sockets.	required
plug	Any	The plugs being inserted.	required
character_id	int	No description given by bungie.	required
membership_type	Union[Any, int]	No description given by bungie.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def insert_socket_plug(
    self,
    action_token: str,
    item_instance_id: int,
    plug: Any,
    character_id: int,
    membership_type: Union[Any, int],
    auth: AuthData,
    *args,
    **kwargs,
) -> dict:
    """
    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.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdvancedWriteActions

    Args:
        action_token: Action token provided by the AwaGetActionToken API call.
        item_instance_id: The instance ID of the item having a plug inserted. Only instanced items can have sockets.
        plug: The plugs being inserted.
        character_id: _No description given by bungie._
        membership_type: _No description given by bungie._
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "actionToken": action_token,
        "itemInstanceId": item_instance_id,
        "plug": plug,
        "characterId": character_id,
        "membershipType": membership_type,
    }

    return await self.request(
        Route(path="/Destiny2/Actions/Items/InsertSocketPlug/", method="POST", data=data, auth=auth)
    )

insert_socket_plug_free(plug, item_id, character_id, membership_type, auth, *args, **kwargs) async

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.

Requires Authentication.

Required oauth2 scopes: MoveEquipDestinyItems

Parameters:

Name	Type	Description	Default
plug	Any	The plugs being inserted.	required
item_id	int	The instance ID of the item for this action request.	required
character_id	int	No description given by bungie.	required
membership_type	Union[Any, int]	No description given by bungie.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def insert_socket_plug_free(
    self,
    plug: Any,
    item_id: int,
    character_id: int,
    membership_type: Union[Any, int],
    auth: AuthData,
    *args,
    **kwargs,
) -> dict:
    """
    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.

    Warning: Requires Authentication.
        Required oauth2 scopes: MoveEquipDestinyItems

    Args:
        plug: The plugs being inserted.
        item_id: The instance ID of the item for this action request.
        character_id: _No description given by bungie._
        membership_type: _No description given by bungie._
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "plug": plug,
        "itemId": item_id,
        "characterId": character_id,
        "membershipType": membership_type,
    }

    return await self.request(
        Route(path="/Destiny2/Actions/Items/InsertSocketPlugFree/", method="POST", data=data, auth=auth)
    )

issue_friend_request(membership_id, auth, *args, **kwargs) async

Requests a friend relationship with the target user. Any of the target user's linked membership ids are valid inputs.

Requires Authentication.

Required oauth2 scopes: BnetWrite

Parameters:

Name	Type	Description	Default
membership_id	str	The membership id of the user you wish to add.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/social.py

async def issue_friend_request(self, membership_id: str, auth: AuthData, *args, **kwargs) -> dict:
    """
    Requests a friend relationship with the target user. Any of the target user's linked membership ids are valid inputs.

    Warning: Requires Authentication.
        Required oauth2 scopes: BnetWrite

    Args:
        membership_id: The membership id of the user you wish to add.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path=f"/Social/Friends/Add/{membership_id}/", method="POST", auth=auth))

kick_member(group_id, membership_id, membership_type, auth, *args, **kwargs) async

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.

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
group_id	int	Group ID to kick the user from.	required
membership_id	int	Membership ID to kick.	required
membership_type	int	Membership type of the provided membership ID.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def kick_member(
    self, group_id: int, membership_id: int, membership_type: int, auth: AuthData, *args, **kwargs
) -> dict:
    """
    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.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

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

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/GroupV2/{group_id}/Members/{membership_type}/{membership_id}/Kick/", method="POST", auth=auth)
    )

pull_from_postmaster(item_reference_hash, stack_size, item_id, character_id, membership_type, auth, *args, **kwargs) async

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.

Requires Authentication.

Required oauth2 scopes: MoveEquipDestinyItems

Parameters:

Name	Type	Description	Default
item_reference_hash	int	No description given by bungie.	required
stack_size	int	No description given by bungie.	required
item_id	int	The instance ID of the item for this action request.	required
character_id	int	No description given by bungie.	required
membership_type	Union[Any, int]	No description given by bungie.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def pull_from_postmaster(
    self,
    item_reference_hash: int,
    stack_size: int,
    item_id: int,
    character_id: int,
    membership_type: Union[Any, int],
    auth: AuthData,
    *args,
    **kwargs,
) -> dict:
    """
    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.

    Warning: Requires Authentication.
        Required oauth2 scopes: MoveEquipDestinyItems

    Args:
        item_reference_hash: _No description given by bungie._
        stack_size: _No description given by bungie._
        item_id: The instance ID of the item for this action request.
        character_id: _No description given by bungie._
        membership_type: _No description given by bungie._
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "itemReferenceHash": item_reference_hash,
        "stackSize": stack_size,
        "itemId": item_id,
        "characterId": character_id,
        "membershipType": membership_type,
    }

    return await self.request(
        Route(path="/Destiny2/Actions/Items/PullFromPostmaster/", method="POST", data=data, auth=auth)
    )

recover_group_for_founder(group_type, membership_id, membership_type, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
group_type	int	Type of group the supplied member founded.	required
membership_id	int	Membership ID to for which to find founded groups.	required
membership_type	int	Membership type of the supplied membership ID.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def recover_group_for_founder(
    self,
    group_type: int,
    membership_id: int,
    membership_type: int,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Allows a founder to manually recover a group they can see in game but not on bungie.net

    Args:
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/GroupV2/Recover/{membership_type}/{membership_id}/{group_type}/", method="GET", auth=auth)
    )

refresh_access_token(auth) async

Refresh a bungie.net token.

Parameters:

Name	Type	Description	Default
auth	AuthData	The old authentication information.	required

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/auth.py

async def refresh_access_token(
    self,
    auth: AuthData,
) -> dict:
    """
    Refresh a bungie.net token.

    Args:
        auth: The old authentication information.

    Returns:
        The json response
    """

    data = {
        "grant_type": "refresh_token",
        "refresh_token": auth.refresh_token,
    }

    return await self._request(
        route="https://www.bungie.net/Platform/App/OAuth/token/",
        method="POST",
        form_data=data,
        headers=self._bungie_auth_headers,
        use_ratelimiter=False,
    )

remove_friend(membership_id, auth, *args, **kwargs) async

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.

Requires Authentication.

Required oauth2 scopes: BnetWrite

Parameters:

Name	Type	Description	Default
membership_id	str	The membership id of the user you wish to remove.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/social.py

async def remove_friend(self, membership_id: str, auth: AuthData, *args, **kwargs) -> dict:
    """
    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.

    Warning: Requires Authentication.
        Required oauth2 scopes: BnetWrite

    Args:
        membership_id: The membership id of the user you wish to remove.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(Route(path=f"/Social/Friends/Remove/{membership_id}/", method="POST", auth=auth))

remove_friend_request(membership_id, auth, *args, **kwargs) async

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.

Requires Authentication.

Required oauth2 scopes: BnetWrite

Parameters:

Name	Type	Description	Default
membership_id	str	The membership id of the user you wish to remove.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/social.py

async def remove_friend_request(self, membership_id: str, auth: AuthData, *args, **kwargs) -> dict:
    """
    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.

    Warning: Requires Authentication.
        Required oauth2 scopes: BnetWrite

    Args:
        membership_id: The membership id of the user you wish to remove.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/Social/Friends/Requests/Remove/{membership_id}/", method="POST", auth=auth)
    )

report_offensive_post_game_carnage_report_player(reason_category_hashes, reason_hashes, offending_character_id, activity_id, auth, *args, **kwargs) async

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.

Requires Authentication.

Required oauth2 scopes: BnetWrite

Parameters:

Name	Type	Description	Default
reason_category_hashes	list[int]	So you've decided to report someone instead of cursing them and their descendants. Well, okay then. This is the category or categorie(s) of infractions for which you are reporting the user. These are hash identifiers that map to DestinyReportReasonCategoryDefinition entries.	required
reason_hashes	list[int]	If applicable, provide a more specific reason(s) within the general category of problems provided by the reasonHash. This is also an identifier for a reason. All reasonHashes provided must be children of at least one the reasonCategoryHashes provided.	required
offending_character_id	int	Within the PGCR provided when calling the Reporting endpoint, this should be the character ID of the user that you thought was violating terms of use. They must exist in the PGCR provided.	required
activity_id	int	The ID of the activity where you ran into the brigand that you're reporting.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def report_offensive_post_game_carnage_report_player(
    self,
    reason_category_hashes: list[int],
    reason_hashes: list[int],
    offending_character_id: int,
    activity_id: int,
    auth: AuthData,
    *args,
    **kwargs,
) -> dict:
    """
    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.

    Warning: Requires Authentication.
        Required oauth2 scopes: BnetWrite

    Args:
        reason_category_hashes: So you've decided to report someone instead of cursing them and their descendants. Well, okay then. This is the category or categorie(s) of infractions for which you are reporting the user. These are hash identifiers that map to DestinyReportReasonCategoryDefinition entries.
        reason_hashes: If applicable, provide a more specific reason(s) within the general category of problems provided by the reasonHash. This is also an identifier for a reason. All reasonHashes provided must be children of at least one the reasonCategoryHashes provided.
        offending_character_id: Within the PGCR provided when calling the Reporting endpoint, this should be the character ID of the user that you thought was violating terms of use. They must exist in the PGCR provided.
        activity_id: The ID of the activity where you ran into the brigand that you're reporting.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "reasonCategoryHashes": reason_category_hashes,
        "reasonHashes": reason_hashes,
        "offendingCharacterId": offending_character_id,
    }

    return await self.request(
        Route(
            path=f"/Destiny2/Stats/PostGameCarnageReport/{activity_id}/Report/", method="POST", data=data, auth=auth
        )
    )

request(route) async

Handle all web requests.

Parameters:

Name	Type	Description	Default
route	Route	The route / method / params the request should have	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/client.py

async def request(self, route: Route) -> dict:
    """
    Handle all web requests.

    Args:
        route: The route / method / params the request should have

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    # make sure all is set up
    if not hasattr(self, "_client"):
        raise ValueError("You have to instantiate the `bungio.Client` before using this")

    headers = self._bungie_headers if not route.auth else await self._get_auth_headers(auth=route.auth)

    async with self.semaphore:
        return await self._request(
            route=route.path,
            method=route.method,
            headers=headers,
            params=route.params,
            data=route.data,
            auth=route.auth,
            use_ratelimiter=True,
        )

request_access_token(code) async

Authorise with bungie.net by requesting an access token using the code they generated.

View the official documentation for more information on how to set this up.

Parameters:

Name	Type	Description	Default
code	str	The code bungie sent.	required

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/auth.py

async def request_access_token(
    self,
    code: str,
) -> dict:
    """
    Authorise with bungie.net by requesting an access token using the code they generated.

    View [the official documentation](https://github.com/Bungie-net/api/wiki/OAuth-Documentation) for more information on how to set this up.

    Args:
        code: The code bungie sent.

    Returns:
        The json response
    """

    data = {
        "grant_type": "authorization_code",
        "code": code,
    }

    return await self._request(
        route="https://www.bungie.net/Platform/App/OAuth/token/",
        method="POST",
        form_data=data,
        headers=self._bungie_auth_headers,
        use_ratelimiter=False,
    )

rss_news_articles(page_token, categoryfilter=None, includebody=None, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
page_token	str	Zero-based pagination token for paging through result sets.	required
categoryfilter	Optional[str]	Optionally filter response to only include news items in a certain category.	None
includebody	Optional[bool]	Optionally include full content body for each news item.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/content.py

async def rss_news_articles(
    self,
    page_token: str,
    categoryfilter: Optional[str] = None,
    includebody: Optional[bool] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Returns a JSON string response that is the RSS feed for news articles.

    Args:
        page_token: Zero-based pagination token for paging through result sets.
        categoryfilter: Optionally filter response to only include news items in a certain category.
        includebody: Optionally include full content body for each news item.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Content/Rss/NewsArticles/{page_token}/",
            method="GET",
            categoryfilter=categoryfilter,
            includebody=includebody,
            auth=auth,
        )
    )

search_by_global_name_post(display_name_prefix, page, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
display_name_prefix	str	No description given by bungie.	required
page	int	The zero-based page of results you desire.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/user.py

async def search_by_global_name_post(
    self, display_name_prefix: str, page: int, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Given the prefix of a global display name, returns all users who share that name.

    Args:
        display_name_prefix: _No description given by bungie._
        page: The zero-based page of results you desire.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "displayNamePrefix": display_name_prefix,
    }

    return await self.request(Route(path=f"/User/Search/GlobalName/{page}/", method="POST", data=data, auth=auth))

search_by_global_name_prefix(display_name_prefix, page, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
display_name_prefix	str	The display name prefix you're looking for.	required
page	int	The zero-based page of results you desire.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/user.py

async def search_by_global_name_prefix(
    self, display_name_prefix: str, page: int, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    [OBSOLETE] Do not use this to search users, use SearchByGlobalNamePost instead.

    Args:
        display_name_prefix: The display name prefix you're looking for.
        page: The zero-based page of results you desire.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/User/Search/Prefix/{display_name_prefix}/{page}/", method="GET", auth=auth)
    )

search_content_by_tag_and_type(locale, tag, type, currentpage=None, head=None, itemsperpage=None, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
locale	str		required
tag	str		required
type	str		required
currentpage	Optional[int]	Page number for the search results starting with page 1.	None
head	Optional[bool]	Not used.	None
itemsperpage	Optional[int]	Not used.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/content.py

async def search_content_by_tag_and_type(
    self,
    locale: str,
    tag: str,
    type: str,
    currentpage: Optional[int] = None,
    head: Optional[bool] = None,
    itemsperpage: Optional[int] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Searches for Content Items that match the given Tag and Content Type.

    Args:
        locale:
        tag:
        type:
        currentpage: Page number for the search results starting with page 1.
        head: Not used.
        itemsperpage: Not used.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Content/SearchContentByTagAndType/{tag}/{type}/{locale}/",
            method="GET",
            currentpage=currentpage,
            head=head,
            itemsperpage=itemsperpage,
            auth=auth,
        )
    )

search_content_with_text(locale, ctype=None, currentpage=None, head=None, searchtext=None, source=None, tag=None, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
locale	str		required
ctype	Optional[str]	Content type tag: Help, News, etc. Supply multiple ctypes separated by space.	None
currentpage	Optional[int]	Page number for the search results, starting with page 1.	None
head	Optional[bool]	Not used.	None
searchtext	Optional[str]	Word or phrase for the search.	None
source	Optional[str]	For analytics, hint at the part of the app that triggered the search. Optional.	None
tag	Optional[str]	Tag used on the content to be searched.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/content.py

async def search_content_with_text(
    self,
    locale: str,
    ctype: Optional[str] = None,
    currentpage: Optional[int] = None,
    head: Optional[bool] = None,
    searchtext: Optional[str] = None,
    source: Optional[str] = None,
    tag: Optional[str] = None,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Gets content based on querystring information passed in. Provides basic search and text search capabilities.

    Args:
        locale:
        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.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Content/Search/{locale}/",
            method="GET",
            ctype=ctype,
            currentpage=currentpage,
            head=head,
            searchtext=searchtext,
            source=source,
            tag=tag,
            auth=auth,
        )
    )

search_destiny_entities(search_term, type, page=None, auth=None, *args, **kwargs) async

Gets a page list of Destiny items.

Parameters:

Name	Type	Description	Default
search_term	str	The string to use when searching for Destiny entities.	required
type	str	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'.	required
page	Optional[int]	Page number to return, starting with 0.	None
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def search_destiny_entities(
    self, search_term: str, type: str, page: Optional[int] = None, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Gets a page list of Destiny items.

    Args:
        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'.
        page: Page number to return, starting with 0.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/Destiny2/Armory/Search/{type}/{search_term}/", method="GET", page=page, auth=auth)
    )

search_destiny_player_by_bungie_name(display_name, display_name_code, membership_type, auth=None, *args, **kwargs) async

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

Parameters:

Name	Type	Description	Default
display_name	str	No description given by bungie.	required
display_name_code	int	No description given by bungie.	required
membership_type	int	A valid non-BungieNet membership type, or All. Indicates which memberships to return. You probably want this set to All.	required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def search_destiny_player_by_bungie_name(
    self,
    display_name: str,
    display_name_code: int,
    membership_type: int,
    auth: Optional[AuthData] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Returns a list of Destiny memberships given a global Bungie Display Name. This method will hide overridden memberships due to cross save.

    Args:
        display_name: _No description given by bungie._
        display_name_code: _No description given by bungie._
        membership_type: A valid non-BungieNet membership type, or All. Indicates which memberships to return. You probably want this set to All.
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "displayName": display_name,
        "displayNameCode": display_name_code,
    }

    return await self.request(
        Route(
            path=f"/Destiny2/SearchDestinyPlayerByBungieName/{membership_type}/",
            method="POST",
            data=data,
            auth=auth,
        )
    )

search_help_articles(searchtext, size, auth=None, *args, **kwargs) async

Search for Help Articles.

Parameters:

Name	Type	Description	Default
searchtext	str		required
size	str		required
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/content.py

async def search_help_articles(
    self, searchtext: str, size: str, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Search for Help Articles.

    Args:
        searchtext:
        size:
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path=f"/Content/SearchHelpArticles/{searchtext}/{size}/", method="GET", auth=auth)
    )

search_public_available_clan_fireteams(activity_type, date_range, page, platform, slot_filter, auth, exclude_immediate=None, lang_filter=None, *args, **kwargs) async

Gets a listing of all public fireteams starting now with open slots. Caller is not checked for join criteria so caching is maximized.

Requires Authentication.

Required oauth2 scopes: ReadGroups

Parameters:

Name	Type	Description	Default
activity_type	int	The activity type to filter by.	required
date_range	int	The date range to grab available fireteams.	required
page	int	Zero based page	required
platform	int	The platform filter.	required
slot_filter	int	Filters based on available slots	required
auth	AuthData	Authentication information.	required
exclude_immediate	Optional[bool]	If you wish the result to exclude immediate fireteams, set this to true. Immediate-only can be forced using the dateRange enum.	None
lang_filter	Optional[str]	An optional language filter.	None

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/fireteam.py

async def search_public_available_clan_fireteams(
    self,
    activity_type: int,
    date_range: int,
    page: int,
    platform: int,
    slot_filter: int,
    auth: AuthData,
    exclude_immediate: Optional[bool] = None,
    lang_filter: Optional[str] = None,
    *args,
    **kwargs,
) -> dict:
    """
    Gets a listing of all public fireteams starting now with open slots. Caller is not checked for join criteria so caching is maximized.

    Warning: Requires Authentication.
        Required oauth2 scopes: ReadGroups

    Args:
        activity_type: The activity type to filter by.
        date_range: The date range to grab available fireteams.
        page: Zero based page
        platform: The platform filter.
        slot_filter: Filters based on available slots
        auth: Authentication information.
        exclude_immediate: If you wish the result to exclude immediate fireteams, set this to true. Immediate-only can be forced using the dateRange enum.
        lang_filter: An optional language filter.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/Fireteam/Search/Available/{platform}/{activity_type}/{date_range}/{slot_filter}/{page}/",
            method="GET",
            auth=auth,
            exclude_immediate=exclude_immediate,
            lang_filter=lang_filter,
        )
    )

set_item_lock_state(state, item_id, character_id, membership_type, auth, *args, **kwargs) async

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

Requires Authentication.

Required oauth2 scopes: MoveEquipDestinyItems

Parameters:

Name	Type	Description	Default
state	bool	No description given by bungie.	required
item_id	int	The instance ID of the item for this action request.	required
character_id	int	No description given by bungie.	required
membership_type	Union[Any, int]	No description given by bungie.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def set_item_lock_state(
    self,
    state: bool,
    item_id: int,
    character_id: int,
    membership_type: Union[Any, int],
    auth: AuthData,
    *args,
    **kwargs,
) -> dict:
    """
    Set the Lock State for an instanced item. You must have a valid Destiny Account.

    Warning: Requires Authentication.
        Required oauth2 scopes: MoveEquipDestinyItems

    Args:
        state: _No description given by bungie._
        item_id: The instance ID of the item for this action request.
        character_id: _No description given by bungie._
        membership_type: _No description given by bungie._
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "state": state,
        "itemId": item_id,
        "characterId": character_id,
        "membershipType": membership_type,
    }

    return await self.request(
        Route(path="/Destiny2/Actions/Items/SetLockState/", method="POST", data=data, auth=auth)
    )

set_quest_tracked_state(state, item_id, character_id, membership_type, auth, *args, **kwargs) async

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.

Requires Authentication.

Required oauth2 scopes: MoveEquipDestinyItems

Parameters:

Name	Type	Description	Default
state	bool	No description given by bungie.	required
item_id	int	The instance ID of the item for this action request.	required
character_id	int	No description given by bungie.	required
membership_type	Union[Any, int]	No description given by bungie.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def set_quest_tracked_state(
    self,
    state: bool,
    item_id: int,
    character_id: int,
    membership_type: Union[Any, int],
    auth: AuthData,
    *args,
    **kwargs,
) -> dict:
    """
    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.

    Warning: Requires Authentication.
        Required oauth2 scopes: MoveEquipDestinyItems

    Args:
        state: _No description given by bungie._
        item_id: The instance ID of the item for this action request.
        character_id: _No description given by bungie._
        membership_type: _No description given by bungie._
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "state": state,
        "itemId": item_id,
        "characterId": character_id,
        "membershipType": membership_type,
    }

    return await self.request(
        Route(path="/Destiny2/Actions/Items/SetTrackedState/", method="POST", data=data, auth=auth)
    )

snapshot_loadout(color_hash, icon_hash, name_hash, loadout_index, character_id, membership_type, auth, *args, **kwargs) async

Snapshot a loadout with the currently equipped items.

Requires Authentication.

Required oauth2 scopes: MoveEquipDestinyItems

Parameters:

Name	Type	Description	Default
color_hash	int	No description given by bungie.	required
icon_hash	int	No description given by bungie.	required
name_hash	int	No description given by bungie.	required
loadout_index	int	The index of the loadout for this action request.	required
character_id	int	No description given by bungie.	required
membership_type	Union[Any, int]	No description given by bungie.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def snapshot_loadout(
    self,
    color_hash: int,
    icon_hash: int,
    name_hash: int,
    loadout_index: int,
    character_id: int,
    membership_type: Union[Any, int],
    auth: AuthData,
    *args,
    **kwargs,
) -> dict:
    """
    Snapshot a loadout with the currently equipped items.

    Warning: Requires Authentication.
        Required oauth2 scopes: MoveEquipDestinyItems

    Args:
        color_hash: _No description given by bungie._
        icon_hash: _No description given by bungie._
        name_hash: _No description given by bungie._
        loadout_index: The index of the loadout for this action request.
        character_id: _No description given by bungie._
        membership_type: _No description given by bungie._
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "colorHash": color_hash,
        "iconHash": icon_hash,
        "nameHash": name_hash,
        "loadoutIndex": loadout_index,
        "characterId": character_id,
        "membershipType": membership_type,
    }

    return await self.request(
        Route(path="/Destiny2/Actions/Loadouts/SnapshotLoadout/", method="POST", data=data, auth=auth)
    )

transfer_item(item_reference_hash, stack_size, transfer_to_vault, item_id, character_id, membership_type, auth, *args, **kwargs) async

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

Requires Authentication.

Required oauth2 scopes: MoveEquipDestinyItems

Parameters:

Name	Type	Description	Default
item_reference_hash	int	No description given by bungie.	required
stack_size	int	No description given by bungie.	required
transfer_to_vault	bool	No description given by bungie.	required
item_id	int	The instance ID of the item for this action request.	required
character_id	int	No description given by bungie.	required
membership_type	Union[Any, int]	No description given by bungie.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def transfer_item(
    self,
    item_reference_hash: int,
    stack_size: int,
    transfer_to_vault: bool,
    item_id: int,
    character_id: int,
    membership_type: Union[Any, int],
    auth: AuthData,
    *args,
    **kwargs,
) -> dict:
    """
    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

    Warning: Requires Authentication.
        Required oauth2 scopes: MoveEquipDestinyItems

    Args:
        item_reference_hash: _No description given by bungie._
        stack_size: _No description given by bungie._
        transfer_to_vault: _No description given by bungie._
        item_id: The instance ID of the item for this action request.
        character_id: _No description given by bungie._
        membership_type: _No description given by bungie._
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "itemReferenceHash": item_reference_hash,
        "stackSize": stack_size,
        "transferToVault": transfer_to_vault,
        "itemId": item_id,
        "characterId": character_id,
        "membershipType": membership_type,
    }

    return await self.request(
        Route(path="/Destiny2/Actions/Items/TransferItem/", method="POST", data=data, auth=auth)
    )

unban_member(group_id, membership_id, membership_type, auth, *args, **kwargs) async

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

Requires Authentication.

Required oauth2 scopes: AdminGroups

Parameters:

Name	Type	Description	Default
group_id	int		required
membership_id	int	Membership ID of the member to unban from the group	required
membership_type	int	Membership type of the provided membership ID.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/group_v2.py

async def unban_member(
    self, group_id: int, membership_id: int, membership_type: int, auth: AuthData, *args, **kwargs
) -> dict:
    """
    Unbans the requested member, allowing them to re-apply for membership.

    Warning: Requires Authentication.
        Required oauth2 scopes: AdminGroups

    Args:
        group_id:
        membership_id: Membership ID of the member to unban from the group
        membership_type: Membership type of the provided membership ID.
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(
            path=f"/GroupV2/{group_id}/Members/{membership_type}/{membership_id}/Unban/", method="POST", auth=auth
        )
    )

update_loadout_identifiers(color_hash, icon_hash, name_hash, loadout_index, character_id, membership_type, auth, *args, **kwargs) async

Update the color, icon, and name of a loadout.

Requires Authentication.

Required oauth2 scopes: MoveEquipDestinyItems

Parameters:

Name	Type	Description	Default
color_hash	int	No description given by bungie.	required
icon_hash	int	No description given by bungie.	required
name_hash	int	No description given by bungie.	required
loadout_index	int	The index of the loadout for this action request.	required
character_id	int	No description given by bungie.	required
membership_type	Union[Any, int]	No description given by bungie.	required
auth	AuthData	Authentication information.	required

Raises:

Type	Description
NotFound	404 request
BadRequest	400 request
InvalidAuthentication	If authentication is invalid
TimeoutException	If no connection could be made
BungieDead	Servers are down
AuthenticationTooSlow	The authentication key has expired
BungieException	Relaying the bungie error

Returns:

Type	Description
dict	The json response

Source code in src/bungio/http/routes/destiny2.py

async def update_loadout_identifiers(
    self,
    color_hash: int,
    icon_hash: int,
    name_hash: int,
    loadout_index: int,
    character_id: int,
    membership_type: Union[Any, int],
    auth: AuthData,
    *args,
    **kwargs,
) -> dict:
    """
    Update the color, icon, and name of a loadout.

    Warning: Requires Authentication.
        Required oauth2 scopes: MoveEquipDestinyItems

    Args:
        color_hash: _No description given by bungie._
        icon_hash: _No description given by bungie._
        name_hash: _No description given by bungie._
        loadout_index: The index of the loadout for this action request.
        character_id: _No description given by bungie._
        membership_type: _No description given by bungie._
        auth: Authentication information.

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    data = {
        "colorHash": color_hash,
        "iconHash": icon_hash,
        "nameHash": name_hash,
        "loadoutIndex": loadout_index,
        "characterId": character_id,
        "membershipType": membership_type,
    }

    return await self.request(
        Route(path="/Destiny2/Actions/Loadouts/UpdateLoadoutIdentifiers/", method="POST", data=data, auth=auth)
    )