siegeapi

Auth

email => Ubi account email
password => Ubi account password
token => Pre-generated token

profileid
userid

Both should be the same 👉 ID of the account used to log in

get_player(name, uid, platform)
- name =
- uid =
- platform =
get_player_batch(names, uids, platform)
- names [] =
- uids [] =
- platform =
- [: ]
close()
connect()
get_session()

Auth

email => Ubi account email
password => Ubi account password
token => Pre-generated token
creds_path => Comlete path where you want your credentials to be stored (defaults to siegeapi/creds/[token].json )

profileid
userid

Both should be the same 👉 ID of the account used to log in

get_player(name, uid, platform)
- name =
- uid =
- platform =
get_player_batch(names, uids, platform)
- names [] =
- uids [] =
- platform =
- [: ]
close()
connect()
get_session()

Player

id => Ubi user ID
profile_pic_url_146 => 146px×146px profile pic URL
profile_pic_url_256 => 256px×256px profile pic URL
profile_pic_url_500 => 500px×500px profile pic URL
profile_pic_url => Alias for profile_pic_256
name
level
alpha_pack
xp => XP user has in the current level
total_xp
xp_to_level_up
total_time_played => in seconds
pvp_time_played => in seconds
pve_time_played => in seconds
ranks [: [: | ]] |
casuals [: [: | ]] |
newcomers [: [: | ]] |
events [: [: | ]] |
deathmatch [: [: | ]] |
weapons
trends
operators
maps

total_xp & xp_to_level_up are both calculated from xp
They are not provided by Ubisofts API, but are correct.

set_timespan_dates(, )
- start_date
- end_date
Both dates must be in the format YYYY-MM-DD
load_playtime()
Loads pvp_time_played, pve_time_played & total_time_played
load_progress()
Loads alpha_pack, level, xp, total_xp & xp_to_level_up
load_skill_records(, , )
- seasons [] =
- boards [] =
- regions [] =
Loads alpha_pack, level, xp, total_xp & xp_to_level_up

Valid seasons are 1 - now; Each season is a +1 (e.g. Y7S3 is 27)
You can also go from -1 where -1 is the current season

Valid boards: pvp_ranked, pvp_casual, pvp_newcomer & pvp_warmup

Valid regions: emea, ncsa, apac & global
load_ranked(, )
- season =
- region =
season must be >= to 18 when passing region='global'
load_casual(, )
- season =
- region =
season must be >= to 18 when passing region='global'
load_newcomer(, )
- season =
- region =
season must be >= to 18 when passing region='global'
load_events(, )
- season =
- region =
season must be >= to 18 when passing region='global'
load_deathmatch(, )
- season =
- region =
season must be >= to 18 when passing region='global'
load_trends()
load_weapons()
load_operators()
- op_about =
op_about = True adds a bunch of extra information about the operator
load_maps()

Player

id => Ubi user ID
profile_pic_url_146 => 146px×146px profile pic URL
profile_pic_url_256 => 256px×256px profile pic URL
profile_pic_url_500 => 500px×500px profile pic URL
profile_pic_url => Alias for profile_pic_256
name
level
alpha_pack
xp => XP user has in the current level
total_xp
xp_to_level_up
total_time_played => in seconds
pvp_time_played => in seconds
pve_time_played => in seconds
rank_skill_records [: [: | ]] |
casual_skill_records [: [: | ]] |
ranked_summary [: ] |
casual_summary [: ] |
unranked_summary [: ] |
all_summary [: ] |
weapons
trends
operators
maps

total_xp & xp_to_level_up are both calculated from xp
They are not provided by Ubisofts API, but are correct.

set_timespan_dates(, )
- start_date
- end_date
Both dates must be in the format YYYY-MM-DD
load_playtime()
Loads pvp_time_played, pve_time_played & total_time_played
load_progress()
Loads alpha_pack, level, xp, total_xp & xp_to_level_up
load_skill_records(, , )
- seasons [] =
- boards [] =
- regions [] =
Loads alpha_pack, level, xp, total_xp & xp_to_level_up

Valid seasons are 6 - 28; Each season is a +1 (e.g. Y7S3 is 27)
You can also go from -1 where -1 is the current season

Valid boards: pvp_ranked & pvp_casual

Valid regions: emea, ncsa, apac & global
load_summaries(, , )
- gamemodes [] =
- team_roles [] =
- seasons [] =
gamemodes valid values are "all", "ranked", "unranked", "casual"

team_roles valid values are "all", "Attack", "Defense"

seasons valid values are all seasonal codes found in siegeapi/constants/seasons.py
load_trends()
load_weapons()
load_operators()
- op_about =
op_about = True adds a bunch of extra information about the operator
load_maps()

Player

id => Ubi user ID
profile_pic_url_146 => 146px×146px profile pic URL
profile_pic_url_256 => 256px×256px profile pic URL
profile_pic_url_500 => 500px×500px profile pic URL
profile_pic_url => Alias for profile_pic_256
name
level
total_time_played => in seconds
pvp_time_played => in seconds
pve_time_played => in seconds
rank_skill_records [: [: | ]] |
casual_skill_records [: [: | ]] |
ranked_summary [: ] |
casual_summary [: ] |
unranked_summary [: ] |
all_summary [: ] |
weapons
trends
operators
maps
unranked_profile
ranked_profile
casual_profile
warmup_profile
event_profile

set_timespan_dates(, )
- start_date
- end_date
Both dates must be in the format YYYY-MM-DD
load_playtime()
Loads pvp_time_played, pve_time_played, total_time_played & level
load_skill_records(, , )
- seasons [] =
- boards [] =
- regions [] =
Loads alpha_pack, level, xp, total_xp & xp_to_level_up

Valid seasons are 6 - 28; Each season is a +1 (e.g. Y7S3 is 27)
You can also go from -1 where -1 is the current season

Valid boards: pvp_ranked & pvp_casual

Valid regions: emea, ncsa, apac & global
load_summaries(, , )
- gamemodes [] =
- team_roles [] =
- seasons [] =
gamemodes valid values are "all", "ranked", "unranked", "casual"

team_roles valid values are "all", "Attack", "Defense"

seasons valid values are all seasonal codes found in siegeapi/constants/seasons.py
load_trends()
load_weapons()
load_operators()
- op_about =
op_about = True adds a bunch of extra information about the operator
load_maps()
load_ranked_v2()
Loads unranked_profile, ranked_profile, casual_profile, warmup_profile & event_profile

FullProfile

max_rank
max_rank_id
max_rank_points
rank
rank_id
rank_points
prev_rank_points
next_rank_points
top_rank_position => Champion standings
kills
deaths
abandons
wins
losses
season_id
season_code

get_dict()
Returns vars(self) (see vars() in Python Docs)

Summary

map_name
matches_played
rounds_played
minutes_played
matches_won
matches_lost
rounds_won
rounds_lost
kills
assists
death
headshots
melee_kills
team_kills
opening_kills
opening_deaths
trades
opening_kill_trades
opening_death_trades
revives
win_loss_ratio
kill_death_ratio
headshot_accuracy
kills_per_round
rounds_with_a_kill
rounds_with_multi_kill
rounds_with_opening_kill
rounds_with_opening_death
rounds_with_kost
rounds_survived
rounds_with_an_ace
rounds_with_clutch
time_alive_per_match
time_dead_per_match
distance_per_round

Rank

kills
deaths
last_mmr_change => Last game outcome. No MMR adjustments
prev_rank_mmr
next_rank_mmr
mmr
max_mmr
wins
losses
rank_id
season => e.g.: 27 (Brutal Swarm)
rank => e.g.: Platinum 3
max_rank_id
max_rank => e.g.: Platinum 2
region => e.g.: emea
abandons
skill_mean => skill_mean × 100 ≈ mmr
skill_stdev => How certain the game is of the mmr. More games == smaller number
season_name
season_code

max_rank_id & max_rank is only available for ranked

get_dict()
Returns vars(self) (see vars() in Python Docs)

Trends

all
casual
ranked
unranked
newcomer

get_timespan_dates()
Returns {"start_date": start_date, "end_date": end_date}
Where start_date and end_date are dates given by the API

TrendsGameMode

all
attacker
defender

TrendData

win_loss_ratio
kill_death_ratio
headshot_accuracy
kills_per_round
rounds_with_a_kill
rounds_with_multi_kill
rounds_with_opening_kill
rounds_with_opening_death
rounds_with_kost
rounds_survived
ratio_time_alive_per_match
distance_per_round

TrendDataPoint

low
high
average
trend [: ]
actuals [: ]

Weapons

all
casual
ranked
unranked
newcomer

get_timespan_dates()
Returns {"start_date": start_date, "end_date": end_date}
Where start_date and end_date are dates given by the API

WeaponsRole

attacker
defender

WeaponsGameMode

attacker []
defender []

Weapon

name
kills
headshots
hs_accuracy
rounds_played
rounds_won
rounds_lost
rounds_with_kill
rounds_with_multi_kill
ubi_url => https://staticctf.akamaized.net/... .png
imgur_url => e.g.: https://i.imgur.com/XM1aYZ0.png
type => e.g.: Marksman Rifle

ubi_url, imgur_url & type are not datapoints from Ubisoft's API, but are added by the library.
(If there's something wrong with these, please let me know)

Operators

all
casual
ranked
unranked
newcomer

get_timespan_dates()
Returns {"start_date": start_date, "end_date": end_date}
Where start_date and end_date are dates given by the API

OperatorsGameMode

attacker []
defender []

Operator

name
matches_played
rounds_played
minutes_played
matches_won
matches_lost
rounds_won
rounds_lost
kills
assists
death
headshots
melee_kills
team_kills
opening_kills
opening_deaths
trades
opening_kill_trades
opening_death_trades
revives
win_loss_ratio
kill_death_ratio
headshot_accuracy
kills_per_round
rounds_with_a_kill
rounds_with_multi_kill
rounds_with_opening_kill
rounds_with_opening_death
rounds_with_kost
rounds_survived
rounds_with_an_ace
rounds_with_clutch
time_alive_per_match
time_dead_per_match
distance_per_round

icon_url => Imgur URL
real_name => e.g.: Anja Katarina Janković
birth_place => e.g.: Split, Croatia
date_of_birth => e.g.: April 29th
age => e.g.: 27
roles [] => e.g.: ["Intel Gatherer", "Area Denial", "Anti Roam"]
health => 1/2/3
speed => 1/2/3
hp => 100/110/125
unit => e.g.: NIGHTHAVEN
country_code => ISO 3166-1 alpha-2 country code; e.g.: HR
season_introduced => e.g.: Y6S3

These attributes are only present when calling
With the parameter set to
(Added by me, not by the API. If there's something wrong with these, please let me know.)

Operator

name
matches_played
rounds_played
minutes_played
matches_won
matches_lost
rounds_won
rounds_lost
kills
assists
death
headshots
melee_kills
team_kills
opening_kills
opening_deaths
trades
opening_kill_trades
opening_death_trades
revives
win_loss_ratio
kill_death_ratio
headshot_accuracy
kills_per_round
rounds_with_a_kill
rounds_with_multi_kill
rounds_with_opening_kill
rounds_with_opening_death
rounds_with_kost
rounds_survived
rounds_with_an_ace
rounds_with_clutch
time_alive_per_match
time_dead_per_match
distance_per_round

icon_url => Imgur URL
real_name => e.g.: Anja Katarina Janković
birth_place => e.g.: Split, Croatia
date_of_birth => e.g.: April 29th
age => e.g.: 27
roles [] => e.g.: ["Intel Gatherer", "Area Denial", "Anti Roam"]
unit => e.g.: NIGHTHAVEN
country_code => ISO 3166-1 alpha-2 country code; e.g.: HR
season_introduced => e.g.: Y6S3

These attributes are only present when calling
With the parameter set to
(Added by me, not by the API. If there's something wrong with these, please let me know.)

Maps

all
casual
ranked
unranked
newcomer

get_timespan_dates()
Returns {"start_date": start_date, "end_date": end_date}
Where start_date and end_date are dates given by the API

MapRoles

attacker []
defender []

Map

map_name
matches_played
rounds_played
minutes_played
matches_won
matches_lost
rounds_won
rounds_lost
kills
assists
death
headshots
melee_kills
team_kills
opening_kills
opening_deaths
trades
opening_kill_trades
opening_death_trades
revives
win_loss_ratio
kill_death_ratio
headshot_accuracy
kills_per_round
rounds_with_a_kill
rounds_with_multi_kill
rounds_with_opening_kill
rounds_with_opening_death
rounds_with_kost
rounds_survived
rounds_with_an_ace
rounds_with_clutch
time_alive_per_match
time_dead_per_match
distance_per_round

siegeapi

Version: