Models

helldivepy.models

Classes

helldivepy.models.APIURLConfiguration

Bases: BaseModel

Configuration for API endpoints.

Contains URLs for different API services used by the application.

ATTRIBUTE	DESCRIPTION
diveharder	Base URL for the Diveharder API endpoint. TYPE: str
community	Base URL for the Community API endpoint. TYPE: str

Attributes

helldivepy.models.APIURLConfiguration.diveharder class-attribute instance-attribute

diveharder: str = OFFICIAL_DIVEHARDER_URL

helldivepy.models.APIURLConfiguration.community class-attribute instance-attribute

community: str = OFFICIAL_COMMUNITY_URL

helldivepy.models.Statistics

Bases: BaseModel

War statistics tracking various gameplay metrics.

Tracks mission outcomes, combat statistics, and player performance metrics for the current war campaign.

ATTRIBUTE	DESCRIPTION
missions_won	Number of successfully completed missions. TYPE: int
missions_lost	Number of failed missions. TYPE: int
mission_time	Total time spent in missions (seconds). TYPE: int
terminid_kills	Number of Terminid enemies eliminated. TYPE: int
automaton_kills	Number of Automaton enemies eliminated. TYPE: int
illuminate_kills	Number of Illuminate enemies eliminated. TYPE: int
bullets_fired	Total ammunition expended. TYPE: int
bullets_hit	Total successful hits on targets. TYPE: int
time_played	Total gameplay duration (seconds). TYPE: int
deaths	Total player deaths. TYPE: int
revives	Total teammate revivals performed. TYPE: int
friendlies	Total friendly fire incidents. TYPE: int
mission_success_rate	Percentage of successful missions. TYPE: float
accuracy	Overall shooting accuracy percentage. TYPE: int
player_count	Current number of active players. TYPE: int

Attributes

helldivepy.models.Statistics.missions_won class-attribute instance-attribute

missions_won: int = Field(alias='missionsWon')

helldivepy.models.Statistics.missions_lost class-attribute instance-attribute

missions_lost: int = Field(alias='missionsLost')

helldivepy.models.Statistics.mission_time class-attribute instance-attribute

mission_time: int = Field(alias='missionTime')

helldivepy.models.Statistics.terminid_kills class-attribute instance-attribute

terminid_kills: int = Field(alias='terminidKills')

helldivepy.models.Statistics.automaton_kills class-attribute instance-attribute

automaton_kills: int = Field(alias='automatonKills')

helldivepy.models.Statistics.illuminate_kills class-attribute instance-attribute

illuminate_kills: int = Field(alias='illuminateKills')

helldivepy.models.Statistics.bullets_fired class-attribute instance-attribute

bullets_fired: int = Field(alias='bulletsFired')

helldivepy.models.Statistics.bullets_hit class-attribute instance-attribute

bullets_hit: int = Field(alias='bulletsHit')

helldivepy.models.Statistics.time_played class-attribute instance-attribute

time_played: int = Field(alias='timePlayed')

helldivepy.models.Statistics.deaths instance-attribute

deaths: int

helldivepy.models.Statistics.revives instance-attribute

revives: int

helldivepy.models.Statistics.friendlies instance-attribute

friendlies: int

helldivepy.models.Statistics.mission_success_rate class-attribute instance-attribute

mission_success_rate: float = Field(alias='missionSuccessRate')

helldivepy.models.Statistics.accuracy instance-attribute

accuracy: int

helldivepy.models.Statistics.player_count class-attribute instance-attribute

player_count: int = Field(alias='playerCount')

helldivepy.models.WarInfo

Bases: BaseModel

Information about the current galactic war.

Contains timing information, client details, and overall war statistics.

ATTRIBUTE	DESCRIPTION
started	War start timestamp. TYPE: datetime
ended	War end timestamp. TYPE: datetime
now	Current war time. TYPE: datetime
client_version	Game client version. TYPE: str
factions	List of participating factions. TYPE: list[str]
impact_multiplier	Current war impact multiplier. TYPE: float
statistics	Comprehensive war statistics. TYPE: Statistics

Attributes

helldivepy.models.WarInfo.started instance-attribute

started: datetime

helldivepy.models.WarInfo.ended instance-attribute

ended: datetime

helldivepy.models.WarInfo.now instance-attribute

now: datetime

helldivepy.models.WarInfo.client_version class-attribute instance-attribute

client_version: str = Field(alias='clientVersion')

helldivepy.models.WarInfo.factions instance-attribute

factions: list[Literal['Humans', 'Terminids', 'Automaton', 'Illuminate']]

helldivepy.models.WarInfo.impact_multiplier class-attribute instance-attribute

impact_multiplier: float = Field(alias='impactMultiplier')

helldivepy.models.WarInfo.statistics instance-attribute

statistics: Statistics

helldivepy.models.Dispatch

Bases: BaseModel

War dispatch message container.

Represents official communications during the war campaign.

ATTRIBUTE	DESCRIPTION
id	Unique dispatch identifier. TYPE: int
published	Dispatch publication timestamp. TYPE: datetime
type	Message type identifier. TYPE: Literal[0]
message	Dispatch content. TYPE: str

Attributes

helldivepy.models.Dispatch.id instance-attribute

id: int

helldivepy.models.Dispatch.published instance-attribute

published: datetime

helldivepy.models.Dispatch.type instance-attribute

type: Literal[0]

helldivepy.models.Dispatch.message instance-attribute

message: str

helldivepy.models.SteamNews

Bases: BaseModel

Steam platform update information.

Contains details about game patches and updates published on Steam.

ATTRIBUTE	DESCRIPTION
id	Unique news article identifier. TYPE: str
title	Update title. TYPE: str
url	Full update documentation URL. TYPE: str
author	Update author. TYPE: str
content	Update content. TYPE: str
published_at	Publication timestamp. TYPE: datetime

Attributes

helldivepy.models.SteamNews.id instance-attribute

id: str

helldivepy.models.SteamNews.title instance-attribute

title: str

helldivepy.models.SteamNews.url instance-attribute

url: str

helldivepy.models.SteamNews.author instance-attribute

author: str

helldivepy.models.SteamNews.content instance-attribute

content: str

helldivepy.models.SteamNews.published_at class-attribute instance-attribute

published_at: datetime = Field(alias='publishedAt')

helldivepy.models.PlanetEvent

Bases: BaseModel

Planetary event information.

Tracks events affecting individual planets during the war.

ATTRIBUTE	DESCRIPTION
id	Unique event identifier. TYPE: int
event_type	Type of planetary event. TYPE: int
faction	Associated faction. TYPE: FactionType
health	Current planet health. TYPE: int
max_health	Maximum planet health. TYPE: int
start_time	Event start timestamp. TYPE: datetime
end_time	Event end timestamp. TYPE: datetime
campaign_id	Associated campaign identifier. TYPE: int
joint_operation_ids	Related joint operation identifiers. TYPE: list[int]

Attributes

helldivepy.models.PlanetEvent.id instance-attribute

id: int

helldivepy.models.PlanetEvent.event_type class-attribute instance-attribute

event_type: int = Field(alias='eventType')

helldivepy.models.PlanetEvent.faction instance-attribute

faction: FactionType

helldivepy.models.PlanetEvent.health instance-attribute

health: int

helldivepy.models.PlanetEvent.max_health class-attribute instance-attribute

max_health: int = Field(alias='maxHealth')

helldivepy.models.PlanetEvent.start_time class-attribute instance-attribute

start_time: datetime = Field(alias='startTime')

helldivepy.models.PlanetEvent.end_time class-attribute instance-attribute

end_time: datetime = Field(alias='endTime')

helldivepy.models.PlanetEvent.campaign_id class-attribute instance-attribute

campaign_id: int = Field(alias='campaignId')

helldivepy.models.PlanetEvent.joint_operation_ids class-attribute instance-attribute

joint_operation_ids: list[int] = Field(alias='jointOperationIds')

helldivepy.models.PlanetEvent.planet property

planet: Planet | None

Retrieves the planet associated with this event.

RETURNS	DESCRIPTION
Planet | None	Planet | None: Associated planet object if available, None otherwise.

helldivepy.models.Position

Bases: BaseModel

2D coordinate position.

Represents a location in 2D space.

ATTRIBUTE	DESCRIPTION
x	Horizontal coordinate. TYPE: float
y	Vertical coordinate. TYPE: float

Attributes

helldivepy.models.Position.x instance-attribute

x: float

helldivepy.models.Position.y instance-attribute

y: float

helldivepy.models.PlanetaryHazard

Bases: BaseModel

Planetary environmental hazard.

Describes environmental dangers present on a planet.

ATTRIBUTE	DESCRIPTION
name	Hazard identifier. TYPE: str
description	Detailed hazard description. TYPE: str

Attributes

helldivepy.models.PlanetaryHazard.name instance-attribute

name: str

helldivepy.models.PlanetaryHazard.description instance-attribute

description: str

helldivepy.models.Biome

Bases: BaseModel

Planetary biome characteristics.

Describes the environmental characteristics of a planet.

ATTRIBUTE	DESCRIPTION
name	Biome identifier. TYPE: str
description	Detailed biome description. TYPE: str

Attributes

helldivepy.models.Biome.name instance-attribute

name: str

helldivepy.models.Biome.description instance-attribute

description: str

helldivepy.models.Planet

Bases: BaseModel

Planetary information and status.

Contains comprehensive information about a planet in the war.

ATTRIBUTE	DESCRIPTION
index	Planet index number. TYPE: int
name	Planet name. TYPE: str
sector	Galactic sector location. TYPE: str
biome	Planet's biome characteristics. TYPE: Biome
hazards	Environmental hazards. TYPE: list[PlanetaryHazard]
hash	Unique planet identifier. TYPE: int
position	Galactic coordinates. TYPE: Position
waypoints	Planetary waypoints. TYPE: list[int]
max_health	Maximum planetary health. TYPE: int
health	Current planetary health. TYPE: int
disabled	Planet accessibility status. TYPE: bool
initial_owner	Original controlling faction. TYPE: FactionType
current_owner	Current controlling faction. TYPE: FactionType
regen_per_second	Health regeneration rate. TYPE: float
event	Current planetary event. TYPE: PlanetEvent | None
statistics	Planet-specific statistics. TYPE: Statistics
attacking	Attacking force identifiers. TYPE: list[int]

Attributes

helldivepy.models.Planet.index instance-attribute

index: int

helldivepy.models.Planet.name instance-attribute

name: str

helldivepy.models.Planet.sector instance-attribute

sector: str

helldivepy.models.Planet.biome instance-attribute

biome: Biome

helldivepy.models.Planet.hazards instance-attribute

hazards: list[PlanetaryHazard]

helldivepy.models.Planet.hash instance-attribute

hash: int

helldivepy.models.Planet.position instance-attribute

position: Position

helldivepy.models.Planet.waypoints instance-attribute

waypoints: list[int]

helldivepy.models.Planet.max_health class-attribute instance-attribute

max_health: int = Field(alias='maxHealth')

helldivepy.models.Planet.health instance-attribute

health: int

helldivepy.models.Planet.disabled instance-attribute

disabled: bool

helldivepy.models.Planet.initial_owner class-attribute instance-attribute

initial_owner: FactionType = Field(alias='initialOwner')

helldivepy.models.Planet.current_owner class-attribute instance-attribute

current_owner: FactionType = Field(alias='currentOwner')

helldivepy.models.Planet.regen_per_second class-attribute instance-attribute

regen_per_second: float = Field(alias='regenPerSecond')

helldivepy.models.Planet.event instance-attribute

event: PlanetEvent | None

helldivepy.models.Planet.statistics instance-attribute

statistics: Statistics

helldivepy.models.Planet.attacking instance-attribute

attacking: list[int]

helldivepy.models.Planet.has_space_station property

has_space_station: bool

Checks for presence of an orbital space station.

RETURNS	DESCRIPTION
bool	True if a space station is present, False otherwise. TYPE: bool

RAISES	DESCRIPTION
RuntimeError	If ApiClient is not properly initialized.

helldivepy.models.AssignmentTaskData

Bases: BaseModel

Assignment task specific data.

Contains details about objectives for an assignment task.

ATTRIBUTE	DESCRIPTION
liberate	Planet liberation objective flag. TYPE: bool | None
planet	Target planet for assignment. TYPE: Planet | None
target_count	Required objective count. TYPE: int | None
race	Target faction type. TYPE: FactionType | None

Attributes

helldivepy.models.AssignmentTaskData.liberate instance-attribute

liberate: bool | None

helldivepy.models.AssignmentTaskData.planet instance-attribute

planet: Planet | None

helldivepy.models.AssignmentTaskData.target_count instance-attribute

target_count: int | None

helldivepy.models.AssignmentTaskData.race instance-attribute

race: FactionType | None

helldivepy.models.AssignmentTask

Bases: BaseModel

Individual assignment task details.

Represents a single task within an assignment.

ATTRIBUTE	DESCRIPTION
type	Task type classification. TYPE: AssignmentTypes
values	Task-specific values. TYPE: list[int]
value_types	Types of provided values. TYPE: list[ValueTypes]
data	Associated task data. TYPE: AssignmentTaskData

Attributes

helldivepy.models.AssignmentTask.type instance-attribute

type: AssignmentTypes

helldivepy.models.AssignmentTask.values instance-attribute

values: list[int]

helldivepy.models.AssignmentTask.value_types class-attribute instance-attribute

value_types: list[ValueTypes] = Field(alias='valueTypes')

helldivepy.models.AssignmentTask.data class-attribute instance-attribute

data: AssignmentTaskData = AssignmentTaskData(liberate=None, planet=None, target_count=None, race=None)

Functions

helldivepy.models.AssignmentTask.model_post_init

model_post_init(__context: typing.Any) -> None

Initializes task data after model creation.

PARAMETER	DESCRIPTION
__context	Initialization context data. TYPE: Any

RAISES	DESCRIPTION
ValueError	If ApiClient is not properly initialized.

helldivepy.models.AssignmentReward

Bases: BaseModel

Assignment completion reward.

Details about rewards given for completing an assignment.

ATTRIBUTE	DESCRIPTION
type	Reward type identifier. TYPE: int
amount	Reward quantity. TYPE: int

Attributes

helldivepy.models.AssignmentReward.type instance-attribute

type: int

helldivepy.models.AssignmentReward.amount instance-attribute

amount: int

helldivepy.models.Assignment

Bases: BaseModel

Major Order assignment information.

Contains complete information about a mission assignment.

ATTRIBUTE	DESCRIPTION
id	Unique assignment identifier. TYPE: int
progress	Task completion progress. TYPE: list[int]
title	Assignment title. TYPE: str | None
briefing	Mission briefing text. TYPE: str | None
description	Detailed assignment description. TYPE: str | None
tasks	Required tasks. TYPE: list[AssignmentTask]
reward	Completion reward. TYPE: AssignmentReward
expiration	Assignment expiration time. TYPE: datetime

Attributes

helldivepy.models.Assignment.id instance-attribute

id: int

helldivepy.models.Assignment.progress instance-attribute

progress: list[int]

helldivepy.models.Assignment.title class-attribute instance-attribute

title: str | None = None

helldivepy.models.Assignment.briefing class-attribute instance-attribute

briefing: str | None = None

helldivepy.models.Assignment.description class-attribute instance-attribute

description: str | None = None

helldivepy.models.Assignment.tasks instance-attribute

tasks: list[AssignmentTask]

helldivepy.models.Assignment.reward instance-attribute

reward: AssignmentReward

helldivepy.models.Assignment.expiration instance-attribute

expiration: datetime

helldivepy.models.Assignment.is_complete property

is_complete: bool

Checks if all assignment tasks are complete.

RETURNS	DESCRIPTION
bool	True if all tasks meet their target count, False otherwise. TYPE: bool

helldivepy.models.Campaign

Bases: BaseModel

Campaign battle information.

Contains details about a specific war campaign.

ATTRIBUTE	DESCRIPTION
id	Unique campaign identifier. TYPE: int
planet	Campaign target planet. TYPE: Planet
type	Campaign classification. TYPE: int
count	Number of battles in campaign. TYPE: int

Attributes

helldivepy.models.Campaign.id instance-attribute

id: int

helldivepy.models.Campaign.planet instance-attribute

planet: Planet

helldivepy.models.Campaign.type instance-attribute

type: CampaignTypes

helldivepy.models.Campaign.count instance-attribute

count: int

helldivepy.models.SpaceStation

Bases: BaseModel

Orbital space station information.

Contains details about a planetary space station.

ATTRIBUTE	DESCRIPTION
id	Unique station identifier. TYPE: int
planet	Host planet. TYPE: Planet
election_end	Station election period end time. TYPE: datetime
flags	Station status flags. TYPE: int

Attributes

helldivepy.models.SpaceStation.id class-attribute instance-attribute

id: int = Field(alias='id32')

helldivepy.models.SpaceStation.planet instance-attribute

planet: Planet

helldivepy.models.SpaceStation.election_end class-attribute instance-attribute

election_end: datetime = Field(alias='electionEnd')

helldivepy.models.SpaceStation.flags instance-attribute

flags: int