hd2api package¶
Subpackages¶
- hd2api.builders package
- Submodules
- hd2api.builders.assignment_builder module
- hd2api.builders.campaign_builder module
- hd2api.builders.effect_builder module
- hd2api.builders.planet_builder module
- hd2api.builders.region_builder module
- hd2api.builders.sector_state_builder module
- hd2api.builders.statistics_builder module
- hd2api.builders.war_builder module
- Module contents
- hd2api.constants package
- hd2api.models package
- Subpackages
- hd2api.models.ABC package
- hd2api.models.Base package
- Submodules
- hd2api.models.Base.Assignment module
- hd2api.models.Base.Campaign module
- hd2api.models.Base.Effects module
- hd2api.models.Base.GalaxyStats module
- hd2api.models.Base.GlobalEvent module
- hd2api.models.Base.HomeWorld module
- hd2api.models.Base.JointOperation module
- hd2api.models.Base.NewsFeedItem module
- hd2api.models.Base.PlanetAttack module
- hd2api.models.Base.PlanetCoordinates module
- hd2api.models.Base.PlanetEvent module
- hd2api.models.Base.PlanetInfo module
- hd2api.models.Base.PlanetStats module
- hd2api.models.Base.PlanetStatus module
- hd2api.models.Base.Reward module
- hd2api.models.Base.Setting module
- hd2api.models.Base.SteamNewsRaw module
- hd2api.models.Base.Task module
- hd2api.models.Base.WarId module
- hd2api.models.Base.WarInfo module
- hd2api.models.Base.WarStatus module
- hd2api.models.Base.WarSummary module
- Module contents
- Submodules
- hd2api.models.Assignment2 module
- hd2api.models.Biome module
- hd2api.models.Campaign2 module
- hd2api.models.Dispatch module
- hd2api.models.DiveharderAll module
- hd2api.models.Effects module
- hd2api.models.Event module
EventEvent.average()Event.calculate_change()Event.calculate_timeval()Event.campaignIdEvent.endTimeEvent.estimate_remaining_lib_time()Event.eventTypeEvent.factionEvent.format_estimated_time_string()Event.get_name()Event.healthEvent.idEvent.jointOperationIdsEvent.long_event_details()Event.maxHealthEvent.model_configEvent.potentialBuildUpEvent.startTime
- hd2api.models.GalaxyStatic module
- hd2api.models.Hazard module
- hd2api.models.Planet module
PlanetPlanet.activePlanetEffectsPlanet.attackingPlanet.average()Planet.biomePlanet.calculate_change()Planet.calculate_timedelta_to_liberate()Planet.calculate_timeval()Planet.campaign_against()Planet.currentOwnerPlanet.disabledPlanet.estimate_remaining_lib_time()Planet.eventPlanet.format_estimated_time_string()Planet.get_name()Planet.hashPlanet.hazardsPlanet.healthPlanet.indexPlanet.initialOwnerPlanet.maxHealthPlanet.model_configPlanet.namePlanet.positionPlanet.regenPerSecondPlanet.regionsPlanet.sectorPlanet.sector_idPlanet.simple_planet_view()Planet.statisticsPlanet.waypoints
- hd2api.models.Position module
- hd2api.models.Reward2 module
- hd2api.models.SectorState module
- hd2api.models.Statistics module
StatisticsStatistics.accuracyStatistics.automatonKillsStatistics.average()Statistics.bulletsFiredStatistics.bulletsHitStatistics.deathsStatistics.diff_format()Statistics.format_statistics()Statistics.friendliesStatistics.illuminateKillsStatistics.missionSuccessRateStatistics.missionTimeStatistics.missionsLostStatistics.missionsWonStatistics.model_configStatistics.playerCountStatistics.revivesStatistics.terminidKillsStatistics.timePlayed
- hd2api.models.SteamNews module
- hd2api.models.Task2 module
- hd2api.models.War module
- Module contents
AssignmentAssignment2BiomeCampaignCampaign2CostDispatchDiveharderAllEffectStaticEventEvent.average()Event.calculate_change()Event.calculate_timeval()Event.campaignIdEvent.endTimeEvent.estimate_remaining_lib_time()Event.eventTypeEvent.factionEvent.format_estimated_time_string()Event.get_name()Event.healthEvent.idEvent.jointOperationIdsEvent.long_event_details()Event.maxHealthEvent.model_configEvent.potentialBuildUpEvent.startTime
GalaxyStaticGalaxyStatsGalaxyStats.accurracyGalaxyStats.automatonKillsGalaxyStats.bugKillsGalaxyStats.bulletsFiredGalaxyStats.bulletsHitGalaxyStats.deathsGalaxyStats.friendliesGalaxyStats.illuminateKillsGalaxyStats.missionSuccessRateGalaxyStats.missionTimeGalaxyStats.missionsLostGalaxyStats.missionsWonGalaxyStats.model_configGalaxyStats.revivesGalaxyStats.timePlayed
GlobalEventGlobalEvent.assignmentId32GlobalEvent.effectIdsGlobalEvent.eventIdGlobalEvent.expireTimeGlobalEvent.flagGlobalEvent.id32GlobalEvent.introMediaId32GlobalEvent.messageGlobalEvent.messageId32GlobalEvent.model_configGlobalEvent.outroMediaId32GlobalEvent.planetIndicesGlobalEvent.portraitId32GlobalEvent.raceGlobalEvent.strout()GlobalEvent.titleGlobalEvent.titleId32
GlobalResourceHazardHomeWorldJointOperationKnownPlanetEffectNewsFeedItemPlanetPlanet.activePlanetEffectsPlanet.attackingPlanet.average()Planet.biomePlanet.calculate_change()Planet.calculate_timedelta_to_liberate()Planet.calculate_timeval()Planet.campaign_against()Planet.currentOwnerPlanet.disabledPlanet.estimate_remaining_lib_time()Planet.eventPlanet.format_estimated_time_string()Planet.get_name()Planet.hashPlanet.hazardsPlanet.healthPlanet.indexPlanet.initialOwnerPlanet.maxHealthPlanet.model_configPlanet.namePlanet.positionPlanet.regenPerSecondPlanet.regionsPlanet.sectorPlanet.sector_idPlanet.simple_planet_view()Planet.statisticsPlanet.waypoints
PlanetActiveEffectsPlanetAttackPlanetCoordinatesPlanetEventPlanetEvent.campaignIdPlanetEvent.eventTypePlanetEvent.expireTimePlanetEvent.healthPlanetEvent.idPlanetEvent.jointOperationIdsPlanetEvent.long_event_details()PlanetEvent.maxHealthPlanetEvent.model_configPlanetEvent.planetIndexPlanetEvent.potentialBuildUpPlanetEvent.racePlanetEvent.startTime
PlanetInfoPlanetRegionStaticPlanetStaticPlanetStatsPlanetStats.accurracyPlanetStats.automatonKillsPlanetStats.bugKillsPlanetStats.bulletsFiredPlanetStats.bulletsHitPlanetStats.deathsPlanetStats.friendliesPlanetStats.illuminateKillsPlanetStats.missionSuccessRatePlanetStats.missionTimePlanetStats.missionsLostPlanetStats.missionsWonPlanetStats.model_configPlanetStats.planetIndexPlanetStats.revivesPlanetStats.timePlayed
PlanetStatusPositionRegionRegion.availabilityFactorRegion.average()Region.calculate_change()Region.calculate_lib_seconds()Region.calculate_timedelta_to_liberate()Region.calculate_timeval()Region.damageMultiplierRegion.descriptionRegion.estimate_remaining_lib_time()Region.flagsRegion.format_estimated_time_string()Region.hashRegion.healthRegion.idRegion.inline_view()Region.isAvailableRegion.keyComboRegion.maxHealthRegion.model_configRegion.nameRegion.ownerRegion.planetIndexRegion.planetNameRegion.playersRegion.regenPerSecondRegion.regionIndexRegion.regionSizeRegion.region_factionRegion.region_linksRegion.region_typeRegion.settingsHashRegion.simple_region_view()Region.size
RewardReward2SectorStatesSettingSpaceStationSpaceStation2SpaceStationStatusStaticAllStatisticsStatistics.accuracyStatistics.automatonKillsStatistics.average()Statistics.bulletsFiredStatistics.bulletsHitStatistics.deathsStatistics.diff_format()Statistics.format_statistics()Statistics.friendliesStatistics.illuminateKillsStatistics.missionSuccessRateStatistics.missionTimeStatistics.missionsLostStatistics.missionsWonStatistics.model_configStatistics.playerCountStatistics.revivesStatistics.terminidKillsStatistics.timePlayed
SteamNewsSteamNewsRawTacticalActionTaskTask2TaskDataWarWarIdWarInfoWarStatusWarStatus.activeElectionPolicyEffectsWarStatus.campaignsWarStatus.communityTargetsWarStatus.globalEventsWarStatus.globalResourcesWarStatus.impactMultiplierWarStatus.jointOperationsWarStatus.layoutVersionWarStatus.model_configWarStatus.planetActiveEffectsWarStatus.planetAttacksWarStatus.planetEventsWarStatus.planetRegionsWarStatus.planetStatusWarStatus.spaceStationsWarStatus.storyBeatId32WarStatus.superEarthWarResultsWarStatus.timeWarStatus.warId
WarSummary
- Subpackages
- hd2api.services package
- Submodules
- hd2api.services.async_None_service module
- hd2api.services.async_comm_service module
GetApiV1Assignments()GetApiV1AssignmentsAll()GetApiV1Campaigns()GetApiV1CampaignsAll()GetApiV1Dispatches()GetApiV1DispatchesAll()GetApiV1PlanetEvents()GetApiV1Planets()GetApiV1PlanetsAll()GetApiV1Steam()GetApiV1Steam2()GetApiV1War()GetCommApiRawAll()GetCommApiRawAssignment()GetCommApiRawNewsFeed()GetCommApiRawSpaceStation()GetCommApiRawSummary()GetCommApiRawWarInfo()GetCommApiRawWarStatus()make_comm_raw_api_request()make_comm_v1_api_request()
- hd2api.services.async_direct_service module
- hd2api.services.async_diveh_service module
- hd2api.services.async_raw_service module
- hd2api.services.service_utils module
- Module contents
GetApiDirectAll()GetApiDirectAssignment()GetApiDirectNewsFeed()GetApiDirectSpaceStation()GetApiDirectSummary()GetApiDirectWarInfo()GetApiDirectWarStatus()GetApiRawAll()GetApiRawAssignment()GetApiRawNewsFeed()GetApiRawSpaceStation()GetApiRawSummary()GetApiRawWarInfo()GetApiRawWarStatus()GetApiV1Assignments()GetApiV1AssignmentsAll()GetApiV1Campaigns()GetApiV1CampaignsAll()GetApiV1Dispatches()GetApiV1DispatchesAll()GetApiV1PlanetEvents()GetApiV1Planets()GetApiV1PlanetsAll()GetApiV1Steam()GetApiV1Steam2()GetApiV1War()GetCommApiRawAssignment()GetCommApiRawNewsFeed()GetCommApiRawSpaceStation()GetCommApiRawSummary()GetCommApiRawWarInfo()GetCommApiRawWarStatus()GetDhApiRawAll()GetDhApiRawAssignment()GetDhApiRawNewsFeed()GetDhApiRawSpaceStation()GetDhApiRawSummary()GetDhApiRawWarInfo()GetDhApiRawWarStatus()
- hd2api.util package
Submodules¶
hd2api.api_config module¶
- class hd2api.api_config.APIConfig(*, api_comm: str = 'https://api.helldivers2.dev', api_diveharder: str = 'https://api.diveharder.com', api_direct: str = 'https://api.live.prod.thehelldiversgame.com', use_raw: Literal['community', 'diveharder', 'direct'] = 'direct', verify: bool | str = True, client_name: str = 'DefaultClientName', client_contact: str | None = None, language: str = 'en-US', warID: int = 801, static_path: str = '', timeout: float = 8, statics: StaticAll | None = None)¶
Bases:
BaseModelPrimary configuration object used for the API service functions.
- model_config = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
hd2api.load_json module¶
- hd2api.load_json.get_repo_dir() str¶
Get the directory path for the default static json file directory.
- Returns:
The target directory path.
- Return type:
- hd2api.load_json.load_and_merge_json_files(json_path: str, static_dir: str | None = None)¶
Load all JSON files from the specified directory into a single dictionary.
Args: - directory_path (str): Path to the directory containing JSON files.
Returns: - dict: A dictionary where keys are file names (without extension) and values are loaded JSON data.