Player V3

class siegeapi.Player()

Attributes

• id str ⇒ Ubi user ID
• profile_pic_url_146 str ⇒ 146px × 146px profile pic URL
• profile_pic_url_256 str ⇒ 256px × 256px profile pic URL
• profile_pic_url_500 str ⇒ 500px × 500px profile pic URL
• profile_pic_url str ⇒ Alias for profile_pic_256
• name str ⇒ Players' current Ubisoft username
• level int ⇒ Current level
• alpha_pack int ⇒ Current alpha pack %
• xp int ⇒ XP Gained in the current level
• total_xp int ⇒ Total XP gained
• xp_to_level_up int ⇒ XP needed to level up
• total_time_played int ⇒ In seconds
• pvp_time_played int ⇒ In seconds
• pve_time_played int ⇒ In seconds
• ranks dict[int: dict[str: Rank | None]] ⇒ Ranked seasons data is stored here
• casuals dict[int: dict[str: Rank | None]] ⇒ Casual seasons data is stored here
• newcomers dict[int: dict[str: Rank | None]] ⇒ Newcomer seasons data is stored here
• events dict[int: dict[str: Rank | None]] ⇒ Event seasons data is stored here
• weapons Weapons ⇒ Weapons
• trends Trends ⇒ Trends
• operators Operators ⇒ Operators
• gamemodes Gamemodes ⇒ Gamemodes
• maps Maps ⇒ Maps

Methods

• set_timespan_dates(start_date: str, end_date: str) -> None

  • Sets start & end dates for time constraining the data that gets returned by the API

  Be aware of setting the date too far into the past when getting Trends data because Ubi have been recording them since pretty recently so you will get a lot of empty datapoints

• load_playtime() -> None

  • Loads pvp_time_played, pve_time_played & total_time_played

• load_progress() -> None

  • Loads alpha_pack, level, xp, total_xp & xp_to_level_up

• load_skill_records(self, seasons: list[int] = None, boards: list[str] = None, regions: list[str] = None) -> None

  • Loads seasonal data for multiple seasons, gamemodes (boards) & regions at once
  • All values have defaults get the most data possible (You don't specify season => you get all of them)

  Valid region names are "emea", "ncsa", "apac" & "global"

  Valid board names are "pvp_ranked", "pvp_casual", "pvp_newcomer" & "pvp_warmup"

• load_ranked(season: int = -1, region: str = "emea") -> Rank

  • Loads and returns the ranked Rank object for the specified region and season (-1 = latest season)
  • If the data for the selected season and region have already been loaded it just returns them

  Valid region names are "emea", "ncsa", "apac" & "global"

• load_casual(season: int = -1, region: str = "emea") -> Rank

  • Loads and returns the casual Rank object for the specified region and season (-1 = latest season)
  • If the data for the selected season and region have already been loaded it just returns them

  Valid region names are "emea", "ncsa", "apac" & "global"

• load_newcomer(season: int = -1, region: str = "emea") -> Rank

  • Loads and returns the newcomer Rank object for the specified region and season (-1 = latest season)
  • If the data for the selected season and region have already been loaded it just returns them

  Valid region names are "emea", "ncsa", "apac" & "global"

• load_events(season: int = -1, region: str = "emea") -> Rank

  • Loads and returns the events Rank object for the specified region and season (-1 = latest season)
  • If the data for the selected season and region have already been loaded it just returns them

  Valid region names are "emea", "ncsa", "apac" & "global"

• load_trends(block_duration: TrendBlockDuration = TrendBlockDuration.WEEKLY) -> Trends

  • Loads and returns Trend data to Player.trends and returns said data
  • TrendBlockDuration can be one of the following .DAILY / .WEEKLY / .MONTHLY

• load_weapons() -> Weapons

  • Loads and returns Weapons data

• load_operators() -> Operators

  • Loads and returns Operators data

• load_gamemodes() -> Gamemodes

  • Loads and returns Gamemodes data

• load_maps() -> Maps

  • Loads and returns Maps data