API Reference

helldivepy

Attributes

helldivepy.__all__ module-attribute

__all__ = ['ApiClient']

Classes

helldivepy.ApiClient

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

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

Attributes

helldivepy.ApiClient.debug instance-attribute

debug = debug

helldivepy.ApiClient.logger instance-attribute

logger = set_logger(debug)

helldivepy.ApiClient.api_config instance-attribute

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

helldivepy.ApiClient.war property

war: WarModule

helldivepy.ApiClient.dispatch property

dispatch: DispatchModule

helldivepy.ApiClient.steam property

steam: SteamModule

helldivepy.ApiClient.assignments property

assignments: AssignmentsModule

helldivepy.ApiClient.major_orders property

major_orders: AssignmentsModule

helldivepy.ApiClient.planets property

planets: PlanetsModule

helldivepy.ApiClient.campaigns property

campaigns: CampaignModule

helldivepy.ApiClient.space_stations property

space_stations: SpaceStationModule

Functions

helldivepy.ApiClient.get_client classmethod

get_client()

helldivepy.ApiClient.get_war_info

get_war_info() -> models.WarInfo