Userstats - Get game statistics

Userstats - Get game statistics

class xbox.webapi.api.provider.userstats.UserStatsProvider(client)[source]

Bases: BaseProvider

USERSTATS_URL = 'https://userstats.xboxlive.com'
HEADERS_USERSTATS = {'x-xbl-contract-version': '2'}
HEADERS_USERSTATS_WITH_METADATA = {'x-xbl-contract-version': '3'}
SEPERATOR = ','
async get_stats(xuid, service_config_id, stats_fields=None, **kwargs)[source]

Get userstats

Parameters:

  • xuid (str) – Xbox User Id

  • service_config_id (str) – Service Config Id of Game (scid)

  • stats_fields (List[GeneralStatsField] | None) – List of stats fields to acquire

Returns:

User Stats Response

Return type:

UserStatsResponse

async get_stats_with_metadata(xuid, service_config_id, stats_fields=None, **kwargs)[source]

Get userstats including metadata for each stat (if available)

Parameters:

  • xuid (str) – Xbox User Id

  • service_config_id (str) – Service Config Id of Game (scid)

  • stats_fields (List[GeneralStatsField] | None) – List of stats fields to acquire

Returns:

User Stats Response

Return type:

UserStatsResponse

async get_stats_batch(xuids, title_id, stats_fields=None, **kwargs)[source]

Get userstats in batch mode

Parameters:

  • xuids (List[str]) – List of XUIDs to get stats for

  • title_id (str) – Game Title Id

  • stats_fields (List[GeneralStatsField] | None) – List of stats fields to acquire

Returns:

User Stats Response

Return type:

UserStatsResponse

async get_stats_batch_by_scid(xuids, service_config_id, stats_fields=None, **kwargs)[source]

Get userstats in batch mode, via scid

Parameters:

  • xuids (List[str]) – List of XUIDs to get stats for

  • service_config_id (str) – Service Config Id of Game (scid)

  • stats_fields (List[GeneralStatsField] | None) – List of stats fields to acquire

Returns:

User Stats Response

Return type:

UserStatsResponse