Usersearch provider

Usersearch - Search for gamertags / userprofiles

pythonxbox.api.provider.usersearch.UserSearchProvider(client)

Bases: BaseProvider

Source code in src/pythonxbox/api/provider/baseprovider.py

def __init__(self, client: "XboxLiveClient") -> None:
    """
    Initialize an the BaseProvider

    Args:
        client (:class:`XboxLiveClient`): Instance of XboxLiveClient
    """
    self.client = client

USERSEARCH_URL = 'https://usersearch.xboxlive.com' class-attribute instance-attribute

HEADERS_USER_SEARCH = {'x-xbl-contract-version': '1'} class-attribute instance-attribute

get_live_search(query, **kwargs) async

Get userprofiles for search query

Parameters:

Name	Type	Description	Default
query	str	Search query	required

Returns:

Type	Description
UserSearchResponse	class:UserSearchResponse: User Search Response

Source code in src/pythonxbox/api/provider/usersearch/__init__.py

async def get_live_search(self, query: str, **kwargs) -> UserSearchResponse:
    """
    Get userprofiles for search query

    Args:
        query: Search query

    Returns:
        :class:`UserSearchResponse`: User Search Response
    """
    url = self.USERSEARCH_URL + "/suggest"
    params = {"q": query}
    resp = await self.client.session.get(
        url, params=params, headers=self.HEADERS_USER_SEARCH, **kwargs
    )
    resp.raise_for_status()
    return UserSearchResponse.model_validate_json(resp.text)