Modules¶

Each module is accessed as an attribute on HelldiveAPIClient and handles one API resource group. All modules share the same pattern: get_all() returns a list, get(index) returns a single item or None on 404, and non-404 HTTP errors are re-raised.

helldivepy.modules.war.WarModule ¶

WarModule(client: HelldiveAPIClient)

Bases: BaseModule

Access the global war state.

Functions¶

get ¶

get() -> War

Fetch the current war status snapshot.

Returns:

Type	Description
`War`	The current War state including statistics and active factions.

helldivepy.modules.dispatches.DispatchesModule ¶

DispatchesModule(client: HelldiveAPIClient)

Bases: BaseModule

Access in-game dispatches (high-command broadcasts).

Functions¶

get_all ¶

get_all() -> list[Dispatch]

Fetch all available dispatches.

Returns:

Type	Description
`list[Dispatch]`	A list of all dispatches, most recent first.

get ¶

get(index: int) -> Dispatch | None

Fetch a specific dispatch by ID.

Parameters:

Name	Type	Description	Default
`index`	`int`	The dispatch ID.	required

Returns:

Type	Description
`Dispatch \| None`	The matching Dispatch, or None if not found.

helldivepy.modules.planets.PlanetModule ¶

PlanetModule(client: HelldiveAPIClient)

Bases: BaseModule

Access planet data and active planetary events.

Functions¶

get_all ¶

get_all() -> list[Planet]

Fetch all planets.

Returns:

Type	Description
`list[Planet]`	A list of all planets in the galaxy.

get ¶

get(index: int) -> Planet | None

Fetch a specific planet by index.

Parameters:

Name	Type	Description	Default
`index`	`int`	The planet's ArrowHead index.	required

Returns:

Type	Description
`Planet \| None`	The matching Planet, or None if not found.

get_events ¶

get_events() -> list[Event]

Fetch all planets with an active event (e.g. defense campaigns).

Returns:

Type	Description
`list[Event]`	A list of active Events across all planets.

helldivepy.modules.campaigns.CampaignModule ¶

CampaignModule(client: HelldiveAPIClient)

Bases: BaseModule

Access active planetary campaigns.

Functions¶

get_all ¶

get_all() -> list[Campaign]

Fetch all active campaigns.

Returns:

Type	Description
`list[Campaign]`	A list of all ongoing campaigns.

get ¶

get(index: int) -> Campaign | None

Fetch a specific campaign by ID.

Parameters:

Name	Type	Description	Default
`index`	`int`	The campaign ID.	required

Returns:

Type	Description
`Campaign \| None`	The matching Campaign, or None if not found.

helldivepy.modules.assignments.AssignmentsModule ¶

AssignmentsModule(client: HelldiveAPIClient)

Bases: BaseModule

Access Major Orders (assignments) issued by high command.

Functions¶

get_all ¶

get_all() -> list[Assignment]

Fetch all active assignments.

Returns:

Type	Description
`list[Assignment]`	A list of all currently active Major Orders.

get ¶

get(index: int) -> Assignment | None

Fetch a specific assignment by ID.

Parameters:

Name	Type	Description	Default
`index`	`int`	The assignment ID.	required

Returns:

Type	Description
`Assignment \| None`	The matching Assignment, or None if not found.

helldivepy.modules.space_stations.SpaceStationsModule ¶

SpaceStationsModule(client: HelldiveAPIClient)

Bases: BaseModule

Access the Democracy Space Station (DSS) and its tactical actions.

Functions¶

get_all ¶

get_all() -> list[SpaceStation]

Fetch all space stations.

Returns:

Type	Description
`list[SpaceStation]`	A list of all space stations and their current state.

get ¶

get(index: int) -> SpaceStation | None

Fetch a specific space station by ID.

Parameters:

Name	Type	Description	Default
`index`	`int`	The station's 32-bit ArrowHead ID.	required

Returns:

Type	Description
`SpaceStation \| None`	The matching SpaceStation, or None if not found.

helldivepy.modules.steam.SteamModule ¶

SteamModule(client: HelldiveAPIClient)

Bases: BaseModule

Access the Helldivers 2 Steam news feed.

Functions¶

get_all ¶

get_all() -> list[SteamNews]

Fetch all Steam news articles for Helldivers 2.

Returns:

Type	Description
`list[SteamNews]`	A list of Steam news articles, most recent first.

get ¶

get(gid: str) -> SteamNews | None

Fetch a specific Steam news article by its global ID.

Parameters:

Name	Type	Description	Default
`gid`	`str`	The Steam article global ID.	required

Returns:

Type	Description
`SteamNews \| None`	The matching SteamNews article, or None if not found.