Routes

helldivepy.api

Attributes

helldivepy.api.__all__ module-attribute

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

Classes

helldivepy.api.DispatchModule

DispatchModule(api_client: ApiClient)

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.

Functions

helldivepy.api.DispatchModule.get_dispatches

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

Gets the information about the current war.

helldivepy.api.DispatchModule.get_dispatch

get_dispatch(dispatch_id: int) -> models.Dispatch

Gets the information about the current war.

helldivepy.api.WarModule

WarModule(api_client: ApiClient)

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.

Functions

helldivepy.api.WarModule.get_war_info

get_war_info() -> models.WarInfo

Gets the information about the current war.

helldivepy.api.SteamModule

SteamModule(api_client: ApiClient)

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.

Functions

helldivepy.api.SteamModule.get_all_steam_news

get_all_steam_news() -> typing.List[models.SteamNews]

Gets the information about the current war.

helldivepy.api.SteamModule.get_steam_news

get_steam_news(gid: str) -> models.SteamNews

Gets the information about the current war.

helldivepy.api.AssignmentsModule

AssignmentsModule(api_client: ApiClient)

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

Functions

helldivepy.api.AssignmentsModule.get_all_assignments

get_all_assignments() -> typing.List[models.Assignment]

Gets all current assignments

helldivepy.api.AssignmentsModule.get_assignment

get_assignment(assignment_id: int) -> models.Assignment

Gets one assignment using the assignment ID

helldivepy.api.PlanetsModule

PlanetsModule(api_client: ApiClient)

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.

Functions

helldivepy.api.PlanetsModule.get_planets

get_planets() -> typing.List[models.Planet]

Get all planets

RETURNS	DESCRIPTION
List[Planet]	typing.List[models.Planet]: The list of planet objects

helldivepy.api.PlanetsModule.get_planet

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

Gets a planet using the index

PARAMETER	DESCRIPTION
index	The index of the planet TYPE: int

RETURNS	DESCRIPTION
Planet	models.Planet: The planet object

helldivepy.api.PlanetsModule.get_planets_with_events

get_planets_with_events() -> typing.List[models.Planet]

Gets all planets with an active event

RETURNS	DESCRIPTION
List[Planet]	typing.List[models.Planet]: The list of planet objects

helldivepy.api.CampaignModule

CampaignModule(api_client: ApiClient)

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.

Functions

helldivepy.api.CampaignModule.get_campaigns

get_campaigns() -> typing.List[models.Campaign]

Gets all current active campaigns.

RETURNS	DESCRIPTION
List[Campaign]	typing.List[models.Campaign]: The campaigns.

helldivepy.api.CampaignModule.get_campaign

get_campaign(campaign_id: int) -> models.Campaign

Gets a campaign by its ID.

PARAMETER	DESCRIPTION
campaign_id	The ID of the campaign. TYPE: int

RETURNS	DESCRIPTION
Campaign	models.Campaign: The campaign.

helldivepy.api.SpaceStationModule

SpaceStationModule(api_client: ApiClient)

Bases: BaseApiModule

Functions

helldivepy.api.SpaceStationModule.get_space_stations

get_space_stations() -> list[models.SpaceStation]

Retrieves all space stations.

RETURNS	DESCRIPTION
list[SpaceStation]	list[SpaceStation]: A list of space station objects from the server.

helldivepy.api.SpaceStationModule.get_space_station

get_space_station(index: int) -> Optional[models.SpaceStation]

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.