diff --git a/404.html b/404.html old mode 100644 new mode 100755 diff --git a/CNAME b/CNAME deleted file mode 100644 index c104795..0000000 --- a/CNAME +++ /dev/null @@ -1 +0,0 @@ -helldivepy.ajxd2.dev \ No newline at end of file diff --git a/__pycache__/macros.cpython-312.pyc b/__pycache__/macros.cpython-312.pyc new file mode 100755 index 0000000..83746dd Binary files /dev/null and b/__pycache__/macros.cpython-312.pyc differ diff --git a/api/constants/index.html b/api/constants/index.html old mode 100644 new mode 100755 index d169128..b8a5bd3 --- a/api/constants/index.html +++ b/api/constants/index.html @@ -923,7 +923,12 @@

-
FACTIONS = {1: 'Humans', 2: 'Terminids', 3: 'Automaton', 4: 'Illuminate'}
+
FACTIONS = {
+    1: "Humans",
+    2: "Terminids",
+    3: "Automaton",
+    4: "Illuminate",
+}
 

 
     

diff --git a/api/enums/index.html b/api/enums/index.html
old mode 100644
new mode 100755
index 0035e83..4e8d68a
--- a/api/enums/index.html
+++ b/api/enums/index.html
@@ -1463,7 +1463,9 @@ 

   
 
 

-
FactionType = Literal['Humans', 'Terminids', 'Automaton', 'Illuminate']
+
FactionType = Literal[
+    "Humans", "Terminids", "Automaton", "Illuminate"
+]
 

 
     

diff --git a/api/index.html b/api/index.html
old mode 100644
new mode 100755
index 17904da..ac4722a
--- a/api/index.html
+++ b/api/index.html
@@ -959,7 +959,13 @@ 

 
 
 

-
ApiClient(user_agent: str, user_contact: str, debug: bool = False, diveharder_url: str = OFFICIAL_DIVEHARDER_URL, community_url: str = OFFICIAL_COMMUNITY_URL)
+
ApiClient(
+    user_agent: str,
+    user_contact: str,
+    debug: bool = False,
+    diveharder_url: str = OFFICIAL_DIVEHARDER_URL,
+    community_url: str = OFFICIAL_COMMUNITY_URL,
+)
 

 
     

@@ -1144,7 +1150,9 @@ 

   
 
 

-
api_config = APIURLConfiguration(diveharder=diveharder_url, community=community_url)
+
api_config = APIURLConfiguration(
+    diveharder=diveharder_url, community=community_url
+)
 

 
     

diff --git a/api/models/index.html b/api/models/index.html
old mode 100644
new mode 100755
index dcc247a..1b440a7
--- a/api/models/index.html
+++ b/api/models/index.html
@@ -4195,7 +4195,9 @@ 
mission_success_rate: float = Field(alias='missionSuccessRate')
+
mission_success_rate: float = Field(
+    alias="missionSuccessRate"
+)
 

 
     

@@ -4499,7 +4501,11 @@ 

   
 
 

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

 
     

@@ -5385,7 +5391,9 @@ 
joint_operation_ids: list[int] = Field(alias='jointOperationIds')
+
joint_operation_ids: list[int] = Field(
+    alias="jointOperationIds"
+)
 

 
     

@@ -6940,7 +6948,9 @@ 

   
 
 

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

 
     

diff --git a/api/routes/index.html b/api/routes/index.html
old mode 100644
new mode 100755
index 30e6dcf..818abc0
--- a/api/routes/index.html
+++ b/api/routes/index.html
@@ -1547,7 +1547,15 @@ 

   
 
 

-
__all__ = ['DispatchModule', 'WarModule', 'SteamModule', 'AssignmentsModule', 'PlanetsModule', 'CampaignModule', 'SpaceStationModule']
+
__all__ = [
+    "DispatchModule",
+    "WarModule",
+    "SteamModule",
+    "AssignmentsModule",
+    "PlanetsModule",
+    "CampaignModule",
+    "SpaceStationModule",
+]
 

 
     

@@ -1629,7 +1637,9 @@ 

 
 
 

-
get_dispatches(old_to_new: bool = True) -> typing.List[models.Dispatch]
+
get_dispatches(
+    old_to_new: bool = True,
+) -> typing.List[models.Dispatch]
 

 
     

@@ -2097,7 +2107,9 @@ 

 
 
 

-
get_planet(index: int, cached: bool = False) -> models.Planet
+
get_planet(
+    index: int, cached: bool = False
+) -> models.Planet
 

 
     

@@ -2484,7 +2496,9 @@ 
get_space_station(index: int) -> Optional[models.SpaceStation]
+
get_space_station(
+    index: int,
+) -> Optional[models.SpaceStation]
 

 
     

diff --git a/api/utils/index.html b/api/utils/index.html
old mode 100644
new mode 100755
index b0a2675..326e7ab
--- a/api/utils/index.html
+++ b/api/utils/index.html
@@ -993,7 +993,12 @@ 

   
 
 

-
FACTIONS = {1: 'Humans', 2: 'Terminids', 3: 'Automaton', 4: 'Illuminate'}
+
FACTIONS = {
+    1: "Humans",
+    2: "Terminids",
+    3: "Automaton",
+    4: "Illuminate",
+}
 

 
     

diff --git a/assets/_mkdocstrings.css b/assets/_mkdocstrings.css
old mode 100644
new mode 100755
diff --git a/assets/images/favicon.png b/assets/images/favicon.png
old mode 100644
new mode 100755
diff --git a/assets/javascripts/bundle.88dd0f4e.min.js b/assets/javascripts/bundle.88dd0f4e.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/bundle.88dd0f4e.min.js.map b/assets/javascripts/bundle.88dd0f4e.min.js.map
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.ar.min.js b/assets/javascripts/lunr/min/lunr.ar.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.da.min.js b/assets/javascripts/lunr/min/lunr.da.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.de.min.js b/assets/javascripts/lunr/min/lunr.de.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.du.min.js b/assets/javascripts/lunr/min/lunr.du.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.el.min.js b/assets/javascripts/lunr/min/lunr.el.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.es.min.js b/assets/javascripts/lunr/min/lunr.es.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.fi.min.js b/assets/javascripts/lunr/min/lunr.fi.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.fr.min.js b/assets/javascripts/lunr/min/lunr.fr.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.he.min.js b/assets/javascripts/lunr/min/lunr.he.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.hi.min.js b/assets/javascripts/lunr/min/lunr.hi.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.hu.min.js b/assets/javascripts/lunr/min/lunr.hu.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.hy.min.js b/assets/javascripts/lunr/min/lunr.hy.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.it.min.js b/assets/javascripts/lunr/min/lunr.it.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.ja.min.js b/assets/javascripts/lunr/min/lunr.ja.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.jp.min.js b/assets/javascripts/lunr/min/lunr.jp.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.kn.min.js b/assets/javascripts/lunr/min/lunr.kn.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.ko.min.js b/assets/javascripts/lunr/min/lunr.ko.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.multi.min.js b/assets/javascripts/lunr/min/lunr.multi.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.nl.min.js b/assets/javascripts/lunr/min/lunr.nl.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.no.min.js b/assets/javascripts/lunr/min/lunr.no.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.pt.min.js b/assets/javascripts/lunr/min/lunr.pt.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.ro.min.js b/assets/javascripts/lunr/min/lunr.ro.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.ru.min.js b/assets/javascripts/lunr/min/lunr.ru.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.sa.min.js b/assets/javascripts/lunr/min/lunr.sa.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.stemmer.support.min.js b/assets/javascripts/lunr/min/lunr.stemmer.support.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.sv.min.js b/assets/javascripts/lunr/min/lunr.sv.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.ta.min.js b/assets/javascripts/lunr/min/lunr.ta.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.te.min.js b/assets/javascripts/lunr/min/lunr.te.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.th.min.js b/assets/javascripts/lunr/min/lunr.th.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.tr.min.js b/assets/javascripts/lunr/min/lunr.tr.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.vi.min.js b/assets/javascripts/lunr/min/lunr.vi.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/min/lunr.zh.min.js b/assets/javascripts/lunr/min/lunr.zh.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/tinyseg.js b/assets/javascripts/lunr/tinyseg.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/lunr/wordcut.js b/assets/javascripts/lunr/wordcut.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/workers/search.6ce7567c.min.js b/assets/javascripts/workers/search.6ce7567c.min.js
old mode 100644
new mode 100755
diff --git a/assets/javascripts/workers/search.6ce7567c.min.js.map b/assets/javascripts/workers/search.6ce7567c.min.js.map
old mode 100644
new mode 100755
diff --git a/assets/stylesheets/main.6f8fc17f.min.css b/assets/stylesheets/main.6f8fc17f.min.css
old mode 100644
new mode 100755
diff --git a/assets/stylesheets/main.6f8fc17f.min.css.map b/assets/stylesheets/main.6f8fc17f.min.css.map
old mode 100644
new mode 100755
diff --git a/assets/stylesheets/palette.06af60db.min.css b/assets/stylesheets/palette.06af60db.min.css
old mode 100644
new mode 100755
diff --git a/assets/stylesheets/palette.06af60db.min.css.map b/assets/stylesheets/palette.06af60db.min.css.map
old mode 100644
new mode 100755
diff --git a/images/favicon.png b/images/favicon.png
old mode 100644
new mode 100755
diff --git a/index.html b/index.html
old mode 100644
new mode 100755
diff --git a/installation/index.html b/installation/index.html
old mode 100644
new mode 100755
diff --git a/links/index.html b/links/index.html
old mode 100644
new mode 100755
diff --git a/objects.inv b/objects.inv
old mode 100644
new mode 100755
diff --git a/search/search_index.json b/search/search_index.json
old mode 100644
new mode 100755
index 5ffefe5..67c66ab
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Helldive.py","text":"
A simple Python library for diving deep into the Helldivers Community API and Diveharder API.
"},{"location":"#features","title":"\ud83c\udf1f Features","text":"
     
  • Easy API Access: Communicate with the Helldivers Community API and Diveharder API without breaking a sweat.
    •  
  • Typed Data: Get structured, easily readable data like dispatches, planets, and more!
    •  
  • Perfect for Projects: Ideal for projects, bots, or just exploring Helldivers data.
    •  
"},{"location":"#links","title":"\ud83d\udd17 Links","text":"
     
  • Get Started
    •  
  • DiveHarder
    •  
  • Community API
    •  
  • API discussion Discord
    •  
"},{"location":"installation/","title":"\ud83d\ude80 Get Started","text":""},{"location":"installation/#installation","title":"\u2699\ufe0f Installation","text":"PipPoetryUV 
pip install helldivepy\n
 Poetry 
Install poetry here.
 
poetry add helldivepy\n
 UV 
Install UV here.
 
uv add helldivepy\n
 
Example code
 Without RichWith rich 
from helldivepy import ApiClient\nclient = ApiClient(\n    user_agent=\"Hello-World\",\n    user_contact=\"example@example.com | discord:exampleuser123\",\n)\n\nprint(client.get_war_info().model_dump())\n>>>\n    {\n        'started': datetime.datetime(2024, 1, 23, 20, 5, 13, tzinfo=TzInfo(UTC)),\n        'ended': datetime.datetime(2028, 2, 8, 20, 4, 55, tzinfo=TzInfo(UTC)),\n        'now': datetime.datetime(1970, 11, 6, 14, 59, 50, tzinfo=TzInfo(UTC)),\n        'client_version': '0.3.0',\n        'factions': ['Humans', 'Terminids', 'Automaton', 'Illuminate'],\n        'impact_multiplier': 0.034382936,\n        'statistics': {\n            'missions_won': 370390368,\n            'missions_lost': 37224925,\n            'mission_time': 1047433682627,\n            'terminid_kills': 79906866134,\n            'automaton_kills': 31552895947,\n            'illuminate_kills': 3705435035,\n            'bullets_fired': 571067857117,\n            'bullets_hit': 645369797775,\n            'time_played': 1047433682627,\n            'deaths': 2564546790,\n            'revives': 2,\n            'friendlies': 361359530,\n            'mission_success_rate': 90.0,\n            'accuracy': 100,\n            'player_count': 111316\n        }\n    }\n
 
from helldivepy import ApiClient\nfrom rich import print\n\nclient = ApiClient(\n    user_agent=\"Hello-World\",\n    user_contact=\"example@example.com | discord:exampleuser123\",\n)\n\nprint(client.get_war_info())\n>>> WarInfo(\n    started=datetime.datetime(2024, 1, 23, 20, 5, 13, tzinfo=TzInfo(UTC)),\n    ended=datetime.datetime(2028, 2, 8, 20, 4, 55, tzinfo=TzInfo(UTC)),\n    now=datetime.datetime(1970, 11, 6, 14, 24, 40, tzinfo=TzInfo(UTC)),\n    client_version='0.3.0',\n    factions=['Humans', 'Terminids', 'Automaton', 'Illuminate'],\n    impact_multiplier=0.03595309,\n    statistics=Statistics(\n        missions_won=370353637,\n        missions_lost=37219878,\n        mission_time=1047300170684,\n        terminid_kills=79904593412,\n        automaton_kills=31551843355,\n        illuminate_kills=3687632552,\n        bullets_fired=570972530827,\n        bullets_hit=645273266867,\n        time_played=1047300170684,\n        deaths=2564288334,\n        revives=2,\n        friendlies=361317130,\n        mission_success_rate=90.0,\n        accuracy=100,\n        player_count=102995\n    )\n)\n
"},{"location":"links/","title":"\ud83d\udd17 Links","text":"
A list of links that may come in handy when using this lib or other parts of the community API.
 
     
  • PyPi project
    •  
  • DiveHarder
    •  
  • Community API
    •  
  • Comuunity Github
    •  
  • API discussion Discord
    •  
"},{"location":"api/","title":"API Reference","text":""},{"location":"api/#helldivepy","title":"helldivepy","text":""},{"location":"api/#helldivepy-attributes","title":"Attributes","text":""},{"location":"api/#helldivepy.__all__","title":"helldivepy.__all__  module-attribute","text":"
__all__ = ['ApiClient']\n
"},{"location":"api/#helldivepy-classes","title":"Classes","text":""},{"location":"api/#helldivepy.ApiClient","title":"helldivepy.ApiClient","text":"
ApiClient(user_agent: str, user_contact: str, debug: bool = False, diveharder_url: str = OFFICIAL_DIVEHARDER_URL, community_url: str = OFFICIAL_COMMUNITY_URL)\n
 
The client used to interact with the Helldivers 2 APIs
 
The client used to interact with the Helldivers 2 APIs
 PARAMETER DESCRIPTION user_agent 
The user agent to use when making requests.
 
 TYPE: str 
 user_contact 
The user contact to use when making requests.
 
 TYPE: str 
 debug 
Enables debug logging for development.
 
 TYPE: bool DEFAULT: False 
 diveharder_url 
The diveharder API url to use. Defaults to constants.OFFICIAL_DIVEHARDER_URL.
 
 TYPE: str DEFAULT: OFFICIAL_DIVEHARDER_URL 
 community_url 
The community API url to use. Defaults to constants.OFFICIAL_COMMUNITY_URL.
 
 TYPE: str DEFAULT: OFFICIAL_COMMUNITY_URL 
"},{"location":"api/#helldivepy.ApiClient-attributes","title":"Attributes","text":""},{"location":"api/#helldivepy.ApiClient.debug","title":"helldivepy.ApiClient.debug  instance-attribute","text":"
debug = debug\n
"},{"location":"api/#helldivepy.ApiClient.logger","title":"helldivepy.ApiClient.logger  instance-attribute","text":"
logger = set_logger(debug)\n
"},{"location":"api/#helldivepy.ApiClient.api_config","title":"helldivepy.ApiClient.api_config  instance-attribute","text":"
api_config = APIURLConfiguration(diveharder=diveharder_url, community=community_url)\n
"},{"location":"api/#helldivepy.ApiClient.war","title":"helldivepy.ApiClient.war  property","text":"
war: WarModule\n
"},{"location":"api/#helldivepy.ApiClient.dispatch","title":"helldivepy.ApiClient.dispatch  property","text":"
dispatch: DispatchModule\n
"},{"location":"api/#helldivepy.ApiClient.steam","title":"helldivepy.ApiClient.steam  property","text":"
steam: SteamModule\n
"},{"location":"api/#helldivepy.ApiClient.assignments","title":"helldivepy.ApiClient.assignments  property","text":"
assignments: AssignmentsModule\n
"},{"location":"api/#helldivepy.ApiClient.major_orders","title":"helldivepy.ApiClient.major_orders  property","text":"
major_orders: AssignmentsModule\n
"},{"location":"api/#helldivepy.ApiClient.planets","title":"helldivepy.ApiClient.planets  property","text":"
planets: PlanetsModule\n
"},{"location":"api/#helldivepy.ApiClient.campaigns","title":"helldivepy.ApiClient.campaigns  property","text":"
campaigns: CampaignModule\n
"},{"location":"api/#helldivepy.ApiClient.space_stations","title":"helldivepy.ApiClient.space_stations  property","text":"
space_stations: SpaceStationModule\n
"},{"location":"api/#helldivepy.ApiClient-functions","title":"Functions","text":""},{"location":"api/#helldivepy.ApiClient.get_client","title":"helldivepy.ApiClient.get_client  classmethod","text":"
get_client()\n
"},{"location":"api/#helldivepy.ApiClient.get_war_info","title":"helldivepy.ApiClient.get_war_info","text":"
get_war_info() -> models.WarInfo\n
"},{"location":"api/constants/","title":"Constants","text":""},{"location":"api/constants/#helldivepy.constants","title":"helldivepy.constants","text":""},{"location":"api/constants/#helldivepy.constants-attributes","title":"Attributes","text":""},{"location":"api/constants/#helldivepy.constants.OFFICIAL_DIVEHARDER_URL","title":"helldivepy.constants.OFFICIAL_DIVEHARDER_URL  module-attribute","text":"
OFFICIAL_DIVEHARDER_URL = 'https://api.diveharder.com'\n
"},{"location":"api/constants/#helldivepy.constants.OFFICIAL_COMMUNITY_URL","title":"helldivepy.constants.OFFICIAL_COMMUNITY_URL  module-attribute","text":"
OFFICIAL_COMMUNITY_URL = 'https://api.helldivers2.dev'\n
"},{"location":"api/constants/#helldivepy.constants.FACTIONS","title":"helldivepy.constants.FACTIONS  module-attribute","text":"
FACTIONS = {1: 'Humans', 2: 'Terminids', 3: 'Automaton', 4: 'Illuminate'}\n
"},{"location":"api/enums/","title":"Enums","text":""},{"location":"api/enums/#helldivepy.enums","title":"helldivepy.enums","text":""},{"location":"api/enums/#helldivepy.enums-attributes","title":"Attributes","text":""},{"location":"api/enums/#helldivepy.enums.FactionType","title":"helldivepy.enums.FactionType  module-attribute","text":"
FactionType = Literal['Humans', 'Terminids', 'Automaton', 'Illuminate']\n
"},{"location":"api/enums/#helldivepy.enums-classes","title":"Classes","text":""},{"location":"api/enums/#helldivepy.enums.BetterEnum","title":"helldivepy.enums.BetterEnum","text":"
               Bases: Enum
"},{"location":"api/enums/#helldivepy.enums.BetterEnum-functions","title":"Functions","text":""},{"location":"api/enums/#helldivepy.enums.BetterEnum.parse","title":"helldivepy.enums.BetterEnum.parse  classmethod","text":"
parse(value)\n
"},{"location":"api/enums/#helldivepy.enums.CampaignTypes","title":"helldivepy.enums.CampaignTypes","text":"
               Bases: BetterEnum
 
Types of campaigns in the game
"},{"location":"api/enums/#helldivepy.enums.CampaignTypes-attributes","title":"Attributes","text":""},{"location":"api/enums/#helldivepy.enums.CampaignTypes.LIBERATION_DEFENSE","title":"helldivepy.enums.CampaignTypes.LIBERATION_DEFENSE  class-attribute instance-attribute","text":"
LIBERATION_DEFENSE = 0\n
"},{"location":"api/enums/#helldivepy.enums.CampaignTypes.RECON","title":"helldivepy.enums.CampaignTypes.RECON  class-attribute instance-attribute","text":"
RECON = 1\n
"},{"location":"api/enums/#helldivepy.enums.CampaignTypes.STORY","title":"helldivepy.enums.CampaignTypes.STORY  class-attribute instance-attribute","text":"
STORY = 2\n
"},{"location":"api/enums/#helldivepy.enums.ValueTypes","title":"helldivepy.enums.ValueTypes","text":"
               Bases: BetterEnum
 
Types of values returned from the major order/assignments endpoint.
"},{"location":"api/enums/#helldivepy.enums.ValueTypes-attributes","title":"Attributes","text":""},{"location":"api/enums/#helldivepy.enums.ValueTypes.RACE","title":"helldivepy.enums.ValueTypes.RACE  class-attribute instance-attribute","text":"
RACE = 1\n
"},{"location":"api/enums/#helldivepy.enums.ValueTypes.UNKNOWN","title":"helldivepy.enums.ValueTypes.UNKNOWN  class-attribute instance-attribute","text":"
UNKNOWN = 2\n
"},{"location":"api/enums/#helldivepy.enums.ValueTypes.TARGET_COUNT","title":"helldivepy.enums.ValueTypes.TARGET_COUNT  class-attribute instance-attribute","text":"
TARGET_COUNT = 3\n
"},{"location":"api/enums/#helldivepy.enums.ValueTypes.UNIT_ID","title":"helldivepy.enums.ValueTypes.UNIT_ID  class-attribute instance-attribute","text":"
UNIT_ID = 4\n
"},{"location":"api/enums/#helldivepy.enums.ValueTypes.ITEM_ID","title":"helldivepy.enums.ValueTypes.ITEM_ID  class-attribute instance-attribute","text":"
ITEM_ID = 5\n
"},{"location":"api/enums/#helldivepy.enums.ValueTypes.LIBERATE","title":"helldivepy.enums.ValueTypes.LIBERATE  class-attribute instance-attribute","text":"
LIBERATE = 11\n
"},{"location":"api/enums/#helldivepy.enums.ValueTypes.PLANET","title":"helldivepy.enums.ValueTypes.PLANET  class-attribute instance-attribute","text":"
PLANET = 12\n
"},{"location":"api/enums/#helldivepy.enums.RewardTypes","title":"helldivepy.enums.RewardTypes","text":"
               Bases: BetterEnum
 
Types of rewards given out by the major order/assignments.
"},{"location":"api/enums/#helldivepy.enums.RewardTypes-attributes","title":"Attributes","text":""},{"location":"api/enums/#helldivepy.enums.RewardTypes.MEDALS","title":"helldivepy.enums.RewardTypes.MEDALS  class-attribute instance-attribute","text":"
MEDALS = 1\n
"},{"location":"api/enums/#helldivepy.enums.AssignmentTypes","title":"helldivepy.enums.AssignmentTypes","text":"
               Bases: BetterEnum
 
Types of assignments.
"},{"location":"api/enums/#helldivepy.enums.AssignmentTypes-attributes","title":"Attributes","text":""},{"location":"api/enums/#helldivepy.enums.AssignmentTypes.ERADICATE","title":"helldivepy.enums.AssignmentTypes.ERADICATE  class-attribute instance-attribute","text":"
ERADICATE = 3\n
"},{"location":"api/enums/#helldivepy.enums.AssignmentTypes.LIBERATION","title":"helldivepy.enums.AssignmentTypes.LIBERATION  class-attribute instance-attribute","text":"
LIBERATION = 11\n
"},{"location":"api/enums/#helldivepy.enums.AssignmentTypes.DEFENSE","title":"helldivepy.enums.AssignmentTypes.DEFENSE  class-attribute instance-attribute","text":"
DEFENSE = 12\n
"},{"location":"api/enums/#helldivepy.enums.AssignmentTypes.CONTROL","title":"helldivepy.enums.AssignmentTypes.CONTROL  class-attribute instance-attribute","text":"
CONTROL = 13\n
"},{"location":"api/models/","title":"Models","text":""},{"location":"api/models/#helldivepy.models","title":"helldivepy.models","text":""},{"location":"api/models/#helldivepy.models-classes","title":"Classes","text":""},{"location":"api/models/#helldivepy.models.APIURLConfiguration","title":"helldivepy.models.APIURLConfiguration","text":"
               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 
"},{"location":"api/models/#helldivepy.models.APIURLConfiguration-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.APIURLConfiguration.diveharder","title":"helldivepy.models.APIURLConfiguration.diveharder  class-attribute instance-attribute","text":"
diveharder: str = OFFICIAL_DIVEHARDER_URL\n
"},{"location":"api/models/#helldivepy.models.APIURLConfiguration.community","title":"helldivepy.models.APIURLConfiguration.community  class-attribute instance-attribute","text":"
community: str = OFFICIAL_COMMUNITY_URL\n
"},{"location":"api/models/#helldivepy.models.Statistics","title":"helldivepy.models.Statistics","text":"
               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 
"},{"location":"api/models/#helldivepy.models.Statistics-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.Statistics.missions_won","title":"helldivepy.models.Statistics.missions_won  class-attribute instance-attribute","text":"
missions_won: int = Field(alias='missionsWon')\n
"},{"location":"api/models/#helldivepy.models.Statistics.missions_lost","title":"helldivepy.models.Statistics.missions_lost  class-attribute instance-attribute","text":"
missions_lost: int = Field(alias='missionsLost')\n
"},{"location":"api/models/#helldivepy.models.Statistics.mission_time","title":"helldivepy.models.Statistics.mission_time  class-attribute instance-attribute","text":"
mission_time: int = Field(alias='missionTime')\n
"},{"location":"api/models/#helldivepy.models.Statistics.terminid_kills","title":"helldivepy.models.Statistics.terminid_kills  class-attribute instance-attribute","text":"
terminid_kills: int = Field(alias='terminidKills')\n
"},{"location":"api/models/#helldivepy.models.Statistics.automaton_kills","title":"helldivepy.models.Statistics.automaton_kills  class-attribute instance-attribute","text":"
automaton_kills: int = Field(alias='automatonKills')\n
"},{"location":"api/models/#helldivepy.models.Statistics.illuminate_kills","title":"helldivepy.models.Statistics.illuminate_kills  class-attribute instance-attribute","text":"
illuminate_kills: int = Field(alias='illuminateKills')\n
"},{"location":"api/models/#helldivepy.models.Statistics.bullets_fired","title":"helldivepy.models.Statistics.bullets_fired  class-attribute instance-attribute","text":"
bullets_fired: int = Field(alias='bulletsFired')\n
"},{"location":"api/models/#helldivepy.models.Statistics.bullets_hit","title":"helldivepy.models.Statistics.bullets_hit  class-attribute instance-attribute","text":"
bullets_hit: int = Field(alias='bulletsHit')\n
"},{"location":"api/models/#helldivepy.models.Statistics.time_played","title":"helldivepy.models.Statistics.time_played  class-attribute instance-attribute","text":"
time_played: int = Field(alias='timePlayed')\n
"},{"location":"api/models/#helldivepy.models.Statistics.deaths","title":"helldivepy.models.Statistics.deaths  instance-attribute","text":"
deaths: int\n
"},{"location":"api/models/#helldivepy.models.Statistics.revives","title":"helldivepy.models.Statistics.revives  instance-attribute","text":"
revives: int\n
"},{"location":"api/models/#helldivepy.models.Statistics.friendlies","title":"helldivepy.models.Statistics.friendlies  instance-attribute","text":"
friendlies: int\n
"},{"location":"api/models/#helldivepy.models.Statistics.mission_success_rate","title":"helldivepy.models.Statistics.mission_success_rate  class-attribute instance-attribute","text":"
mission_success_rate: float = Field(alias='missionSuccessRate')\n
"},{"location":"api/models/#helldivepy.models.Statistics.accuracy","title":"helldivepy.models.Statistics.accuracy  instance-attribute","text":"
accuracy: int\n
"},{"location":"api/models/#helldivepy.models.Statistics.player_count","title":"helldivepy.models.Statistics.player_count  class-attribute instance-attribute","text":"
player_count: int = Field(alias='playerCount')\n
"},{"location":"api/models/#helldivepy.models.WarInfo","title":"helldivepy.models.WarInfo","text":"
               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 
"},{"location":"api/models/#helldivepy.models.WarInfo-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.WarInfo.started","title":"helldivepy.models.WarInfo.started  instance-attribute","text":"
started: datetime\n
"},{"location":"api/models/#helldivepy.models.WarInfo.ended","title":"helldivepy.models.WarInfo.ended  instance-attribute","text":"
ended: datetime\n
"},{"location":"api/models/#helldivepy.models.WarInfo.now","title":"helldivepy.models.WarInfo.now  instance-attribute","text":"
now: datetime\n
"},{"location":"api/models/#helldivepy.models.WarInfo.client_version","title":"helldivepy.models.WarInfo.client_version  class-attribute instance-attribute","text":"
client_version: str = Field(alias='clientVersion')\n
"},{"location":"api/models/#helldivepy.models.WarInfo.factions","title":"helldivepy.models.WarInfo.factions  instance-attribute","text":"
factions: list[Literal['Humans', 'Terminids', 'Automaton', 'Illuminate']]\n
"},{"location":"api/models/#helldivepy.models.WarInfo.impact_multiplier","title":"helldivepy.models.WarInfo.impact_multiplier  class-attribute instance-attribute","text":"
impact_multiplier: float = Field(alias='impactMultiplier')\n
"},{"location":"api/models/#helldivepy.models.WarInfo.statistics","title":"helldivepy.models.WarInfo.statistics  instance-attribute","text":"
statistics: Statistics\n
"},{"location":"api/models/#helldivepy.models.Dispatch","title":"helldivepy.models.Dispatch","text":"
               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 
"},{"location":"api/models/#helldivepy.models.Dispatch-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.Dispatch.id","title":"helldivepy.models.Dispatch.id  instance-attribute","text":"
id: int\n
"},{"location":"api/models/#helldivepy.models.Dispatch.published","title":"helldivepy.models.Dispatch.published  instance-attribute","text":"
published: datetime\n
"},{"location":"api/models/#helldivepy.models.Dispatch.type","title":"helldivepy.models.Dispatch.type  instance-attribute","text":"
type: Literal[0]\n
"},{"location":"api/models/#helldivepy.models.Dispatch.message","title":"helldivepy.models.Dispatch.message  instance-attribute","text":"
message: str\n
"},{"location":"api/models/#helldivepy.models.SteamNews","title":"helldivepy.models.SteamNews","text":"
               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 
"},{"location":"api/models/#helldivepy.models.SteamNews-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.SteamNews.id","title":"helldivepy.models.SteamNews.id  instance-attribute","text":"
id: str\n
"},{"location":"api/models/#helldivepy.models.SteamNews.title","title":"helldivepy.models.SteamNews.title  instance-attribute","text":"
title: str\n
"},{"location":"api/models/#helldivepy.models.SteamNews.url","title":"helldivepy.models.SteamNews.url  instance-attribute","text":"
url: str\n
"},{"location":"api/models/#helldivepy.models.SteamNews.author","title":"helldivepy.models.SteamNews.author  instance-attribute","text":"
author: str\n
"},{"location":"api/models/#helldivepy.models.SteamNews.content","title":"helldivepy.models.SteamNews.content  instance-attribute","text":"
content: str\n
"},{"location":"api/models/#helldivepy.models.SteamNews.published_at","title":"helldivepy.models.SteamNews.published_at  class-attribute instance-attribute","text":"
published_at: datetime = Field(alias='publishedAt')\n
"},{"location":"api/models/#helldivepy.models.PlanetEvent","title":"helldivepy.models.PlanetEvent","text":"
               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] 
"},{"location":"api/models/#helldivepy.models.PlanetEvent-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.PlanetEvent.id","title":"helldivepy.models.PlanetEvent.id  instance-attribute","text":"
id: int\n
"},{"location":"api/models/#helldivepy.models.PlanetEvent.event_type","title":"helldivepy.models.PlanetEvent.event_type  class-attribute instance-attribute","text":"
event_type: int = Field(alias='eventType')\n
"},{"location":"api/models/#helldivepy.models.PlanetEvent.faction","title":"helldivepy.models.PlanetEvent.faction  instance-attribute","text":"
faction: FactionType\n
"},{"location":"api/models/#helldivepy.models.PlanetEvent.health","title":"helldivepy.models.PlanetEvent.health  instance-attribute","text":"
health: int\n
"},{"location":"api/models/#helldivepy.models.PlanetEvent.max_health","title":"helldivepy.models.PlanetEvent.max_health  class-attribute instance-attribute","text":"
max_health: int = Field(alias='maxHealth')\n
"},{"location":"api/models/#helldivepy.models.PlanetEvent.start_time","title":"helldivepy.models.PlanetEvent.start_time  class-attribute instance-attribute","text":"
start_time: datetime = Field(alias='startTime')\n
"},{"location":"api/models/#helldivepy.models.PlanetEvent.end_time","title":"helldivepy.models.PlanetEvent.end_time  class-attribute instance-attribute","text":"
end_time: datetime = Field(alias='endTime')\n
"},{"location":"api/models/#helldivepy.models.PlanetEvent.campaign_id","title":"helldivepy.models.PlanetEvent.campaign_id  class-attribute instance-attribute","text":"
campaign_id: int = Field(alias='campaignId')\n
"},{"location":"api/models/#helldivepy.models.PlanetEvent.joint_operation_ids","title":"helldivepy.models.PlanetEvent.joint_operation_ids  class-attribute instance-attribute","text":"
joint_operation_ids: list[int] = Field(alias='jointOperationIds')\n
"},{"location":"api/models/#helldivepy.models.PlanetEvent.planet","title":"helldivepy.models.PlanetEvent.planet  property","text":"
planet: Planet | None\n
 
Retrieves the planet associated with this event.
 RETURNS DESCRIPTION Planet | None 
Planet | None: Associated planet object if available, None otherwise.
"},{"location":"api/models/#helldivepy.models.Position","title":"helldivepy.models.Position","text":"
               Bases: BaseModel
 
2D coordinate position.
 
Represents a location in 2D space.
 ATTRIBUTE DESCRIPTION x 
Horizontal coordinate.
 
 TYPE: float 
 y 
Vertical coordinate.
 
 TYPE: float 
"},{"location":"api/models/#helldivepy.models.Position-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.Position.x","title":"helldivepy.models.Position.x  instance-attribute","text":"
x: float\n
"},{"location":"api/models/#helldivepy.models.Position.y","title":"helldivepy.models.Position.y  instance-attribute","text":"
y: float\n
"},{"location":"api/models/#helldivepy.models.PlanetaryHazard","title":"helldivepy.models.PlanetaryHazard","text":"
               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 
"},{"location":"api/models/#helldivepy.models.PlanetaryHazard-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.PlanetaryHazard.name","title":"helldivepy.models.PlanetaryHazard.name  instance-attribute","text":"
name: str\n
"},{"location":"api/models/#helldivepy.models.PlanetaryHazard.description","title":"helldivepy.models.PlanetaryHazard.description  instance-attribute","text":"
description: str\n
"},{"location":"api/models/#helldivepy.models.Biome","title":"helldivepy.models.Biome","text":"
               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 
"},{"location":"api/models/#helldivepy.models.Biome-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.Biome.name","title":"helldivepy.models.Biome.name  instance-attribute","text":"
name: str\n
"},{"location":"api/models/#helldivepy.models.Biome.description","title":"helldivepy.models.Biome.description  instance-attribute","text":"
description: str\n
"},{"location":"api/models/#helldivepy.models.Planet","title":"helldivepy.models.Planet","text":"
               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] 
"},{"location":"api/models/#helldivepy.models.Planet-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.Planet.index","title":"helldivepy.models.Planet.index  instance-attribute","text":"
index: int\n
"},{"location":"api/models/#helldivepy.models.Planet.name","title":"helldivepy.models.Planet.name  instance-attribute","text":"
name: str\n
"},{"location":"api/models/#helldivepy.models.Planet.sector","title":"helldivepy.models.Planet.sector  instance-attribute","text":"
sector: str\n
"},{"location":"api/models/#helldivepy.models.Planet.biome","title":"helldivepy.models.Planet.biome  instance-attribute","text":"
biome: Biome\n
"},{"location":"api/models/#helldivepy.models.Planet.hazards","title":"helldivepy.models.Planet.hazards  instance-attribute","text":"
hazards: list[PlanetaryHazard]\n
"},{"location":"api/models/#helldivepy.models.Planet.hash","title":"helldivepy.models.Planet.hash  instance-attribute","text":"
hash: int\n
"},{"location":"api/models/#helldivepy.models.Planet.position","title":"helldivepy.models.Planet.position  instance-attribute","text":"
position: Position\n
"},{"location":"api/models/#helldivepy.models.Planet.waypoints","title":"helldivepy.models.Planet.waypoints  instance-attribute","text":"
waypoints: list[int]\n
"},{"location":"api/models/#helldivepy.models.Planet.max_health","title":"helldivepy.models.Planet.max_health  class-attribute instance-attribute","text":"
max_health: int = Field(alias='maxHealth')\n
"},{"location":"api/models/#helldivepy.models.Planet.health","title":"helldivepy.models.Planet.health  instance-attribute","text":"
health: int\n
"},{"location":"api/models/#helldivepy.models.Planet.disabled","title":"helldivepy.models.Planet.disabled  instance-attribute","text":"
disabled: bool\n
"},{"location":"api/models/#helldivepy.models.Planet.initial_owner","title":"helldivepy.models.Planet.initial_owner  class-attribute instance-attribute","text":"
initial_owner: FactionType = Field(alias='initialOwner')\n
"},{"location":"api/models/#helldivepy.models.Planet.current_owner","title":"helldivepy.models.Planet.current_owner  class-attribute instance-attribute","text":"
current_owner: FactionType = Field(alias='currentOwner')\n
"},{"location":"api/models/#helldivepy.models.Planet.regen_per_second","title":"helldivepy.models.Planet.regen_per_second  class-attribute instance-attribute","text":"
regen_per_second: float = Field(alias='regenPerSecond')\n
"},{"location":"api/models/#helldivepy.models.Planet.event","title":"helldivepy.models.Planet.event  instance-attribute","text":"
event: PlanetEvent | None\n
"},{"location":"api/models/#helldivepy.models.Planet.statistics","title":"helldivepy.models.Planet.statistics  instance-attribute","text":"
statistics: Statistics\n
"},{"location":"api/models/#helldivepy.models.Planet.attacking","title":"helldivepy.models.Planet.attacking  instance-attribute","text":"
attacking: list[int]\n
"},{"location":"api/models/#helldivepy.models.Planet.has_space_station","title":"helldivepy.models.Planet.has_space_station  property","text":"
has_space_station: bool\n
 
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.
"},{"location":"api/models/#helldivepy.models.AssignmentTaskData","title":"helldivepy.models.AssignmentTaskData","text":"
               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 
"},{"location":"api/models/#helldivepy.models.AssignmentTaskData-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.AssignmentTaskData.liberate","title":"helldivepy.models.AssignmentTaskData.liberate  instance-attribute","text":"
liberate: bool | None\n
"},{"location":"api/models/#helldivepy.models.AssignmentTaskData.planet","title":"helldivepy.models.AssignmentTaskData.planet  instance-attribute","text":"
planet: Planet | None\n
"},{"location":"api/models/#helldivepy.models.AssignmentTaskData.target_count","title":"helldivepy.models.AssignmentTaskData.target_count  instance-attribute","text":"
target_count: int | None\n
"},{"location":"api/models/#helldivepy.models.AssignmentTaskData.race","title":"helldivepy.models.AssignmentTaskData.race  instance-attribute","text":"
race: FactionType | None\n
"},{"location":"api/models/#helldivepy.models.AssignmentTask","title":"helldivepy.models.AssignmentTask","text":"
               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 
"},{"location":"api/models/#helldivepy.models.AssignmentTask-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.AssignmentTask.type","title":"helldivepy.models.AssignmentTask.type  instance-attribute","text":"
type: AssignmentTypes\n
"},{"location":"api/models/#helldivepy.models.AssignmentTask.values","title":"helldivepy.models.AssignmentTask.values  instance-attribute","text":"
values: list[int]\n
"},{"location":"api/models/#helldivepy.models.AssignmentTask.value_types","title":"helldivepy.models.AssignmentTask.value_types  class-attribute instance-attribute","text":"
value_types: list[ValueTypes] = Field(alias='valueTypes')\n
"},{"location":"api/models/#helldivepy.models.AssignmentTask.data","title":"helldivepy.models.AssignmentTask.data  class-attribute instance-attribute","text":"
data: AssignmentTaskData = AssignmentTaskData(liberate=None, planet=None, target_count=None, race=None)\n
"},{"location":"api/models/#helldivepy.models.AssignmentTask-functions","title":"Functions","text":""},{"location":"api/models/#helldivepy.models.AssignmentTask.model_post_init","title":"helldivepy.models.AssignmentTask.model_post_init","text":"
model_post_init(__context: typing.Any) -> None\n
 
Initializes task data after model creation.
 PARAMETER DESCRIPTION __context 
Initialization context data.
 
 TYPE: Any 
 RAISES DESCRIPTION ValueError 
If ApiClient is not properly initialized.
"},{"location":"api/models/#helldivepy.models.AssignmentReward","title":"helldivepy.models.AssignmentReward","text":"
               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 
"},{"location":"api/models/#helldivepy.models.AssignmentReward-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.AssignmentReward.type","title":"helldivepy.models.AssignmentReward.type  instance-attribute","text":"
type: int\n
"},{"location":"api/models/#helldivepy.models.AssignmentReward.amount","title":"helldivepy.models.AssignmentReward.amount  instance-attribute","text":"
amount: int\n
"},{"location":"api/models/#helldivepy.models.Assignment","title":"helldivepy.models.Assignment","text":"
               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 
"},{"location":"api/models/#helldivepy.models.Assignment-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.Assignment.id","title":"helldivepy.models.Assignment.id  instance-attribute","text":"
id: int\n
"},{"location":"api/models/#helldivepy.models.Assignment.progress","title":"helldivepy.models.Assignment.progress  instance-attribute","text":"
progress: list[int]\n
"},{"location":"api/models/#helldivepy.models.Assignment.title","title":"helldivepy.models.Assignment.title  class-attribute instance-attribute","text":"
title: str | None = None\n
"},{"location":"api/models/#helldivepy.models.Assignment.briefing","title":"helldivepy.models.Assignment.briefing  class-attribute instance-attribute","text":"
briefing: str | None = None\n
"},{"location":"api/models/#helldivepy.models.Assignment.description","title":"helldivepy.models.Assignment.description  class-attribute instance-attribute","text":"
description: str | None = None\n
"},{"location":"api/models/#helldivepy.models.Assignment.tasks","title":"helldivepy.models.Assignment.tasks  instance-attribute","text":"
tasks: list[AssignmentTask]\n
"},{"location":"api/models/#helldivepy.models.Assignment.reward","title":"helldivepy.models.Assignment.reward  instance-attribute","text":"
reward: AssignmentReward\n
"},{"location":"api/models/#helldivepy.models.Assignment.expiration","title":"helldivepy.models.Assignment.expiration  instance-attribute","text":"
expiration: datetime\n
"},{"location":"api/models/#helldivepy.models.Assignment.is_complete","title":"helldivepy.models.Assignment.is_complete  property","text":"
is_complete: bool\n
 
Checks if all assignment tasks are complete.
 RETURNS DESCRIPTION bool 
True if all tasks meet their target count, False otherwise.
 
 TYPE: bool 
"},{"location":"api/models/#helldivepy.models.Campaign","title":"helldivepy.models.Campaign","text":"
               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 
"},{"location":"api/models/#helldivepy.models.Campaign-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.Campaign.id","title":"helldivepy.models.Campaign.id  instance-attribute","text":"
id: int\n
"},{"location":"api/models/#helldivepy.models.Campaign.planet","title":"helldivepy.models.Campaign.planet  instance-attribute","text":"
planet: Planet\n
"},{"location":"api/models/#helldivepy.models.Campaign.type","title":"helldivepy.models.Campaign.type  instance-attribute","text":"
type: CampaignTypes\n
"},{"location":"api/models/#helldivepy.models.Campaign.count","title":"helldivepy.models.Campaign.count  instance-attribute","text":"
count: int\n
"},{"location":"api/models/#helldivepy.models.SpaceStation","title":"helldivepy.models.SpaceStation","text":"
               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 
"},{"location":"api/models/#helldivepy.models.SpaceStation-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.SpaceStation.id","title":"helldivepy.models.SpaceStation.id  class-attribute instance-attribute","text":"
id: int = Field(alias='id32')\n
"},{"location":"api/models/#helldivepy.models.SpaceStation.planet","title":"helldivepy.models.SpaceStation.planet  instance-attribute","text":"
planet: Planet\n
"},{"location":"api/models/#helldivepy.models.SpaceStation.election_end","title":"helldivepy.models.SpaceStation.election_end  class-attribute instance-attribute","text":"
election_end: datetime = Field(alias='electionEnd')\n
"},{"location":"api/models/#helldivepy.models.SpaceStation.flags","title":"helldivepy.models.SpaceStation.flags  instance-attribute","text":"
flags: int\n
"},{"location":"api/routes/","title":"Routes","text":""},{"location":"api/routes/#helldivepy.api","title":"helldivepy.api","text":""},{"location":"api/routes/#helldivepy.api-attributes","title":"Attributes","text":""},{"location":"api/routes/#helldivepy.api.__all__","title":"helldivepy.api.__all__  module-attribute","text":"
__all__ = ['DispatchModule', 'WarModule', 'SteamModule', 'AssignmentsModule', 'PlanetsModule', 'CampaignModule', 'SpaceStationModule']\n
"},{"location":"api/routes/#helldivepy.api-classes","title":"Classes","text":""},{"location":"api/routes/#helldivepy.api.DispatchModule","title":"helldivepy.api.DispatchModule","text":"
DispatchModule(api_client: ApiClient)\n
 
               Bases: BaseApiModule
 
The Dispatch API module. This module is used to interact with all dispatches (Ingame News)
 METHOD DESCRIPTION get_dispatches 
bool): Gets all dispatches and orders them based on the old_to_new argument.
 get_dispatch 
int): Gets a dispatch by its ID.
"},{"location":"api/routes/#helldivepy.api.DispatchModule-functions","title":"Functions","text":""},{"location":"api/routes/#helldivepy.api.DispatchModule.get_dispatches","title":"helldivepy.api.DispatchModule.get_dispatches","text":"
get_dispatches(old_to_new: bool = True) -> typing.List[models.Dispatch]\n
 
Gets the information about the current war.
"},{"location":"api/routes/#helldivepy.api.DispatchModule.get_dispatch","title":"helldivepy.api.DispatchModule.get_dispatch","text":"
get_dispatch(dispatch_id: int) -> models.Dispatch\n
 
Gets the information about the current war.
"},{"location":"api/routes/#helldivepy.api.WarModule","title":"helldivepy.api.WarModule","text":"
WarModule(api_client: ApiClient)\n
 
               Bases: BaseApiModule
 
The War module of the API. This module is used to get all info about the current war.
 METHOD DESCRIPTION get_war_info 
Gets the information about the current war.
"},{"location":"api/routes/#helldivepy.api.WarModule-functions","title":"Functions","text":""},{"location":"api/routes/#helldivepy.api.WarModule.get_war_info","title":"helldivepy.api.WarModule.get_war_info","text":"
get_war_info() -> models.WarInfo\n
 
Gets the information about the current war.
"},{"location":"api/routes/#helldivepy.api.SteamModule","title":"helldivepy.api.SteamModule","text":"
SteamModule(api_client: ApiClient)\n
 
               Bases: BaseApiModule
 
The Steam API module. Used to get all the Game updates and News.
 METHOD DESCRIPTION get_all_steam_news 
Gets all the steam news.
 get_steam_news 
str): Gets a steam news item by its ID.
"},{"location":"api/routes/#helldivepy.api.SteamModule-functions","title":"Functions","text":""},{"location":"api/routes/#helldivepy.api.SteamModule.get_all_steam_news","title":"helldivepy.api.SteamModule.get_all_steam_news","text":"
get_all_steam_news() -> typing.List[models.SteamNews]\n
 
Gets the information about the current war.
"},{"location":"api/routes/#helldivepy.api.SteamModule.get_steam_news","title":"helldivepy.api.SteamModule.get_steam_news","text":"
get_steam_news(gid: str) -> models.SteamNews\n
 
Gets the information about the current war.
"},{"location":"api/routes/#helldivepy.api.AssignmentsModule","title":"helldivepy.api.AssignmentsModule","text":"
AssignmentsModule(api_client: ApiClient)\n
 
               Bases: BaseApiModule
 
The Assignments API module (Major Order). This module is used to interact with the current major order(s).
 METHOD DESCRIPTION get_all_assignments 
Gets all current assignments
 get_assignment 
int): Gets one assignment using the assignment ID
"},{"location":"api/routes/#helldivepy.api.AssignmentsModule-functions","title":"Functions","text":""},{"location":"api/routes/#helldivepy.api.AssignmentsModule.get_all_assignments","title":"helldivepy.api.AssignmentsModule.get_all_assignments","text":"
get_all_assignments() -> typing.List[models.Assignment]\n
 
Gets all current assignments
"},{"location":"api/routes/#helldivepy.api.AssignmentsModule.get_assignment","title":"helldivepy.api.AssignmentsModule.get_assignment","text":"
get_assignment(assignment_id: int) -> models.Assignment\n
 
Gets one assignment using the assignment ID
"},{"location":"api/routes/#helldivepy.api.PlanetsModule","title":"helldivepy.api.PlanetsModule","text":"
PlanetsModule(api_client: ApiClient)\n
 
               Bases: BaseApiModule
 
The Planets API module. This module is used to interact with the planets.
 METHOD DESCRIPTION get_planets 
Gets all planets.
 get_planet 
int): Gets a planet using the index.
 get_planets_with_events 
Gets all planets with events.
"},{"location":"api/routes/#helldivepy.api.PlanetsModule-functions","title":"Functions","text":""},{"location":"api/routes/#helldivepy.api.PlanetsModule.get_planets","title":"helldivepy.api.PlanetsModule.get_planets","text":"
get_planets() -> typing.List[models.Planet]\n
 
Get all planets
 RETURNS DESCRIPTION List[Planet] 
typing.List[models.Planet]: The list of planet objects
"},{"location":"api/routes/#helldivepy.api.PlanetsModule.get_planet","title":"helldivepy.api.PlanetsModule.get_planet","text":"
get_planet(index: int, cached: bool = False) -> models.Planet\n
 
Gets a planet using the index
 PARAMETER DESCRIPTION index 
The index of the planet
 
 TYPE: int 
 RETURNS DESCRIPTION Planet 
models.Planet: The planet object
"},{"location":"api/routes/#helldivepy.api.PlanetsModule.get_planets_with_events","title":"helldivepy.api.PlanetsModule.get_planets_with_events","text":"
get_planets_with_events() -> typing.List[models.Planet]\n
 
Gets all planets with an active event
 RETURNS DESCRIPTION List[Planet] 
typing.List[models.Planet]: The list of planet objects
"},{"location":"api/routes/#helldivepy.api.CampaignModule","title":"helldivepy.api.CampaignModule","text":"
CampaignModule(api_client: ApiClient)\n
 
               Bases: BaseApiModule
 
The Campaign API module. This module is used to interact with all campaigns (Battles/Planets that are accessible).
 METHOD DESCRIPTION get_campaigns 
Gets all current active campaigns.
 get_campaign 
int): Gets a campaign by its ID.
"},{"location":"api/routes/#helldivepy.api.CampaignModule-functions","title":"Functions","text":""},{"location":"api/routes/#helldivepy.api.CampaignModule.get_campaigns","title":"helldivepy.api.CampaignModule.get_campaigns","text":"
get_campaigns() -> typing.List[models.Campaign]\n
 
Gets all current active campaigns.
 RETURNS DESCRIPTION List[Campaign] 
typing.List[models.Campaign]: The campaigns.
"},{"location":"api/routes/#helldivepy.api.CampaignModule.get_campaign","title":"helldivepy.api.CampaignModule.get_campaign","text":"
get_campaign(campaign_id: int) -> models.Campaign\n
 
Gets a campaign by its ID.
 PARAMETER DESCRIPTION campaign_id 
The ID of the campaign.
 
 TYPE: int 
 RETURNS DESCRIPTION Campaign 
models.Campaign: The campaign.
"},{"location":"api/routes/#helldivepy.api.SpaceStationModule","title":"helldivepy.api.SpaceStationModule","text":"
SpaceStationModule(api_client: ApiClient)\n
 
               Bases: BaseApiModule
"},{"location":"api/routes/#helldivepy.api.SpaceStationModule-functions","title":"Functions","text":""},{"location":"api/routes/#helldivepy.api.SpaceStationModule.get_space_stations","title":"helldivepy.api.SpaceStationModule.get_space_stations","text":"
get_space_stations() -> list[models.SpaceStation]\n
 
Retrieves all space stations.
 RETURNS DESCRIPTION list[SpaceStation] 
list[SpaceStation]: A list of space station objects from the server.
"},{"location":"api/routes/#helldivepy.api.SpaceStationModule.get_space_station","title":"helldivepy.api.SpaceStationModule.get_space_station","text":"
get_space_station(index: int) -> Optional[models.SpaceStation]\n
 
Retrieves a space station by its ID.
 PARAMETER DESCRIPTION index 
The ID of the space station.
 
 TYPE: int 
 RETURNS DESCRIPTION Optional[SpaceStation] 
Optional[SpaceStation]: The space station object if found, or None.
"},{"location":"api/utils/","title":"Utils","text":""},{"location":"api/utils/#helldivepy.utils","title":"helldivepy.utils","text":""},{"location":"api/utils/#helldivepy.utils-attributes","title":"Attributes","text":""},{"location":"api/utils/#helldivepy.utils.FACTIONS","title":"helldivepy.utils.FACTIONS  module-attribute","text":"
FACTIONS = {1: 'Humans', 2: 'Terminids', 3: 'Automaton', 4: 'Illuminate'}\n
"},{"location":"api/utils/#helldivepy.utils-classes","title":"Classes","text":""},{"location":"api/utils/#helldivepy.utils.DiveHarderException","title":"helldivepy.utils.DiveHarderException","text":"
               Bases: Exception
 
Base exception for all DiveHarder exceptions.
"},{"location":"api/utils/#helldivepy.utils.DiveHarderAPIConnectionError","title":"helldivepy.utils.DiveHarderAPIConnectionError","text":"
               Bases: DiveHarderException
 
Exception raised when the DiveHarder API connection fails.
"},{"location":"api/utils/#helldivepy.utils-functions","title":"Functions","text":""},{"location":"api/utils/#helldivepy.utils.hdml_to_md","title":"helldivepy.utils.hdml_to_md","text":"
hdml_to_md(text: str) -> str\n
 
Converts a string in HDML (DiveHarder Markup Language) format to Markdown format.
 PARAMETER DESCRIPTION text 
The input string in HDML format.
 
 TYPE: str 
 RETURNS DESCRIPTION str 
The input string converted to Markdown format.
 
 TYPE: str 
"},{"location":"api/utils/#helldivepy.utils.url_join","title":"helldivepy.utils.url_join","text":"
url_join(*args)\n
 
Join combine URL parts to get the full endpoint address.
"},{"location":"api/utils/#helldivepy.utils.parse_faction","title":"helldivepy.utils.parse_faction","text":"
parse_faction(faction: int) -> enums.FactionType | None\n
 
Parse faction ID to string
 PARAMETER DESCRIPTION faction 
The faction ID
 
 TYPE: int 
 RETURNS DESCRIPTION str 
The faction name
 
 TYPE: FactionType | None 
"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Helldive.py","text":"
A simple Python library for diving deep into the Helldivers Community API and Diveharder API.
"},{"location":"#features","title":"\ud83c\udf1f Features","text":"
     
  • Easy API Access: Communicate with the Helldivers Community API and Diveharder API without breaking a sweat.
    •  
  • Typed Data: Get structured, easily readable data like dispatches, planets, and more!
    •  
  • Perfect for Projects: Ideal for projects, bots, or just exploring Helldivers data.
    •  
"},{"location":"#links","title":"\ud83d\udd17 Links","text":"
     
  • Get Started
    •  
  • DiveHarder
    •  
  • Community API
    •  
  • API discussion Discord
    •  
"},{"location":"installation/","title":"\ud83d\ude80 Get Started","text":""},{"location":"installation/#installation","title":"\u2699\ufe0f Installation","text":"PipPoetryUV 
pip install helldivepy\n
 Poetry 
Install poetry here.
 
poetry add helldivepy\n
 UV 
Install UV here.
 
uv add helldivepy\n
 
Example code
 Without RichWith rich 
from helldivepy import ApiClient\nclient = ApiClient(\n    user_agent=\"Hello-World\",\n    user_contact=\"example@example.com | discord:exampleuser123\",\n)\n\nprint(client.get_war_info().model_dump())\n>>>\n    {\n        'started': datetime.datetime(2024, 1, 23, 20, 5, 13, tzinfo=TzInfo(UTC)),\n        'ended': datetime.datetime(2028, 2, 8, 20, 4, 55, tzinfo=TzInfo(UTC)),\n        'now': datetime.datetime(1970, 11, 6, 14, 59, 50, tzinfo=TzInfo(UTC)),\n        'client_version': '0.3.0',\n        'factions': ['Humans', 'Terminids', 'Automaton', 'Illuminate'],\n        'impact_multiplier': 0.034382936,\n        'statistics': {\n            'missions_won': 370390368,\n            'missions_lost': 37224925,\n            'mission_time': 1047433682627,\n            'terminid_kills': 79906866134,\n            'automaton_kills': 31552895947,\n            'illuminate_kills': 3705435035,\n            'bullets_fired': 571067857117,\n            'bullets_hit': 645369797775,\n            'time_played': 1047433682627,\n            'deaths': 2564546790,\n            'revives': 2,\n            'friendlies': 361359530,\n            'mission_success_rate': 90.0,\n            'accuracy': 100,\n            'player_count': 111316\n        }\n    }\n
 
from helldivepy import ApiClient\nfrom rich import print\n\nclient = ApiClient(\n    user_agent=\"Hello-World\",\n    user_contact=\"example@example.com | discord:exampleuser123\",\n)\n\nprint(client.get_war_info())\n>>> WarInfo(\n    started=datetime.datetime(2024, 1, 23, 20, 5, 13, tzinfo=TzInfo(UTC)),\n    ended=datetime.datetime(2028, 2, 8, 20, 4, 55, tzinfo=TzInfo(UTC)),\n    now=datetime.datetime(1970, 11, 6, 14, 24, 40, tzinfo=TzInfo(UTC)),\n    client_version='0.3.0',\n    factions=['Humans', 'Terminids', 'Automaton', 'Illuminate'],\n    impact_multiplier=0.03595309,\n    statistics=Statistics(\n        missions_won=370353637,\n        missions_lost=37219878,\n        mission_time=1047300170684,\n        terminid_kills=79904593412,\n        automaton_kills=31551843355,\n        illuminate_kills=3687632552,\n        bullets_fired=570972530827,\n        bullets_hit=645273266867,\n        time_played=1047300170684,\n        deaths=2564288334,\n        revives=2,\n        friendlies=361317130,\n        mission_success_rate=90.0,\n        accuracy=100,\n        player_count=102995\n    )\n)\n
"},{"location":"links/","title":"\ud83d\udd17 Links","text":"
A list of links that may come in handy when using this lib or other parts of the community API.
 
     
  • PyPi project
    •  
  • DiveHarder
    •  
  • Community API
    •  
  • Comuunity Github
    •  
  • API discussion Discord
    •  
"},{"location":"api/","title":"API Reference","text":""},{"location":"api/#helldivepy","title":"helldivepy","text":""},{"location":"api/#helldivepy-attributes","title":"Attributes","text":""},{"location":"api/#helldivepy.__all__","title":"helldivepy.__all__  module-attribute","text":"
__all__ = ['ApiClient']\n
"},{"location":"api/#helldivepy-classes","title":"Classes","text":""},{"location":"api/#helldivepy.ApiClient","title":"helldivepy.ApiClient","text":"
ApiClient(\n    user_agent: str,\n    user_contact: str,\n    debug: bool = False,\n    diveharder_url: str = OFFICIAL_DIVEHARDER_URL,\n    community_url: str = OFFICIAL_COMMUNITY_URL,\n)\n
 
The client used to interact with the Helldivers 2 APIs
 
The client used to interact with the Helldivers 2 APIs
 PARAMETER DESCRIPTION user_agent 
The user agent to use when making requests.
 
 TYPE: str 
 user_contact 
The user contact to use when making requests.
 
 TYPE: str 
 debug 
Enables debug logging for development.
 
 TYPE: bool DEFAULT: False 
 diveharder_url 
The diveharder API url to use. Defaults to constants.OFFICIAL_DIVEHARDER_URL.
 
 TYPE: str DEFAULT: OFFICIAL_DIVEHARDER_URL 
 community_url 
The community API url to use. Defaults to constants.OFFICIAL_COMMUNITY_URL.
 
 TYPE: str DEFAULT: OFFICIAL_COMMUNITY_URL 
"},{"location":"api/#helldivepy.ApiClient-attributes","title":"Attributes","text":""},{"location":"api/#helldivepy.ApiClient.debug","title":"helldivepy.ApiClient.debug  instance-attribute","text":"
debug = debug\n
"},{"location":"api/#helldivepy.ApiClient.logger","title":"helldivepy.ApiClient.logger  instance-attribute","text":"
logger = set_logger(debug)\n
"},{"location":"api/#helldivepy.ApiClient.api_config","title":"helldivepy.ApiClient.api_config  instance-attribute","text":"
api_config = APIURLConfiguration(\n    diveharder=diveharder_url, community=community_url\n)\n
"},{"location":"api/#helldivepy.ApiClient.war","title":"helldivepy.ApiClient.war  property","text":"
war: WarModule\n
"},{"location":"api/#helldivepy.ApiClient.dispatch","title":"helldivepy.ApiClient.dispatch  property","text":"
dispatch: DispatchModule\n
"},{"location":"api/#helldivepy.ApiClient.steam","title":"helldivepy.ApiClient.steam  property","text":"
steam: SteamModule\n
"},{"location":"api/#helldivepy.ApiClient.assignments","title":"helldivepy.ApiClient.assignments  property","text":"
assignments: AssignmentsModule\n
"},{"location":"api/#helldivepy.ApiClient.major_orders","title":"helldivepy.ApiClient.major_orders  property","text":"
major_orders: AssignmentsModule\n
"},{"location":"api/#helldivepy.ApiClient.planets","title":"helldivepy.ApiClient.planets  property","text":"
planets: PlanetsModule\n
"},{"location":"api/#helldivepy.ApiClient.campaigns","title":"helldivepy.ApiClient.campaigns  property","text":"
campaigns: CampaignModule\n
"},{"location":"api/#helldivepy.ApiClient.space_stations","title":"helldivepy.ApiClient.space_stations  property","text":"
space_stations: SpaceStationModule\n
"},{"location":"api/#helldivepy.ApiClient-functions","title":"Functions","text":""},{"location":"api/#helldivepy.ApiClient.get_client","title":"helldivepy.ApiClient.get_client  classmethod","text":"
get_client()\n
"},{"location":"api/#helldivepy.ApiClient.get_war_info","title":"helldivepy.ApiClient.get_war_info","text":"
get_war_info() -> models.WarInfo\n
"},{"location":"api/constants/","title":"Constants","text":""},{"location":"api/constants/#helldivepy.constants","title":"helldivepy.constants","text":""},{"location":"api/constants/#helldivepy.constants-attributes","title":"Attributes","text":""},{"location":"api/constants/#helldivepy.constants.OFFICIAL_DIVEHARDER_URL","title":"helldivepy.constants.OFFICIAL_DIVEHARDER_URL  module-attribute","text":"
OFFICIAL_DIVEHARDER_URL = 'https://api.diveharder.com'\n
"},{"location":"api/constants/#helldivepy.constants.OFFICIAL_COMMUNITY_URL","title":"helldivepy.constants.OFFICIAL_COMMUNITY_URL  module-attribute","text":"
OFFICIAL_COMMUNITY_URL = 'https://api.helldivers2.dev'\n
"},{"location":"api/constants/#helldivepy.constants.FACTIONS","title":"helldivepy.constants.FACTIONS  module-attribute","text":"
FACTIONS = {\n    1: \"Humans\",\n    2: \"Terminids\",\n    3: \"Automaton\",\n    4: \"Illuminate\",\n}\n
"},{"location":"api/enums/","title":"Enums","text":""},{"location":"api/enums/#helldivepy.enums","title":"helldivepy.enums","text":""},{"location":"api/enums/#helldivepy.enums-attributes","title":"Attributes","text":""},{"location":"api/enums/#helldivepy.enums.FactionType","title":"helldivepy.enums.FactionType  module-attribute","text":"
FactionType = Literal[\n    \"Humans\", \"Terminids\", \"Automaton\", \"Illuminate\"\n]\n
"},{"location":"api/enums/#helldivepy.enums-classes","title":"Classes","text":""},{"location":"api/enums/#helldivepy.enums.BetterEnum","title":"helldivepy.enums.BetterEnum","text":"
               Bases: Enum
"},{"location":"api/enums/#helldivepy.enums.BetterEnum-functions","title":"Functions","text":""},{"location":"api/enums/#helldivepy.enums.BetterEnum.parse","title":"helldivepy.enums.BetterEnum.parse  classmethod","text":"
parse(value)\n
"},{"location":"api/enums/#helldivepy.enums.CampaignTypes","title":"helldivepy.enums.CampaignTypes","text":"
               Bases: BetterEnum
 
Types of campaigns in the game
"},{"location":"api/enums/#helldivepy.enums.CampaignTypes-attributes","title":"Attributes","text":""},{"location":"api/enums/#helldivepy.enums.CampaignTypes.LIBERATION_DEFENSE","title":"helldivepy.enums.CampaignTypes.LIBERATION_DEFENSE  class-attribute instance-attribute","text":"
LIBERATION_DEFENSE = 0\n
"},{"location":"api/enums/#helldivepy.enums.CampaignTypes.RECON","title":"helldivepy.enums.CampaignTypes.RECON  class-attribute instance-attribute","text":"
RECON = 1\n
"},{"location":"api/enums/#helldivepy.enums.CampaignTypes.STORY","title":"helldivepy.enums.CampaignTypes.STORY  class-attribute instance-attribute","text":"
STORY = 2\n
"},{"location":"api/enums/#helldivepy.enums.ValueTypes","title":"helldivepy.enums.ValueTypes","text":"
               Bases: BetterEnum
 
Types of values returned from the major order/assignments endpoint.
"},{"location":"api/enums/#helldivepy.enums.ValueTypes-attributes","title":"Attributes","text":""},{"location":"api/enums/#helldivepy.enums.ValueTypes.RACE","title":"helldivepy.enums.ValueTypes.RACE  class-attribute instance-attribute","text":"
RACE = 1\n
"},{"location":"api/enums/#helldivepy.enums.ValueTypes.UNKNOWN","title":"helldivepy.enums.ValueTypes.UNKNOWN  class-attribute instance-attribute","text":"
UNKNOWN = 2\n
"},{"location":"api/enums/#helldivepy.enums.ValueTypes.TARGET_COUNT","title":"helldivepy.enums.ValueTypes.TARGET_COUNT  class-attribute instance-attribute","text":"
TARGET_COUNT = 3\n
"},{"location":"api/enums/#helldivepy.enums.ValueTypes.UNIT_ID","title":"helldivepy.enums.ValueTypes.UNIT_ID  class-attribute instance-attribute","text":"
UNIT_ID = 4\n
"},{"location":"api/enums/#helldivepy.enums.ValueTypes.ITEM_ID","title":"helldivepy.enums.ValueTypes.ITEM_ID  class-attribute instance-attribute","text":"
ITEM_ID = 5\n
"},{"location":"api/enums/#helldivepy.enums.ValueTypes.LIBERATE","title":"helldivepy.enums.ValueTypes.LIBERATE  class-attribute instance-attribute","text":"
LIBERATE = 11\n
"},{"location":"api/enums/#helldivepy.enums.ValueTypes.PLANET","title":"helldivepy.enums.ValueTypes.PLANET  class-attribute instance-attribute","text":"
PLANET = 12\n
"},{"location":"api/enums/#helldivepy.enums.RewardTypes","title":"helldivepy.enums.RewardTypes","text":"
               Bases: BetterEnum
 
Types of rewards given out by the major order/assignments.
"},{"location":"api/enums/#helldivepy.enums.RewardTypes-attributes","title":"Attributes","text":""},{"location":"api/enums/#helldivepy.enums.RewardTypes.MEDALS","title":"helldivepy.enums.RewardTypes.MEDALS  class-attribute instance-attribute","text":"
MEDALS = 1\n
"},{"location":"api/enums/#helldivepy.enums.AssignmentTypes","title":"helldivepy.enums.AssignmentTypes","text":"
               Bases: BetterEnum
 
Types of assignments.
"},{"location":"api/enums/#helldivepy.enums.AssignmentTypes-attributes","title":"Attributes","text":""},{"location":"api/enums/#helldivepy.enums.AssignmentTypes.ERADICATE","title":"helldivepy.enums.AssignmentTypes.ERADICATE  class-attribute instance-attribute","text":"
ERADICATE = 3\n
"},{"location":"api/enums/#helldivepy.enums.AssignmentTypes.LIBERATION","title":"helldivepy.enums.AssignmentTypes.LIBERATION  class-attribute instance-attribute","text":"
LIBERATION = 11\n
"},{"location":"api/enums/#helldivepy.enums.AssignmentTypes.DEFENSE","title":"helldivepy.enums.AssignmentTypes.DEFENSE  class-attribute instance-attribute","text":"
DEFENSE = 12\n
"},{"location":"api/enums/#helldivepy.enums.AssignmentTypes.CONTROL","title":"helldivepy.enums.AssignmentTypes.CONTROL  class-attribute instance-attribute","text":"
CONTROL = 13\n
"},{"location":"api/models/","title":"Models","text":""},{"location":"api/models/#helldivepy.models","title":"helldivepy.models","text":""},{"location":"api/models/#helldivepy.models-classes","title":"Classes","text":""},{"location":"api/models/#helldivepy.models.APIURLConfiguration","title":"helldivepy.models.APIURLConfiguration","text":"
               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 
"},{"location":"api/models/#helldivepy.models.APIURLConfiguration-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.APIURLConfiguration.diveharder","title":"helldivepy.models.APIURLConfiguration.diveharder  class-attribute instance-attribute","text":"
diveharder: str = OFFICIAL_DIVEHARDER_URL\n
"},{"location":"api/models/#helldivepy.models.APIURLConfiguration.community","title":"helldivepy.models.APIURLConfiguration.community  class-attribute instance-attribute","text":"
community: str = OFFICIAL_COMMUNITY_URL\n
"},{"location":"api/models/#helldivepy.models.Statistics","title":"helldivepy.models.Statistics","text":"
               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 
"},{"location":"api/models/#helldivepy.models.Statistics-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.Statistics.missions_won","title":"helldivepy.models.Statistics.missions_won  class-attribute instance-attribute","text":"
missions_won: int = Field(alias='missionsWon')\n
"},{"location":"api/models/#helldivepy.models.Statistics.missions_lost","title":"helldivepy.models.Statistics.missions_lost  class-attribute instance-attribute","text":"
missions_lost: int = Field(alias='missionsLost')\n
"},{"location":"api/models/#helldivepy.models.Statistics.mission_time","title":"helldivepy.models.Statistics.mission_time  class-attribute instance-attribute","text":"
mission_time: int = Field(alias='missionTime')\n
"},{"location":"api/models/#helldivepy.models.Statistics.terminid_kills","title":"helldivepy.models.Statistics.terminid_kills  class-attribute instance-attribute","text":"
terminid_kills: int = Field(alias='terminidKills')\n
"},{"location":"api/models/#helldivepy.models.Statistics.automaton_kills","title":"helldivepy.models.Statistics.automaton_kills  class-attribute instance-attribute","text":"
automaton_kills: int = Field(alias='automatonKills')\n
"},{"location":"api/models/#helldivepy.models.Statistics.illuminate_kills","title":"helldivepy.models.Statistics.illuminate_kills  class-attribute instance-attribute","text":"
illuminate_kills: int = Field(alias='illuminateKills')\n
"},{"location":"api/models/#helldivepy.models.Statistics.bullets_fired","title":"helldivepy.models.Statistics.bullets_fired  class-attribute instance-attribute","text":"
bullets_fired: int = Field(alias='bulletsFired')\n
"},{"location":"api/models/#helldivepy.models.Statistics.bullets_hit","title":"helldivepy.models.Statistics.bullets_hit  class-attribute instance-attribute","text":"
bullets_hit: int = Field(alias='bulletsHit')\n
"},{"location":"api/models/#helldivepy.models.Statistics.time_played","title":"helldivepy.models.Statistics.time_played  class-attribute instance-attribute","text":"
time_played: int = Field(alias='timePlayed')\n
"},{"location":"api/models/#helldivepy.models.Statistics.deaths","title":"helldivepy.models.Statistics.deaths  instance-attribute","text":"
deaths: int\n
"},{"location":"api/models/#helldivepy.models.Statistics.revives","title":"helldivepy.models.Statistics.revives  instance-attribute","text":"
revives: int\n
"},{"location":"api/models/#helldivepy.models.Statistics.friendlies","title":"helldivepy.models.Statistics.friendlies  instance-attribute","text":"
friendlies: int\n
"},{"location":"api/models/#helldivepy.models.Statistics.mission_success_rate","title":"helldivepy.models.Statistics.mission_success_rate  class-attribute instance-attribute","text":"
mission_success_rate: float = Field(\n    alias=\"missionSuccessRate\"\n)\n
"},{"location":"api/models/#helldivepy.models.Statistics.accuracy","title":"helldivepy.models.Statistics.accuracy  instance-attribute","text":"
accuracy: int\n
"},{"location":"api/models/#helldivepy.models.Statistics.player_count","title":"helldivepy.models.Statistics.player_count  class-attribute instance-attribute","text":"
player_count: int = Field(alias='playerCount')\n
"},{"location":"api/models/#helldivepy.models.WarInfo","title":"helldivepy.models.WarInfo","text":"
               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 
"},{"location":"api/models/#helldivepy.models.WarInfo-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.WarInfo.started","title":"helldivepy.models.WarInfo.started  instance-attribute","text":"
started: datetime\n
"},{"location":"api/models/#helldivepy.models.WarInfo.ended","title":"helldivepy.models.WarInfo.ended  instance-attribute","text":"
ended: datetime\n
"},{"location":"api/models/#helldivepy.models.WarInfo.now","title":"helldivepy.models.WarInfo.now  instance-attribute","text":"
now: datetime\n
"},{"location":"api/models/#helldivepy.models.WarInfo.client_version","title":"helldivepy.models.WarInfo.client_version  class-attribute instance-attribute","text":"
client_version: str = Field(alias='clientVersion')\n
"},{"location":"api/models/#helldivepy.models.WarInfo.factions","title":"helldivepy.models.WarInfo.factions  instance-attribute","text":"
factions: list[\n    Literal[\n        \"Humans\", \"Terminids\", \"Automaton\", \"Illuminate\"\n    ]\n]\n
"},{"location":"api/models/#helldivepy.models.WarInfo.impact_multiplier","title":"helldivepy.models.WarInfo.impact_multiplier  class-attribute instance-attribute","text":"
impact_multiplier: float = Field(alias='impactMultiplier')\n
"},{"location":"api/models/#helldivepy.models.WarInfo.statistics","title":"helldivepy.models.WarInfo.statistics  instance-attribute","text":"
statistics: Statistics\n
"},{"location":"api/models/#helldivepy.models.Dispatch","title":"helldivepy.models.Dispatch","text":"
               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 
"},{"location":"api/models/#helldivepy.models.Dispatch-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.Dispatch.id","title":"helldivepy.models.Dispatch.id  instance-attribute","text":"
id: int\n
"},{"location":"api/models/#helldivepy.models.Dispatch.published","title":"helldivepy.models.Dispatch.published  instance-attribute","text":"
published: datetime\n
"},{"location":"api/models/#helldivepy.models.Dispatch.type","title":"helldivepy.models.Dispatch.type  instance-attribute","text":"
type: Literal[0]\n
"},{"location":"api/models/#helldivepy.models.Dispatch.message","title":"helldivepy.models.Dispatch.message  instance-attribute","text":"
message: str\n
"},{"location":"api/models/#helldivepy.models.SteamNews","title":"helldivepy.models.SteamNews","text":"
               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 
"},{"location":"api/models/#helldivepy.models.SteamNews-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.SteamNews.id","title":"helldivepy.models.SteamNews.id  instance-attribute","text":"
id: str\n
"},{"location":"api/models/#helldivepy.models.SteamNews.title","title":"helldivepy.models.SteamNews.title  instance-attribute","text":"
title: str\n
"},{"location":"api/models/#helldivepy.models.SteamNews.url","title":"helldivepy.models.SteamNews.url  instance-attribute","text":"
url: str\n
"},{"location":"api/models/#helldivepy.models.SteamNews.author","title":"helldivepy.models.SteamNews.author  instance-attribute","text":"
author: str\n
"},{"location":"api/models/#helldivepy.models.SteamNews.content","title":"helldivepy.models.SteamNews.content  instance-attribute","text":"
content: str\n
"},{"location":"api/models/#helldivepy.models.SteamNews.published_at","title":"helldivepy.models.SteamNews.published_at  class-attribute instance-attribute","text":"
published_at: datetime = Field(alias='publishedAt')\n
"},{"location":"api/models/#helldivepy.models.PlanetEvent","title":"helldivepy.models.PlanetEvent","text":"
               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] 
"},{"location":"api/models/#helldivepy.models.PlanetEvent-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.PlanetEvent.id","title":"helldivepy.models.PlanetEvent.id  instance-attribute","text":"
id: int\n
"},{"location":"api/models/#helldivepy.models.PlanetEvent.event_type","title":"helldivepy.models.PlanetEvent.event_type  class-attribute instance-attribute","text":"
event_type: int = Field(alias='eventType')\n
"},{"location":"api/models/#helldivepy.models.PlanetEvent.faction","title":"helldivepy.models.PlanetEvent.faction  instance-attribute","text":"
faction: FactionType\n
"},{"location":"api/models/#helldivepy.models.PlanetEvent.health","title":"helldivepy.models.PlanetEvent.health  instance-attribute","text":"
health: int\n
"},{"location":"api/models/#helldivepy.models.PlanetEvent.max_health","title":"helldivepy.models.PlanetEvent.max_health  class-attribute instance-attribute","text":"
max_health: int = Field(alias='maxHealth')\n
"},{"location":"api/models/#helldivepy.models.PlanetEvent.start_time","title":"helldivepy.models.PlanetEvent.start_time  class-attribute instance-attribute","text":"
start_time: datetime = Field(alias='startTime')\n
"},{"location":"api/models/#helldivepy.models.PlanetEvent.end_time","title":"helldivepy.models.PlanetEvent.end_time  class-attribute instance-attribute","text":"
end_time: datetime = Field(alias='endTime')\n
"},{"location":"api/models/#helldivepy.models.PlanetEvent.campaign_id","title":"helldivepy.models.PlanetEvent.campaign_id  class-attribute instance-attribute","text":"
campaign_id: int = Field(alias='campaignId')\n
"},{"location":"api/models/#helldivepy.models.PlanetEvent.joint_operation_ids","title":"helldivepy.models.PlanetEvent.joint_operation_ids  class-attribute instance-attribute","text":"
joint_operation_ids: list[int] = Field(\n    alias=\"jointOperationIds\"\n)\n
"},{"location":"api/models/#helldivepy.models.PlanetEvent.planet","title":"helldivepy.models.PlanetEvent.planet  property","text":"
planet: Planet | None\n
 
Retrieves the planet associated with this event.
 RETURNS DESCRIPTION Planet | None 
Planet | None: Associated planet object if available, None otherwise.
"},{"location":"api/models/#helldivepy.models.Position","title":"helldivepy.models.Position","text":"
               Bases: BaseModel
 
2D coordinate position.
 
Represents a location in 2D space.
 ATTRIBUTE DESCRIPTION x 
Horizontal coordinate.
 
 TYPE: float 
 y 
Vertical coordinate.
 
 TYPE: float 
"},{"location":"api/models/#helldivepy.models.Position-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.Position.x","title":"helldivepy.models.Position.x  instance-attribute","text":"
x: float\n
"},{"location":"api/models/#helldivepy.models.Position.y","title":"helldivepy.models.Position.y  instance-attribute","text":"
y: float\n
"},{"location":"api/models/#helldivepy.models.PlanetaryHazard","title":"helldivepy.models.PlanetaryHazard","text":"
               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 
"},{"location":"api/models/#helldivepy.models.PlanetaryHazard-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.PlanetaryHazard.name","title":"helldivepy.models.PlanetaryHazard.name  instance-attribute","text":"
name: str\n
"},{"location":"api/models/#helldivepy.models.PlanetaryHazard.description","title":"helldivepy.models.PlanetaryHazard.description  instance-attribute","text":"
description: str\n
"},{"location":"api/models/#helldivepy.models.Biome","title":"helldivepy.models.Biome","text":"
               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 
"},{"location":"api/models/#helldivepy.models.Biome-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.Biome.name","title":"helldivepy.models.Biome.name  instance-attribute","text":"
name: str\n
"},{"location":"api/models/#helldivepy.models.Biome.description","title":"helldivepy.models.Biome.description  instance-attribute","text":"
description: str\n
"},{"location":"api/models/#helldivepy.models.Planet","title":"helldivepy.models.Planet","text":"
               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] 
"},{"location":"api/models/#helldivepy.models.Planet-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.Planet.index","title":"helldivepy.models.Planet.index  instance-attribute","text":"
index: int\n
"},{"location":"api/models/#helldivepy.models.Planet.name","title":"helldivepy.models.Planet.name  instance-attribute","text":"
name: str\n
"},{"location":"api/models/#helldivepy.models.Planet.sector","title":"helldivepy.models.Planet.sector  instance-attribute","text":"
sector: str\n
"},{"location":"api/models/#helldivepy.models.Planet.biome","title":"helldivepy.models.Planet.biome  instance-attribute","text":"
biome: Biome\n
"},{"location":"api/models/#helldivepy.models.Planet.hazards","title":"helldivepy.models.Planet.hazards  instance-attribute","text":"
hazards: list[PlanetaryHazard]\n
"},{"location":"api/models/#helldivepy.models.Planet.hash","title":"helldivepy.models.Planet.hash  instance-attribute","text":"
hash: int\n
"},{"location":"api/models/#helldivepy.models.Planet.position","title":"helldivepy.models.Planet.position  instance-attribute","text":"
position: Position\n
"},{"location":"api/models/#helldivepy.models.Planet.waypoints","title":"helldivepy.models.Planet.waypoints  instance-attribute","text":"
waypoints: list[int]\n
"},{"location":"api/models/#helldivepy.models.Planet.max_health","title":"helldivepy.models.Planet.max_health  class-attribute instance-attribute","text":"
max_health: int = Field(alias='maxHealth')\n
"},{"location":"api/models/#helldivepy.models.Planet.health","title":"helldivepy.models.Planet.health  instance-attribute","text":"
health: int\n
"},{"location":"api/models/#helldivepy.models.Planet.disabled","title":"helldivepy.models.Planet.disabled  instance-attribute","text":"
disabled: bool\n
"},{"location":"api/models/#helldivepy.models.Planet.initial_owner","title":"helldivepy.models.Planet.initial_owner  class-attribute instance-attribute","text":"
initial_owner: FactionType = Field(alias='initialOwner')\n
"},{"location":"api/models/#helldivepy.models.Planet.current_owner","title":"helldivepy.models.Planet.current_owner  class-attribute instance-attribute","text":"
current_owner: FactionType = Field(alias='currentOwner')\n
"},{"location":"api/models/#helldivepy.models.Planet.regen_per_second","title":"helldivepy.models.Planet.regen_per_second  class-attribute instance-attribute","text":"
regen_per_second: float = Field(alias='regenPerSecond')\n
"},{"location":"api/models/#helldivepy.models.Planet.event","title":"helldivepy.models.Planet.event  instance-attribute","text":"
event: PlanetEvent | None\n
"},{"location":"api/models/#helldivepy.models.Planet.statistics","title":"helldivepy.models.Planet.statistics  instance-attribute","text":"
statistics: Statistics\n
"},{"location":"api/models/#helldivepy.models.Planet.attacking","title":"helldivepy.models.Planet.attacking  instance-attribute","text":"
attacking: list[int]\n
"},{"location":"api/models/#helldivepy.models.Planet.has_space_station","title":"helldivepy.models.Planet.has_space_station  property","text":"
has_space_station: bool\n
 
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.
"},{"location":"api/models/#helldivepy.models.AssignmentTaskData","title":"helldivepy.models.AssignmentTaskData","text":"
               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 
"},{"location":"api/models/#helldivepy.models.AssignmentTaskData-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.AssignmentTaskData.liberate","title":"helldivepy.models.AssignmentTaskData.liberate  instance-attribute","text":"
liberate: bool | None\n
"},{"location":"api/models/#helldivepy.models.AssignmentTaskData.planet","title":"helldivepy.models.AssignmentTaskData.planet  instance-attribute","text":"
planet: Planet | None\n
"},{"location":"api/models/#helldivepy.models.AssignmentTaskData.target_count","title":"helldivepy.models.AssignmentTaskData.target_count  instance-attribute","text":"
target_count: int | None\n
"},{"location":"api/models/#helldivepy.models.AssignmentTaskData.race","title":"helldivepy.models.AssignmentTaskData.race  instance-attribute","text":"
race: FactionType | None\n
"},{"location":"api/models/#helldivepy.models.AssignmentTask","title":"helldivepy.models.AssignmentTask","text":"
               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 
"},{"location":"api/models/#helldivepy.models.AssignmentTask-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.AssignmentTask.type","title":"helldivepy.models.AssignmentTask.type  instance-attribute","text":"
type: AssignmentTypes\n
"},{"location":"api/models/#helldivepy.models.AssignmentTask.values","title":"helldivepy.models.AssignmentTask.values  instance-attribute","text":"
values: list[int]\n
"},{"location":"api/models/#helldivepy.models.AssignmentTask.value_types","title":"helldivepy.models.AssignmentTask.value_types  class-attribute instance-attribute","text":"
value_types: list[ValueTypes] = Field(alias='valueTypes')\n
"},{"location":"api/models/#helldivepy.models.AssignmentTask.data","title":"helldivepy.models.AssignmentTask.data  class-attribute instance-attribute","text":"
data: AssignmentTaskData = AssignmentTaskData(\n    liberate=None, planet=None, target_count=None, race=None\n)\n
"},{"location":"api/models/#helldivepy.models.AssignmentTask-functions","title":"Functions","text":""},{"location":"api/models/#helldivepy.models.AssignmentTask.model_post_init","title":"helldivepy.models.AssignmentTask.model_post_init","text":"
model_post_init(__context: typing.Any) -> None\n
 
Initializes task data after model creation.
 PARAMETER DESCRIPTION __context 
Initialization context data.
 
 TYPE: Any 
 RAISES DESCRIPTION ValueError 
If ApiClient is not properly initialized.
"},{"location":"api/models/#helldivepy.models.AssignmentReward","title":"helldivepy.models.AssignmentReward","text":"
               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 
"},{"location":"api/models/#helldivepy.models.AssignmentReward-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.AssignmentReward.type","title":"helldivepy.models.AssignmentReward.type  instance-attribute","text":"
type: int\n
"},{"location":"api/models/#helldivepy.models.AssignmentReward.amount","title":"helldivepy.models.AssignmentReward.amount  instance-attribute","text":"
amount: int\n
"},{"location":"api/models/#helldivepy.models.Assignment","title":"helldivepy.models.Assignment","text":"
               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 
"},{"location":"api/models/#helldivepy.models.Assignment-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.Assignment.id","title":"helldivepy.models.Assignment.id  instance-attribute","text":"
id: int\n
"},{"location":"api/models/#helldivepy.models.Assignment.progress","title":"helldivepy.models.Assignment.progress  instance-attribute","text":"
progress: list[int]\n
"},{"location":"api/models/#helldivepy.models.Assignment.title","title":"helldivepy.models.Assignment.title  class-attribute instance-attribute","text":"
title: str | None = None\n
"},{"location":"api/models/#helldivepy.models.Assignment.briefing","title":"helldivepy.models.Assignment.briefing  class-attribute instance-attribute","text":"
briefing: str | None = None\n
"},{"location":"api/models/#helldivepy.models.Assignment.description","title":"helldivepy.models.Assignment.description  class-attribute instance-attribute","text":"
description: str | None = None\n
"},{"location":"api/models/#helldivepy.models.Assignment.tasks","title":"helldivepy.models.Assignment.tasks  instance-attribute","text":"
tasks: list[AssignmentTask]\n
"},{"location":"api/models/#helldivepy.models.Assignment.reward","title":"helldivepy.models.Assignment.reward  instance-attribute","text":"
reward: AssignmentReward\n
"},{"location":"api/models/#helldivepy.models.Assignment.expiration","title":"helldivepy.models.Assignment.expiration  instance-attribute","text":"
expiration: datetime\n
"},{"location":"api/models/#helldivepy.models.Assignment.is_complete","title":"helldivepy.models.Assignment.is_complete  property","text":"
is_complete: bool\n
 
Checks if all assignment tasks are complete.
 RETURNS DESCRIPTION bool 
True if all tasks meet their target count, False otherwise.
 
 TYPE: bool 
"},{"location":"api/models/#helldivepy.models.Campaign","title":"helldivepy.models.Campaign","text":"
               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 
"},{"location":"api/models/#helldivepy.models.Campaign-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.Campaign.id","title":"helldivepy.models.Campaign.id  instance-attribute","text":"
id: int\n
"},{"location":"api/models/#helldivepy.models.Campaign.planet","title":"helldivepy.models.Campaign.planet  instance-attribute","text":"
planet: Planet\n
"},{"location":"api/models/#helldivepy.models.Campaign.type","title":"helldivepy.models.Campaign.type  instance-attribute","text":"
type: CampaignTypes\n
"},{"location":"api/models/#helldivepy.models.Campaign.count","title":"helldivepy.models.Campaign.count  instance-attribute","text":"
count: int\n
"},{"location":"api/models/#helldivepy.models.SpaceStation","title":"helldivepy.models.SpaceStation","text":"
               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 
"},{"location":"api/models/#helldivepy.models.SpaceStation-attributes","title":"Attributes","text":""},{"location":"api/models/#helldivepy.models.SpaceStation.id","title":"helldivepy.models.SpaceStation.id  class-attribute instance-attribute","text":"
id: int = Field(alias='id32')\n
"},{"location":"api/models/#helldivepy.models.SpaceStation.planet","title":"helldivepy.models.SpaceStation.planet  instance-attribute","text":"
planet: Planet\n
"},{"location":"api/models/#helldivepy.models.SpaceStation.election_end","title":"helldivepy.models.SpaceStation.election_end  class-attribute instance-attribute","text":"
election_end: datetime = Field(alias='electionEnd')\n
"},{"location":"api/models/#helldivepy.models.SpaceStation.flags","title":"helldivepy.models.SpaceStation.flags  instance-attribute","text":"
flags: int\n
"},{"location":"api/routes/","title":"Routes","text":""},{"location":"api/routes/#helldivepy.api","title":"helldivepy.api","text":""},{"location":"api/routes/#helldivepy.api-attributes","title":"Attributes","text":""},{"location":"api/routes/#helldivepy.api.__all__","title":"helldivepy.api.__all__  module-attribute","text":"
__all__ = [\n    \"DispatchModule\",\n    \"WarModule\",\n    \"SteamModule\",\n    \"AssignmentsModule\",\n    \"PlanetsModule\",\n    \"CampaignModule\",\n    \"SpaceStationModule\",\n]\n
"},{"location":"api/routes/#helldivepy.api-classes","title":"Classes","text":""},{"location":"api/routes/#helldivepy.api.DispatchModule","title":"helldivepy.api.DispatchModule","text":"
DispatchModule(api_client: ApiClient)\n
 
               Bases: BaseApiModule
 
The Dispatch API module. This module is used to interact with all dispatches (Ingame News)
 METHOD DESCRIPTION get_dispatches 
bool): Gets all dispatches and orders them based on the old_to_new argument.
 get_dispatch 
int): Gets a dispatch by its ID.
"},{"location":"api/routes/#helldivepy.api.DispatchModule-functions","title":"Functions","text":""},{"location":"api/routes/#helldivepy.api.DispatchModule.get_dispatches","title":"helldivepy.api.DispatchModule.get_dispatches","text":"
get_dispatches(\n    old_to_new: bool = True,\n) -> typing.List[models.Dispatch]\n
 
Gets the information about the current war.
"},{"location":"api/routes/#helldivepy.api.DispatchModule.get_dispatch","title":"helldivepy.api.DispatchModule.get_dispatch","text":"
get_dispatch(dispatch_id: int) -> models.Dispatch\n
 
Gets the information about the current war.
"},{"location":"api/routes/#helldivepy.api.WarModule","title":"helldivepy.api.WarModule","text":"
WarModule(api_client: ApiClient)\n
 
               Bases: BaseApiModule
 
The War module of the API. This module is used to get all info about the current war.
 METHOD DESCRIPTION get_war_info 
Gets the information about the current war.
"},{"location":"api/routes/#helldivepy.api.WarModule-functions","title":"Functions","text":""},{"location":"api/routes/#helldivepy.api.WarModule.get_war_info","title":"helldivepy.api.WarModule.get_war_info","text":"
get_war_info() -> models.WarInfo\n
 
Gets the information about the current war.
"},{"location":"api/routes/#helldivepy.api.SteamModule","title":"helldivepy.api.SteamModule","text":"
SteamModule(api_client: ApiClient)\n
 
               Bases: BaseApiModule
 
The Steam API module. Used to get all the Game updates and News.
 METHOD DESCRIPTION get_all_steam_news 
Gets all the steam news.
 get_steam_news 
str): Gets a steam news item by its ID.
"},{"location":"api/routes/#helldivepy.api.SteamModule-functions","title":"Functions","text":""},{"location":"api/routes/#helldivepy.api.SteamModule.get_all_steam_news","title":"helldivepy.api.SteamModule.get_all_steam_news","text":"
get_all_steam_news() -> typing.List[models.SteamNews]\n
 
Gets the information about the current war.
"},{"location":"api/routes/#helldivepy.api.SteamModule.get_steam_news","title":"helldivepy.api.SteamModule.get_steam_news","text":"
get_steam_news(gid: str) -> models.SteamNews\n
 
Gets the information about the current war.
"},{"location":"api/routes/#helldivepy.api.AssignmentsModule","title":"helldivepy.api.AssignmentsModule","text":"
AssignmentsModule(api_client: ApiClient)\n
 
               Bases: BaseApiModule
 
The Assignments API module (Major Order). This module is used to interact with the current major order(s).
 METHOD DESCRIPTION get_all_assignments 
Gets all current assignments
 get_assignment 
int): Gets one assignment using the assignment ID
"},{"location":"api/routes/#helldivepy.api.AssignmentsModule-functions","title":"Functions","text":""},{"location":"api/routes/#helldivepy.api.AssignmentsModule.get_all_assignments","title":"helldivepy.api.AssignmentsModule.get_all_assignments","text":"
get_all_assignments() -> typing.List[models.Assignment]\n
 
Gets all current assignments
"},{"location":"api/routes/#helldivepy.api.AssignmentsModule.get_assignment","title":"helldivepy.api.AssignmentsModule.get_assignment","text":"
get_assignment(assignment_id: int) -> models.Assignment\n
 
Gets one assignment using the assignment ID
"},{"location":"api/routes/#helldivepy.api.PlanetsModule","title":"helldivepy.api.PlanetsModule","text":"
PlanetsModule(api_client: ApiClient)\n
 
               Bases: BaseApiModule
 
The Planets API module. This module is used to interact with the planets.
 METHOD DESCRIPTION get_planets 
Gets all planets.
 get_planet 
int): Gets a planet using the index.
 get_planets_with_events 
Gets all planets with events.
"},{"location":"api/routes/#helldivepy.api.PlanetsModule-functions","title":"Functions","text":""},{"location":"api/routes/#helldivepy.api.PlanetsModule.get_planets","title":"helldivepy.api.PlanetsModule.get_planets","text":"
get_planets() -> typing.List[models.Planet]\n
 
Get all planets
 RETURNS DESCRIPTION List[Planet] 
typing.List[models.Planet]: The list of planet objects
"},{"location":"api/routes/#helldivepy.api.PlanetsModule.get_planet","title":"helldivepy.api.PlanetsModule.get_planet","text":"
get_planet(\n    index: int, cached: bool = False\n) -> models.Planet\n
 
Gets a planet using the index
 PARAMETER DESCRIPTION index 
The index of the planet
 
 TYPE: int 
 RETURNS DESCRIPTION Planet 
models.Planet: The planet object
"},{"location":"api/routes/#helldivepy.api.PlanetsModule.get_planets_with_events","title":"helldivepy.api.PlanetsModule.get_planets_with_events","text":"
get_planets_with_events() -> typing.List[models.Planet]\n
 
Gets all planets with an active event
 RETURNS DESCRIPTION List[Planet] 
typing.List[models.Planet]: The list of planet objects
"},{"location":"api/routes/#helldivepy.api.CampaignModule","title":"helldivepy.api.CampaignModule","text":"
CampaignModule(api_client: ApiClient)\n
 
               Bases: BaseApiModule
 
The Campaign API module. This module is used to interact with all campaigns (Battles/Planets that are accessible).
 METHOD DESCRIPTION get_campaigns 
Gets all current active campaigns.
 get_campaign 
int): Gets a campaign by its ID.
"},{"location":"api/routes/#helldivepy.api.CampaignModule-functions","title":"Functions","text":""},{"location":"api/routes/#helldivepy.api.CampaignModule.get_campaigns","title":"helldivepy.api.CampaignModule.get_campaigns","text":"
get_campaigns() -> typing.List[models.Campaign]\n
 
Gets all current active campaigns.
 RETURNS DESCRIPTION List[Campaign] 
typing.List[models.Campaign]: The campaigns.
"},{"location":"api/routes/#helldivepy.api.CampaignModule.get_campaign","title":"helldivepy.api.CampaignModule.get_campaign","text":"
get_campaign(campaign_id: int) -> models.Campaign\n
 
Gets a campaign by its ID.
 PARAMETER DESCRIPTION campaign_id 
The ID of the campaign.
 
 TYPE: int 
 RETURNS DESCRIPTION Campaign 
models.Campaign: The campaign.
"},{"location":"api/routes/#helldivepy.api.SpaceStationModule","title":"helldivepy.api.SpaceStationModule","text":"
SpaceStationModule(api_client: ApiClient)\n
 
               Bases: BaseApiModule
"},{"location":"api/routes/#helldivepy.api.SpaceStationModule-functions","title":"Functions","text":""},{"location":"api/routes/#helldivepy.api.SpaceStationModule.get_space_stations","title":"helldivepy.api.SpaceStationModule.get_space_stations","text":"
get_space_stations() -> list[models.SpaceStation]\n
 
Retrieves all space stations.
 RETURNS DESCRIPTION list[SpaceStation] 
list[SpaceStation]: A list of space station objects from the server.
"},{"location":"api/routes/#helldivepy.api.SpaceStationModule.get_space_station","title":"helldivepy.api.SpaceStationModule.get_space_station","text":"
get_space_station(\n    index: int,\n) -> Optional[models.SpaceStation]\n
 
Retrieves a space station by its ID.
 PARAMETER DESCRIPTION index 
The ID of the space station.
 
 TYPE: int 
 RETURNS DESCRIPTION Optional[SpaceStation] 
Optional[SpaceStation]: The space station object if found, or None.
"},{"location":"api/utils/","title":"Utils","text":""},{"location":"api/utils/#helldivepy.utils","title":"helldivepy.utils","text":""},{"location":"api/utils/#helldivepy.utils-attributes","title":"Attributes","text":""},{"location":"api/utils/#helldivepy.utils.FACTIONS","title":"helldivepy.utils.FACTIONS  module-attribute","text":"
FACTIONS = {\n    1: \"Humans\",\n    2: \"Terminids\",\n    3: \"Automaton\",\n    4: \"Illuminate\",\n}\n
"},{"location":"api/utils/#helldivepy.utils-classes","title":"Classes","text":""},{"location":"api/utils/#helldivepy.utils.DiveHarderException","title":"helldivepy.utils.DiveHarderException","text":"
               Bases: Exception
 
Base exception for all DiveHarder exceptions.
"},{"location":"api/utils/#helldivepy.utils.DiveHarderAPIConnectionError","title":"helldivepy.utils.DiveHarderAPIConnectionError","text":"
               Bases: DiveHarderException
 
Exception raised when the DiveHarder API connection fails.
"},{"location":"api/utils/#helldivepy.utils-functions","title":"Functions","text":""},{"location":"api/utils/#helldivepy.utils.hdml_to_md","title":"helldivepy.utils.hdml_to_md","text":"
hdml_to_md(text: str) -> str\n
 
Converts a string in HDML (DiveHarder Markup Language) format to Markdown format.
 PARAMETER DESCRIPTION text 
The input string in HDML format.
 
 TYPE: str 
 RETURNS DESCRIPTION str 
The input string converted to Markdown format.
 
 TYPE: str 
"},{"location":"api/utils/#helldivepy.utils.url_join","title":"helldivepy.utils.url_join","text":"
url_join(*args)\n
 
Join combine URL parts to get the full endpoint address.
"},{"location":"api/utils/#helldivepy.utils.parse_faction","title":"helldivepy.utils.parse_faction","text":"
parse_faction(faction: int) -> enums.FactionType | None\n
 
Parse faction ID to string
 PARAMETER DESCRIPTION faction 
The faction ID
 
 TYPE: int 
 RETURNS DESCRIPTION str 
The faction name
 
 TYPE: FactionType | None 
"}]}
\ No newline at end of file
diff --git a/sitemap.xml b/sitemap.xml
old mode 100644
new mode 100755
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
old mode 100644
new mode 100755