Census Payload Reference¶

Base Classes & Interfaces¶

class auraxium.models.base.Payload¶

A payload received through the REST or WebSocket interface.

Instances of this class are read-only.

class auraxium.models.base.RESTPayload¶

Bases: Payload

A JSON payload received through the REST interface.

This Payload subclass implicitly converts NULL strings to None.

class auraxium.models.base.FallbackMixin¶

A mixin class used to provide hard-coded fallback instances.

Some collections are out of date and do not contain all required data. This mixin provides a hook to insert this missing data into data types while not causing issues if the API ends up being updated to include these missing types.

Subclasses must implement the fallback_hook() method to inject custom fallback data into the type. If no value can be provided for a given id_, a KeyError should be raised.

abstract static fallback_hook(id_: int) → auraxium.types.CensusData¶

Hook for retrieving hard-coded fallback data.

Some collections are missing data or providing bad data for some or all IDs. This method provides a non-destructive hook for inserting missing data if the API cannot produce a value.

Parameters:: id (int) – The ID of the value to look up.
Raises:: KeyError – Raised if no fallback data can be provided for the given id_.
Returns:: A fallback payload to treat as if it came from the server.

class auraxium.models.base.ImageData(*, image_id=None, image_set_id=None, image_path=None)¶

Mixin dataclass for types supporting image access.

image_id: int | None¶: The default image ID of the object.

image_set_id: int | None¶: The image set ID of the object.

image_path: str | None¶: The base path to the default image_id.

class auraxium.models.base.Event(*, event_name, timestamp, world_id)¶

Bases: Payload

An event returned via the ESS websocket connection.

event_name: str: The raw event name linked to this type. Generally identical to the name of the class.

timestamp: int: The UTC timestamp of the event. May be used to infer latency to the event streaming endpoint.

world_id: int: ID of the World whose event streaming endpoint broadcast the event.

Note

While this base class is defined in and accessible from the auraxium.models.base module, its canonical location is the auraxium.event namespace.

class auraxium.models.base.CharacterEvent¶

Mixin class for character-centric events.

Events inheriting from this class support subscription by character ID.

class auraxium.models.base.WorldEvent¶

Mixin class for world-centric events.

Events inheriting from this class support subscription by world ID.

REST Payloads¶

Object-Mirror Payloads¶

The following payloads are used as the underlying data container for the objects defined in auraxium.ps2. To avoid needing to document these values in both places, the attribute annotations are omitted for any payloads with an exact equivalent in the auraxium.ps2 namespace.

class auraxium.models.AbilityData(*, ability_id, ability_type_id, expire_msec=None, first_use_delay_msec=None, next_use_delay_msec=None, reuse_delay_msec=None, resource_type_id=None, resource_first_cost=None, resource_cost_per_msec=None, distance_max=None, radius_max=None, flag_toggle=None, param1=None, param2=None, param3=None, param4=None, param5=None, param6=None, param7=None, param8=None, param9=None, param10=None, param11=None, param12=None, param13=None, param14=None, string1=None, string2=None, string3=None, string4=None)¶

Data class for auraxium.ps2.Ability.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.AbilityTypeData(*, ability_type_id, description=None, param1=None, param2=None, param3=None, param4=None, param5=None, param6=None, param7=None, param8=None, param9=None, param10=None, param11=None, param12=None, param13=None, param14=None, string1=None, string2=None, string3=None, string4=None)¶

Data class for auraxium.ps2.AbilityType.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.AchievementData(*, image_id=None, image_set_id=None, image_path=None, achievement_id, item_id, objective_group_id, reward_id, repeatable, name, description)¶

Data class for auraxium.ps2.Achievement.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.ArmourInfoData(*, armor_info_id, armor_facing_id, armor_percent, armor_amount=None, description)¶

Data class for auraxium.ps2.ArmourInfo.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.CharacterData(*, character_id, name, faction_id, head_id, title_id, times, certs, battle_rank, profile_id, daily_ribbon, prestige_level)¶

Data class for auraxium.ps2.Character.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class BattleRank(*, value, percent_to_next)¶

Object representation of the “battle_rank” sub-key.

value: int¶: The current battle rank of the character.

percent_to_next: float¶: The progress to the next battle rank.

model_config = {'extra': 'ignore', 'frozen': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields = {'percent_to_next': FieldInfo(annotation=float, required=True), 'value': FieldInfo(annotation=int, required=True)}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class Certs(*, earned_points, gifted_points, spent_points, available_points, percent_to_next)¶

Object representation of the “certs” sub-key.

earned_points: int¶: Certification points the player has ever earned.

gifted_points: int¶: Certification points the player was gifted through events.

spent_points: int¶: Certification points the character has spent.

available_points: int¶: The current certification point balance of the character.

percent_to_next: float¶: The progress to the next certification point for the character.

model_config = {'extra': 'ignore', 'frozen': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields = {'available_points': FieldInfo(annotation=int, required=True), 'earned_points': FieldInfo(annotation=int, required=True), 'gifted_points': FieldInfo(annotation=int, required=True), 'percent_to_next': FieldInfo(annotation=float, required=True), 'spent_points': FieldInfo(annotation=int, required=True)}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class DailyRibbon(*, count, time=None, date=None)¶

Object representation of the “daily_ribbon” sub-key.

Note

As of spring 2021, daily ribbon boni are disabled and unused.

count: int¶: The number of daily ribbon boni available.

time: int¶: The time the next daily ribbon bonus will be granted.

date¶
type: str: Human-readable version of time.

model_config = {'extra': 'ignore', 'frozen': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields = {'count': FieldInfo(annotation=int, required=True), 'date': FieldInfo(annotation=Union[str, NoneType], required=False), 'time': FieldInfo(annotation=Union[int, NoneType], required=False)}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class Name(*, first, first_lower)¶

Object representation of the “name” sub-key.

Note

This object supports casting this object to str, which will return the name of the player.

first: str¶: Unique name of the player.

first_lower: str¶: Lowercase version of first. Useful for case-insensitive name lookups without requiring the use of a case-insensitive query.

model_config = {'extra': 'ignore', 'frozen': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields = {'first': FieldInfo(annotation=str, required=True), 'first_lower': FieldInfo(annotation=str, required=True)}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class Times(*, creation, creation_date, last_save, last_save_date, last_login, last_login_date, login_count, minutes_played)¶

Object representation of the “times” sub-key.

creation: int¶: The time the character was created.

creation_date: str¶: Human-readable version of creation.

last_save: int¶: The last time the character was updated. This roughly matches the last time the character logged out.

last_save_date: str¶: Human-readable version of last_save.

last_login: int¶: The last time the character logged in.

last_login_date: str¶: Human-readable version of last_login_date.

login_count: int¶: The number of times the character has logged in.

minutes_played: int¶: The total number of minutes this character was logged in.

model_config = {'extra': 'ignore', 'frozen': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields = {'creation': FieldInfo(annotation=int, required=True), 'creation_date': FieldInfo(annotation=str, required=True), 'last_login': FieldInfo(annotation=int, required=True), 'last_login_date': FieldInfo(annotation=str, required=True), 'last_save': FieldInfo(annotation=int, required=True), 'last_save_date': FieldInfo(annotation=str, required=True), 'login_count': FieldInfo(annotation=int, required=True), 'minutes_played': FieldInfo(annotation=int, required=True)}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class auraxium.models.CurrencyData(*, currency_id, name, icon_id, inventory_cap)¶

Data class for auraxium.ps2.Currency.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.DirectiveData(*, image_id=None, image_set_id=None, image_path=None, directive_id, directive_tree_id, directive_tier_id, objective_set_id, qualify_requirement_id=None, name, description=None)¶

Data class for auraxium.ps2.Directive.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.DirectiveTierData(*, image_id=None, image_set_id=None, image_path=None, directive_tier_id, directive_tree_id, reward_set_id=None, directive_points, completion_count, name)¶

Data class for auraxium.ps2.DirectiveTier.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.DirectiveTreeCategoryData(*, directive_tree_category_id, name)¶

Data class for auraxium.ps2.DirectiveTreeCategory.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.DirectiveTreeData(*, image_id=None, image_set_id=None, image_path=None, directive_tree_id, directive_tree_category_id, name, description=None)¶

Data class for auraxium.ps2.DirectiveTree.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.EffectData(*, effect_id, effect_type_id, ability_id, target_type_id, resist_type_id, is_drain, duration_seconds, param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11, param12, param13)¶

Data class for auraxium.ps2.Effect.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.EffectTypeData(*, effect_type_id, description, param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11, param12, param13)¶

Data class for auraxium.ps2.EffectType.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.ExperienceData(*, experience_id, description, xp)¶

Data class for auraxium.ps2.Experience.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.ExperienceRankData(*, rank, xp_max, vs, vs_image_path, nc, nc_image_path, tr, tr_image_path)¶

Data class for auraxium.ps2.Experience.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class EmpireData(*, title, image_set_id, image_id)¶

Object representation of an empire-specific sub-key.

title: auraxium.types.LocaleData¶: The localised title for this experience rank.

image_set_id: int¶: The image set associated with this rank.

image_id: int¶: The default image asset for this rank.

model_config = {'extra': 'ignore', 'frozen': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields = {'image_id': FieldInfo(annotation=int, required=True), 'image_set_id': FieldInfo(annotation=int, required=True), 'title': FieldInfo(annotation=LocaleData, required=True)}¶

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class auraxium.models.FacilityTypeData(*, facility_type_id, description)¶

Data class for auraxium.ps2.FacilityType.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.FactionData(*, image_id=None, image_set_id=None, image_path=None, faction_id, name, code_tag, user_selectable)¶

Data class for auraxium.ps2.Faction.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.FireGroupData(*, fire_group_id, chamber_duration_ms=None, transition_duration_ms=None, spool_up_ms=None, spool_up_initial_refire_ms=None, can_chamber_ironsights=None)¶

Data class for auraxium.ps2.FireGroup.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.FireModeData(*, fire_mode_id, fire_mode_type_id=None, ability_id=None, ammo_slot=None, automatic, grief_immune=None, iron_sights=None, laser_guided=None, move_modifier, projectile_speed_override=None, sprint_fire=None, turn_modifier, use_in_water=None, zoom_default, cof_override=None, cof_pellet_spread=None, cof_range, cof_recoil=None, cof_scalar, cof_scalar_moving, player_state_group_id, damage_direct_effect_id=None, damage_head_multiplier=None, damage_indirect_effect_id=None, damage_legs_multiplier=None, fire_ammo_per_shot=None, fire_auto_fire_ms=None, fire_burst_count=None, fire_charge_up_ms=None, fire_delay_ms=None, fire_detect_range=None, fire_duration_ms=None, fire_refire_ms=None, fire_pellets_per_shot=None, heat_per_shot=None, heat_recovery_delay_ms=None, heat_threshold=None, lockon_acquire_close_ms=None, lockon_acquire_far_ms=None, lockon_acquire_ms=None, lockon_angle=None, lockon_lose_ms=None, lockon_maintain=None, lockon_radius=None, lockon_range=None, lockon_range_close=None, lockon_range_far=None, lockon_required=None, recoil_angle_max=None, recoil_angle_min=None, recoil_first_shot_modifier=None, recoil_horizontal_max=None, recoil_horizontal_max_increase=None, recoil_horizontal_min=None, recoil_horizontal_min_increase=None, recoil_horizontal_tolerance=None, recoil_increase=None, recoil_increase_crouched=None, recoil_magnitude_max=None, recoil_magnitude_min=None, recoil_max_total_magnitude=None, recoil_recovery_acceleration=None, recoil_recovery_delay_ms=None, recoil_recovery_rate=None, recoil_shots_at_min_magnitude=None, reload_block_auto=None, reload_continuous=None, reload_ammo_fill_ms=None, reload_chamber_ms=None, reload_loop_start_ms=None, reload_loop_end_ms=None, reload_time_ms=None, sway_amplitude_x=None, sway_amplitude_y=None, sway_can_steady=None, sway_period_x=None, sway_period_y=None, armor_penetration=None, max_damage=None, max_damage_ind=None, max_damage_ind_radius=None, max_damage_range=None, min_damage=None, min_damage_ind=None, min_damage_ind_radius=None, min_damage_range=None, shield_bypass_pct=None, description=None)¶

Data class for auraxium.ps2.FireMode.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.ItemCategoryData(*, item_category_id, name)¶

Data class for auraxium.ps2.ItemCategory.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.ItemData(*, image_id=None, image_set_id=None, image_path=None, item_id, item_type_id=None, item_category_id=None, activatable_ability_id=None, passive_ability_id=None, is_vehicle_weapon, name=None, description=None, faction_id=None, max_stack_size, skill_set_id=None, is_default_attachment)¶

Data class for auraxium.ps2.Item.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.ItemTypeData(*, item_type_id, name, code)¶

Data class for auraxium.ps2.ItemType.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.LoadoutData(*, loadout_id, profile_id, faction_id, code_name)¶

Data class for auraxium.ps2.Loadout.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.MapHexData(*, zone_id, map_region_id, x, y, hex_type, type_name)¶

Data class for auraxium.ps2.MapHex.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.MapRegionData(*, map_region_id, zone_id, facility_id=None, facility_name, facility_type_id=None, facility_type=None, location_x=None, location_y=None, location_z=None, reward_amount=None, reward_currency_id=None)¶

Data class for auraxium.ps2.MapRegion.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.MarketingBundleData(*, marketing_bundle_id, name, description, image_id, cert_price, station_cash_price, release_time)¶

Data class for auraxium.ps2.MarketingBundle.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.MarketingBundleSingleData(*, marketing_bundle_id, item_id, item_quantity, station_cash_price, cert_price, release_time)¶

Data class for auraxium.ps2.MarketingBundleSingle.

This is generally used for the single-item “bundles” in the depot, i.e. any single weapon or cosmetic purchasable on its own.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.MetagameEventData(*, metagame_event_id, name, description, type, experience_bonus=None)¶

Data class for auraxium.ps2.MetagameEvent.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.ObjectiveData(*, objective_id, objective_type_id, objective_group_id, param1=None, param2=None, param3=None, param4=None, param5=None, param6=None, param7=None, param8=None, param9=None)¶

Data class for auraxium.ps2.Objective.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.ObjectiveTypeData(*, objective_type_id, description, param1=None, param2=None, param3=None, param4=None, param5=None, param6=None, param7=None, param8=None, param9=None)¶

Data class for auraxium.ps2.ObjectiveType.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.OutfitData(*, outfit_id, name, name_lower, alias, alias_lower, time_created, time_created_date, leader_character_id, member_count)¶

Data class for auraxium.ps2.Outfit.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.OutfitMemberData(*, outfit_id, character_id, member_since, member_since_date, rank, rank_ordinal)¶

Data class for auraxium.ps2.OutfitMember.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.ProfileData(*, profile_id, description)¶

Data class for auraxium.ps2.Profile.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.ProjectileData(*, projectile_id, projectile_flight_type_id, speed, speed_max=None, acceleration=None, turn_rate=None, lifespan=None, drag=None, gravity=None, lockon_acceleration=None, lockon_lifespan=None, arm_distance=None, tether_distance=None, detonate_distance=None, detonate_on_contact=None, sticky=None, sticks_to_players=None, lockon_lose_angle=None, lockon_seek_in_flight=None)¶

Data class for auraxium.ps2.Projectile.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.RegionData(*, region_id, zone_id, initial_faction_id, name)¶

Data class for auraxium.ps2.Region.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.ResistInfoData(*, resist_info_id, resist_type_id, resist_percent=None, resist_amount=None, multiplier_when_headshot=None, description)¶

Data class for auraxium.ps2.ResistInfo.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.ResistTypeData(*, resist_type_id, description)¶

Data class for auraxium.ps2.ResistType.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.ResourceTypeData(*, resource_type_id, description)¶

Data class for auraxium.ps2.ResourceType.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.RewardData(*, reward_id, reward_type_id, count_min, count_max, param1, param2=None, param3=None, param4=None, param5=None)¶

Data class for auraxium.ps2.Reward.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.RewardTypeData(*, reward_type_id, description, count_min, count_max, param1, param2=None, param3=None, param4=None, param5=None)¶

Data class for auraxium.ps2.RewardType.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.SkillData(*, image_id=None, image_set_id=None, image_path=None, skill_id, skill_line_id, skill_line_index, skill_points, grant_item_id=None, name, description=None)¶

Data class for auraxium.ps2.Skill.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.SkillCategoryData(*, image_id=None, image_set_id=None, image_path=None, skill_category_id, skill_set_id, skill_set_index, skill_points, name, description=None)¶

Data class for auraxium.ps2.SkillCategory.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.SkillLineData(*, image_id=None, image_set_id=None, image_path=None, skill_line_id, skill_points, skill_category_id=None, skill_category_index=None, name, description=None)¶

Data class for auraxium.ps2.SkillLine.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.SkillSetData(*, image_id=None, image_set_id=None, image_path=None, skill_set_id, skill_points=None, required_item_id=None, name, description=None)¶

Data class for auraxium.ps2.SkillSet.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.TitleData(*, title_id, name)¶

Data class for auraxium.ps2.Title.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.VehicleAttachmentData(*, item_id, vehicle_id, faction_id, description, slot_id)¶

Data class for auraxium.ps2.VehicleAttachment.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.VehicleData(*, image_id=None, image_set_id=None, image_path=None, vehicle_id, name, description=None, type_id, type_name, cost=None, cost_resource_id=None)¶

Data class for auraxium.ps2.Vehicle.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.WeaponData(*, weapon_id, weapon_group_id=None, turn_modifier, move_modifier, sprint_recovery_ms=None, equip_ms, unequip_ms=None, to_iron_sights_ms=None, from_iron_sights_ms=None, heat_capacity=None, heat_bleed_off_rate=None, heat_overheat_penalty_ms=None, melee_detect_width=None, melee_detect_height=None)¶

Data class for auraxium.ps2.Weapon.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.WorldData(*, world_id, state, name, description=None)¶

Data class for auraxium.ps2.World.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.ZoneData(*, zone_id, code, hex_size, name, description)¶

Data class for auraxium.ps2.Zone.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.ZoneEffectData(*, zone_effect_id, zone_effect_type_id, ability_id, param1=None, param2=None, param3=None, param4=None, param5=None, param6=None)¶

Data class for auraxium.ps2.ZoneEffect.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

class auraxium.models.ZoneEffectTypeData(*, zone_effect_type_id, description, param1, param2, param3, param4, param5, param6)¶

Data class for auraxium.ps2.ZoneEffectType.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

Relational Payloads¶

These are payloads that are returned as part of intermediate tables with no immediate equivalent in the auraxium.ps2 namespace.

class auraxium.models.CharacterAchievement(*, character_id, achievement_id, earned_count, start, start_date, finish, finish_date, last_save, last_save_date)¶

Data container for a character’s achievement status.

character_id: int¶: The ID of the character for this entry.

achievement_id: int¶: The ID of the achievement for this entry.

earned_count:: How often the character has earned the given achievement.

start: int¶

The UTC timestamp the character started progression towards this achievement at.

For repeatable achievements, this marks the last time the achievement was gained.

start_date: str¶: Human-readable version of start.

finish: int¶

The time the character completed this achievement. Only valid for one-time achievements such as medals.

For repeatable achievements, this is always 0.

finish_date: str¶: Human-readable version of finish.

last_save: int¶: The last time the character gained this achievement at as a UTC timestamp.

last_save_date: str¶: Human-readable version of last_save.

class auraxium.models.CharacterDirective(*, character_id, directive_tree_id, directive_id, completion_time, completion_time_date)¶

Data container for a character’s directive status.

character_id: int¶: The ID of the character for this entry.

directive_tree_id: int¶: The ID of the directive tree for this entry.

completion_time: int¶: The time the character completed this directive.

completion_time_date: str¶: Human-readable version of completion_time.

class auraxium.models.CharacterDirectiveObjective(*, character_id, directive_id, objective_id, objective_group_id, status, state_data)¶

Data container for a characters’s directive progress.

character_id: int¶: The ID of the character for this entry.

directive_id: int¶: The ID of the directive for this entry.

objective_id: int¶: ID of the objective.

objective_group_id: int¶: (More info needed)

status: int¶: The status of this objective.

state_data: int¶: Extra data for this state.

class auraxium.models.CharacterDirectiveTier(*, character_id, directive_tree_id, directive_tier_id, completion_time, completion_time_date)¶

Data container for character directive tier progress.

character_id: int¶: ID of the character.

directive_tree_id: int¶: ID of the directive tree.

directive_tier_id: int¶: ID of the directive tier.

completion_time: int¶: When this tier was completed, or zero if not yet completed.

completion_time_date: int¶: String version of completion_time.

class auraxium.models.CharacterDirectiveTree(*, character_id, directive_tree_id, current_directive_tier_id, current_level, completion_time, completion_time_date)¶

Data container for character directive tree progress.

character_id: int¶: ID of the character.

directive_tree_id: int¶: The directive tree for this entry.

current_directive_tier_id: int¶: The current tier the character is on for the given directive tree.

current_level: int¶: The current level in this directive tree.

completion_time: int¶: When the directive tree was compled, or zero if not yet completed.

completion_time_date: int¶: String version of completion_time.

class auraxium.models.OutfitRankData(*, outfit_id, ordinal, name, description)¶

Data class for custom, outfit-specific ranks.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

outfit_id: int¶: The ID of the Outfit that defined this rank.

ordinal: int¶: The ordinal position of this rank in the outfit’s roster. Lower values denote a higher rank.

name: str¶: The custom name of the outfit rank.

description: str¶: The description of the rank.

class auraxium.models.PlayerStateGroup(*, player_state_group_id, player_state_id, can_iron_sight, cof_grow_rate=None, cof_max, cof_min, cof_recovery_delay_ms=None, cof_recovery_rate, cof_shots_before_penalty=None, cof_recovery_delay_threshold=None, cof_turn_penalty=None)¶

A fire-mode-specific state group.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

player_state_group_id: int¶: The ID of the player state group.

player_state_id: int¶: The PlayerState enum value of this entry.

can_iron_sight: bool¶: Whether ADS is allowed in this state.

cof_grow_rate: float | None¶: Cone of fire growth per shot.

cof_max: float¶: The maximum cone-of-fire for this state.

cof_min: float¶: The minimum cone-of-fire for this state.

cof_recovery_delay_ms: int | None¶: The time before the cone-of-fire will start to reset after the user stopped firing.

cof_recovery_rate: int | None¶: The speed at which the cone-of-fire will return to its starting value after the user stopped firing.

cof_shots_before_penalty: int | None¶: The number of “free shots” before cone-of-fire penalties are applied.

cof_recovery_delay_threshold: int | None¶: (Not yet documented)

cof_turn_penalty: int | None¶: (Not yet documented)

class auraxium.models.WeaponAmmoSlot(*, weapon_id, weapon_slot_index, clip_size, capacity, refill_ammo_rate=None, refill_ammo_delay_ms=None)¶

Data class for weapon ammo slot data.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

weapon_id: int¶: The ID of the associated Weapon.

weapon_slot_index: int¶: The position of the ammo type in the list of ammo types.

clip_size: int¶: The number of bullets in a clip for this ammo slot.

capacity: int¶: The maximum amount of ammo that can be held with this ammo type.

refill_ammo_rate: int¶: The amount of ammo being replenished every ammo refill tick.

refill_ammo_delay_ms: int¶: The time between two ammo replenishment ticks.

class auraxium.models.WeaponDatasheet(*, item_id, direct_damage=None, indirect_damage=None, damage, damage_min, damage_max, fire_cone, fire_cone_min, fire_cone_max, fire_rate_ms, fire_rate_ms_min, fire_rate_mx_max, reload_ms, reload_ms_min, reload_ms_max, clip_size, capacity, range, show_clip_size, show_fire_modes, show_range)¶

Data class for weapon datasheets.

This class mirrors the payload data returned by the API, you may use its attributes as keys in filters or queries.

Note

The data found herein is generally less reliable than the sources it was collected from, such as FireMode or Projectile.

This data is mostly used for display in the depot and is often not inaccurate.

item_id: int¶: The item the datasheet is for.

direct_damage: int | None¶: Direct hit damage.

indirect_damage: int | None¶: The maximum indirect hit (i.e. splash) damage.

damage: int¶: (Not yet documented)

damage_max: int¶: (Not yet documented)

fire_cone: float¶: (Not yet documented)

fire_cone_min: float¶: (Not yet documented)

fire_cone_max: float¶: (Not yet documented)

fire_rate_ms: int¶: (Not yet documented)

fire_rate_ms_min: int¶: (Not yet documented)

fire_rate_mx_max: int¶: (Not yet documented)

reload_ms: int¶: (Not yet documented)

reload_ms_min: int¶: (Not yet documented)

reload_ms_max: int¶: (Not yet documented)

clip_size: int¶: The clip size for the default ammo type.

capacity: int¶: The total ammo capacity for the default ammo type.

range: auraxium.types.LocaleData¶: The localised description of the weapon range (i.e. “Medium”, “Long”, etc.).

show_clip_size: bool¶: Whether to display the clip size data to the user.

show_fire_modes: bool¶: Whether to display the list of fire modes to the user.

show_range: bool¶: Whether to display the range data to the user.

Events¶

Note

While the following objects are defined in and available through the auraxium.models module, their canonical location is within the auraxium.event namespace.

class auraxium.models.AchievementAdded: Alias of auraxium.event.AchievementAdded.

class auraxium.models.BattleRankUp: Alias of auraxium.event.BattleRankUp.

class auraxium.models.ContinentLock: Alias of auraxium.event.ContinentLock.

class auraxium.models.Death(*, event_name, timestamp, world_id, attacker_character_id, attacker_fire_mode_id, attacker_loadout_id, attacker_vehicle_id, attacker_weapon_id, attacker_team_id, character_id, character_loadout_id, is_critical=None, is_headshot, team_id, vehicle_id=None, zone_id)

A character has been killed.

If the attacker and victim ID are identical, the character has killed themselves (e.g. with explosives).

An attacker ID of 0 indicates that the player has died to non-player sources like fall damage, or spawn room pain fields.

attacker_character_id: int¶: The ID of the killing Character.

attacker_fire_mode_id: int¶: ID of the FireMode used.

attacker_loadout_id: int¶: ID of the Loadout of the attacker.

attacker_vehicle_id: int¶: ID of the Vehicle of the attacker.

attacker_weapon_id: int¶: ID of the Item used by the attacker.

Important

The reference above is not an error, this field reports the item ID of the weapon, not the weapon ID.

attacker_team_id: int¶: ID of the team of the attacker.

character_id: int¶: ID of the Character that was killed.

character_loadout_id: int¶: ID of the Loadout of the victim.

is_critical: bool | None¶: Whether the killing blow dealt critical damage.

Note

This value is always false.

is_headshot: bool¶: Whether the killing blow was dealt via headshot.

team_id: int¶: Team ID of the victim.

vehicle_id: int | None¶: The type of Vehicle the victim was in at the time of death, if any.

zone_id: int¶: The current Zone of the character.

timestamp: int¶: The UTC timestamp of the event. May be used to infer latency to the event streaming endpoint.

world_id: int¶: ID of the World whose event streaming endpoint broadcast the event.

Alias of auraxium.event.Death.

class auraxium.models.FacilityControl(*, event_name, timestamp, world_id, duration_held, facility_id, new_faction_id, old_faction_id, outfit_id, zone_id)

A facility has switched factions.

This is generally due to hostile takeover, but is also dispatched when a coninent is locked or unlocked server-side (e.g. due to an alert ending).

duration_held: int¶: The amount of time the base was in the old faction’s ownership in seconds.

facility_id: int¶: The facility ID of the base.

new_faction_id: int¶: ID of the new Faction.

old_faction_id: int¶: ID of the old Faction.

outfit_id: int¶: ID of the Outfit that was awarded the base capture.

zone_id: int¶: The Zone of the captured base.

timestamp: int¶: The UTC timestamp of the event. May be used to infer latency to the event streaming endpoint.

world_id: int¶: ID of the World whose event streaming endpoint broadcast the event.

Alias of auraxium.event.FacilityControl.

class auraxium.models.GainExperience(*, event_name, timestamp, world_id, amount, character_id, experience_id, loadout_id, other_id, zone_id)

A character has gained a tick of experience.

amount: int¶: The amount of experience gained.

character_id: int¶: ID of the Character that earned experience.

experience_id: int¶: The source of the experience gain.

Note

Not all types of experience gain have a cooresponding Experience entry.

loadout_id: int¶: The current Loadout of the character.

other_id: int¶: The ID of another entity involved in the experience acquisition. For heals, this would be the healed ally, for spots the enemy vehicle or player spottet, etc.

zone_id: int¶: The current Zone of the character.

timestamp: int¶: The UTC timestamp of the event. May be used to infer latency to the event streaming endpoint.

world_id: int¶: ID of the World whose event streaming endpoint broadcast the event.

Alias of auraxium.event.GainExperience.

class auraxium.models.ItemAdded(*, event_name, timestamp, world_id, character_id, context, item_count, item_id, zone_id)

A character has been granted an item.

This includes internal flags and invisible items used to control outfit resources and war assets.

character_id: int¶: ID of the character that has been awarded an item.

context: str¶: The reason or mechanic that led to the item being awarded. Notably, this includes outfit resource use.

item_count: str¶: The number of items that were added.

item_id: int¶: The Item that was added.

zone_id: int¶: The current Zone of the character.

timestamp: int¶: The UTC timestamp of the event. May be used to infer latency to the event streaming endpoint.

world_id: int¶: ID of the World whose event streaming endpoint broadcast the event.

Alias of auraxium.event.ItemAdded.

class auraxium.models.MetagameEvent(*, event_name, timestamp, world_id, experience_bonus, faction_nc, faction_tr, faction_vs, instance_id, metagame_event_id, metagame_event_state, metagame_event_state_name, zone_id=-1)

A metagame event (i.e. alert) has changed state.

experience_bonus: int¶: The experience bonus applied for the duration of the event (a value of 25 denotes a 25% experience bonus for all participants)

faction_nc: float¶: The current event score of the NC.

faction_tr: float¶: The current event score of the TR.

faction_vs: float¶: The current event score of the NC.

metagame_event_id: int¶: ID of the MetagameEvent that changed state.

metagame_event_state: int¶: The new MetagameEventState of the event.

zone_id: int¶: The Zone the event is taking place in.

timestamp: int¶: The UTC timestamp of the event. May be used to infer latency to the event streaming endpoint.

world_id: int¶: ID of the World whose event streaming endpoint broadcast the event.

Alias of auraxium.event.MetagameEvent.

class auraxium.models.PlayerFacilityCapture(*, event_name, timestamp, world_id, character_id, facility_id, outfit_id, zone_id)

A player has participated in capturing a facility.

character_id: int¶: The ID of the Character that participated in the capture.

facility_id: int¶: ID of the facility that was captured.

outfit_id: int¶: The Outfit that was awarded the facility.

zone_id: int¶: The current Zone of the character.

timestamp: int¶: The UTC timestamp of the event. May be used to infer latency to the event streaming endpoint.

world_id: int¶: ID of the World whose event streaming endpoint broadcast the event.

Alias of auraxium.event.PlayerFacilityCapture.

class auraxium.models.PlayerFacilityDefend(*, event_name, timestamp, world_id, character_id, facility_id, outfit_id, zone_id)

A player has participated in defending a facility.

character_id: int¶: The ID of the Character that participated in the defence.

facility_id: int¶: ID of the facility that was defended.

outfit_id: int¶: The Outfit that currently owns the facility.

zone_id: int¶: The current Zone of the character.

timestamp: int¶: The UTC timestamp of the event. May be used to infer latency to the event streaming endpoint.

world_id: int¶: ID of the World whose event streaming endpoint broadcast the event.

Alias of auraxium.event.PlayerFacilityDefend.

class auraxium.models.PlayerLogin(*, event_name, timestamp, world_id, character_id)

A player has logged into the game.

character_id: int¶: The Character that logged in.

timestamp: int¶: The UTC timestamp of the event. May be used to infer latency to the event streaming endpoint.

world_id: int¶: ID of the World whose event streaming endpoint broadcast the event.

Alias of auraxium.event.PlayerLogin.

class auraxium.models.PlayerLogout(*, event_name, timestamp, world_id, character_id)

A player has logged out.

character_id: int¶: The Character that logged off.

timestamp: int¶: The UTC timestamp of the event. May be used to infer latency to the event streaming endpoint.

world_id: int¶: ID of the World whose event streaming endpoint broadcast the event.

Alias of auraxium.event.PlayerLogout.

class auraxium.models.SkillAdded(*, event_name, timestamp, world_id, character_id, skill_id, zone_id)

A player has unlocked a skill (i.e. certification or ASP).

character_id: int¶: The Character that gained a new skill.

skill_id: int¶: The Skill the character unlocked.

zone_id: int¶: The current Zone of the character.

timestamp: int¶: The UTC timestamp of the event. May be used to infer latency to the event streaming endpoint.

world_id: int¶: ID of the World whose event streaming endpoint broadcast the event.

Alias of auraxium.event.SkillAdded.

class auraxium.models.VehicleDestroy(*, event_name, timestamp, world_id, attacker_character_id, attacker_loadout_id, attacker_vehicle_id, attacker_weapon_id, attacker_team_id, character_id, facility_id, faction_id, team_id, vehicle_id, zone_id)

A player’s vehicle has been destroyed.

attacker_character_id: int¶: The ID of the killing Character.

attacker_loadout_id: int¶: ID of the Loadout of the attacker.

attacker_vehicle_id: int¶: ID of the Vehicle of the attacker.

attacker_weapon_id: int¶: ID of the Item used by the attacker.

Important

The reference above is not an error, this field reports the item ID of the weapon, not the weapon ID.

attacker_team_id: int¶: The ID of the team of the attacker

character_id: int¶: ID of the Character that was killed.

facility_id: int¶: ID of the facility the vehicle was destroyed at.

Note

As of March 2021, this field is only populated for destroyed base turrets. All other vehicles do not contain facility data.

faction_id: int¶: The Faction of the vehicle.

team_id: int¶: Team ID of the destroyed vehicle.

vehicle_id: int | None¶: The type of Vehicle that was destroyed.

zone_id: int¶: The Zone the vehicle was destroyed in.

timestamp: int¶: The UTC timestamp of the event. May be used to infer latency to the event streaming endpoint.

world_id: int¶: ID of the World whose event streaming endpoint broadcast the event.

Alias of auraxium.event.VehicleDestroy.