API¶
Main Interface¶
-
class
pobapi.api.PathOfBuildingAPI(xml)[source]¶ Instances of this class are single Path Of Building pastebins.
- Parameters
xml (
bytes) – Path of Building XML document in byte format.
Note
XML must me in byte format, not string format. This is required because the XML contains encoding information.
Note
To instantiate from pastebin.com links or import codes, use
from_url()orfrom_import_code(), respectively.-
active_item_set¶ Get the item set a character is currently wearing.
- Returns
Item set.
- Return type
-
active_skill¶ Get a character’s main skill.
- Returns
Main skill.
- Return type
-
active_skill_group¶ Get a character’s main skill setup.
- Returns
Main skill setup.
- Return type
-
ascendancy_name¶ Get a character’s ascendancy class.
-
config¶ Namespace for Path Of Building config tab’s options and values.
- Returns
Path Of Building config.
- Return type
-
item_sets¶ Get a list of all item sets of a character.
Note
Slot IDs are 0-indexed.
-
keystones¶ Namespace for a character’s keystones.
Iterate over the keystones property to only get active keystones.
- Returns
Keystones.
- Return type
-
second_weapon_set¶ Get whether a character primarily uses their second weapon set.
- Returns
Truth value.
- Return type
-
skill_groups¶ Get a character’s skill setups.
- Returns
Skill setups.
- Return type
-
pobapi.api.from_import_code(import_code)[source]¶ Instantiate build class from an import code generated with Path Of Building.
- Raises
- Parameters
import_code (
str) – import code generated with Path Of Building.- Return type
Data Models¶
-
class
pobapi.models.Gem(name: str, enabled: bool, level: int, quality: int, support: bool)[source]¶ Class that holds the data of an ability granted by a skill gem.
-
class
pobapi.models.GrantedAbility(name: str, enabled: bool, level: int, quality: int = None, support: bool = False)[source]¶ Class that holds the data of an ability granted by an item.
-
class
pobapi.models.Item(rarity: str, name: str, base: str, uid: str, shaper: bool, elder: bool, crafted: bool, quality: Optional[int], sockets: Optional[Tuple[Tuple[str]]], level_req: int, item_level: int, implicit: Optional[int], text: str)[source]¶ Class that holds an item.
- Parameters
Note
Items created in Path of Building do not have an UID.
- Parameters
shaper (
bool) – Whether the item is a Shaper base type.elder (
bool) – Whether the item is an Elder base type.crafted (
bool) – Whether the item has a crafted mod.quality (
Optional[int]) – Item quality, if the item can have quality.sockets (
Optional[Tuple[Tuple[str]]]) – Item socket groups, if the item can have sockets.
Note
Example: The format used for a 5 socket chest armour with 2 socket groups of 3 linked blue sockets and 2 linked red sockets would be ((B, B, B), (R, R)).
- Parameters
Note
For items existing in-game, their item text is just copied. For items created with Path Of Building, their affix values are calculated to match in-game items in appearance.
-
class
pobapi.models.Keystones(*args)[source]¶ Class that holds keystone data.
- Parameters
acrobatics (
bool) – Whether the player has Acrobatics.ancestral_bond (
bool) – Whether the player has Ancestral Bond.arrow_dancing (
bool) – Whether the player has Arrow Dancing.avatar_of_fire (
bool) – Whether the player has Avatar of Fire.blood_magic (
bool) – Whether the player has Blood Magic.chaos_inoculation (
bool) – Whether the player has Chaos Inoculation.conduit (
bool) – Whether the player has Conduit.crimson_dance (
bool) – Whether the player has Crimson Dance.eldritch_battery (
bool) – Whether the player has Eldritch Battery.elemental_equilibrium (
bool) – Whether the player has Elemental Equilibrium.ghost_reaver (
bool) – Whether the player has Ghost Reaver.iron_grip (
bool) – Whether the player has Iron Grip.iron_reflexes (
bool) – Whether the player has Iron Reflexes.mind_over_matter (
bool) – Whether the player has Mind Over Matter.minion_instability (
bool) – Whether the player has Minion Instability.mortal_conviction (
bool) – Whether the player has Mortal Conviction.necromantic_aegis (
bool) – Whether the player has Necromantic Aegis.pain_attunement (
bool) – Whether the player has Pain Attunement.perfect_agony (
bool) – Whether the player has Perfect Agony.phase_acrobatics (
bool) – Whether the player has Phase Acrobatics.point_blank (
bool) – Whether the player has Point Blank.resolute_technique (
bool) – Whether the player has Resolute Technique.runebinder (
bool) – Whether the player has Runebinder.unwavering_stance (
bool) – Whether the player has Unwavering Stance.vaal_pact (
bool) – Whether the player has Vaal Pact.wicked_ward (
bool) – Whether the player has Wicked Ward.zealots_oath (
bool) – Whether the player has Zealots Oath.
-
class
pobapi.models.Set(*args)[source]¶ Class that holds an item set.
- Parameters
weapon1_as1 (
Optional[int]) – Primary weapon abyssal socket 1.weapon1_as2 (
Optional[int]) – Primary weapon abyssal socket 1.weapon1_swap_as1 (
Optional[int]) – Second primary weapon abyssal socket 1.weapon1_swap_as2 (
Optional[int]) – Second primary weapon abyssal socket 2.weapon2_as1 (
Optional[int]) – Secondary weapon abyssal socket 1.weapon2_as2 (
Optional[int]) – Secondary weapon abyssal socket 1.weapon2_swap_as1 (
Optional[int]) – Second secondary weapon abyssal socket 1.weapon2_swap_as2 (
Optional[int]) – Second secondary weapon abyssal socket 2.body_armour_as1 (
Optional[int]) – Body armour abyssal socket 1.body_armour_as2 (
Optional[int]) – Body armour abyssal socket 2.
-
class
pobapi.models.SkillGroup(enabled: bool, label: str, active: Optional[int], abilities: List[Union[pobapi.models.Gem, pobapi.models.GrantedAbility]])[source]¶ Class that holds a (linked) socket group.
- Parameters
enabled (
bool) – Whether the socket group is in active use.label (
str) – Socket group label assigned in Path Of Building.active (
Optional[int]) – Main skill in socket group, if given.abilities (
List[Union[Gem,GrantedAbility]]) – List ofGemorGrantedAbilityobjects in socket group.
Character Stat-Sheet¶
-
class
pobapi.stats.Stats(*args)[source]¶ Class that holds character stat-sheet data.
- Parameters
average_damage (
Optional[float]) – Average hit damage after accuracy check.trap_throwing_speed (
Optional[float]) – Trap throwing speed.totem_placement_speed (
Optional[float]) – Totem placement speed.pre_effective_crit_chance (
Optional[float]) – Crit chance as displayed in-game (doesn’t factor in accuracy and luck).crit_chance (
Optional[float]) – Effective crit chance, factors in accuracy and luck.crit_multiplier (
Optional[float]) – Critical strike multiplier.total_dot (
Optional[float]) – Total damage over time (per second).total_dps_with_ignite (
Optional[float]) – Total damage per second including ignite damage.average_damage_with_ignite (
Optional[float]) – Average hit damage including ignite.total_dps_with_poison (
Optional[float]) – Total damage per second including poison damage.average_damage_with_poison (
Optional[float]) – Average hit damage including poison.area_of_effect_radius (
Optional[float]) – Area of effect radius.intelligence_required (
Optional[float]) – Intelligence required.life_unreserved_percent (
Optional[float]) – Percent unreserved life.life_leech_rate_per_hit (
Optional[float]) – Percent life leeched per hit.life_leech_gain_per_hit (
Optional[float]) – Flat life leeched per hit.mana_unreserved_percent (
Optional[float]) – Percent unreserved mana.mana_leech_rate_per_hit (
Optional[float]) – Percent mana leeched per hit.mana_leech_gain_per_hit (
Optional[float]) – Flat mana leeched per hit.energy_shield_increased (
Optional[float]) – Percent increased energy shield.energy_shield_regen (
Optional[float]) – Flat energy shield regeneration.energy_shield_leech_rate_per_hit (
Optional[float]) – Percent energy shield leeched per hit.energy_shield_leech_gain_per_hit (
Optional[float]) – Flat energy shield leeched per hit.evasion_increased (
Optional[float]) – Percent increased evasion rating.melee_evade_chance (
Optional[float]) – Chance to evade melee attacks.projectile_evade_chance (
Optional[float]) – Chance to evade projectiles.armour_increased (
Optional[float]) – Percent increased armour.physical_damage_reduction (
Optional[float]) – Physical damage reduction.effective_movement_speed_modifier (
Optional[float]) – Effective movement speed modifier.spell_block_chance (
Optional[float]) – Chance to block spells.attack_dodge_chance (
Optional[float]) – Chance to dodge attacks.spell_dodge_chance (
Optional[float]) – Chance to dodge spells.lightning_resistance (
Optional[float]) – Lightning resistance.fire_resistance_over_cap (
Optional[float]) – Overcapped fire resistance.cold_resistance_over_cap (
Optional[float]) – Overcapped cold resistancelightning_resistance_over_cap (
Optional[float]) – Overcapped lightning resistance.chaos_resistance_over_cap (
Optional[float]) – Overcapped chaos resistance.power_charges_maximum (
Optional[float]) – Maximum power charges.frenzy_charges_maximum (
Optional[float]) – Maximum frenzy charges.endurance_charges_maximum (
Optional[float]) – Maximum endurance charges.active_totem_limit (
Optional[float]) – Maximum active totems.active_minion_limit (
Optional[float]) – Maximum number of minions.
Build Configuration¶
-
class
pobapi.config.Config(*args)[source]¶ Class that holds build configuration data.
Note
Many map mods have different tiers for white, yellow and red maps; documented as tuples (white, yellow, red).
- Parameters
resistance_penalty – Resistance penalty obtained by slaying Kitava. Possible values: 0, -30, -60 (default).
enemy_level – Level of enemies. Possible values: 1 to 100.
enemy_physical_hit_damage – Damage enemies deal with physical hits.
detonate_dead_corpse_life – Life of corpses consumed by Detonate Dead.
is_stationary – Whether the player is stationary.
is_moving – Whether the player is moving.
is_on_full_life – Whether the player is on Full Life.
is_on_low_life – Whether the player is on Low Life.
is_on_full_energy_shield – Whether the player is on Full Energy Shield.
has_energy_shield – Whether the player currently has energy shield.
minions_on_full_life – Whether the player’s minions are on Full Life.
ignite_mode – Controls how ignite damage is calculated. Possible values: (‘Average’, ‘Crit’).
aspect_of_the_avian_avians_might – Whether Avian’s Might is active.
aspect_of_the_avian_avians_flight – Whether Avian’s Flight is active.
aspect_of_the_cat_cats_stealth – Whether Cat’s Stealth is active.
aspect_of_the_cat_cats_agility – Whether Cats’s Agility is active.
override_crab_barriers – Overridden number of crab barriers.
aspect_of_the_spider_web_stacks – Number of web stacks on enemies.
banner_planted – Whether the player has planted a banner.
banner_stages – Number of banner stages.
in_bloodstorm – Whether the player is in a Bloodstorm.
in_sandstorm – Whether the player is in a Sandstorm.
brand_attached – Whether the player has a brand attached.
dark_pact_skeleton_life – Skeleton life points used for Dark Pact damage calculation.
deathmark – Whether the player applies Deathmark.
herald_of_agony_stacks – Number of Virulence stacks on Herald of Agony.
ice_nova_cast_on_frostbolt – Whether the player casts Ice Nova on a Frost Bolt.
infusion – Whether the Infusion Infusion buff is active.
innervate_innervation – Whether the Innervate Innervation buff is active.
intensify_stacks – Number of Intensify stacks.
meat_shield_enemy_nearby – Whether there are enemies near your minions supported by Meat Shield Support.
raise_spectres_spectre_level – Level of spectres raised by Raise Spectre.
raise_spectres_enable_curses – Whether the curses of spectres are active.
raise_spectres_blade_vortex_blade_count – Number of Blade Vortex stacks of spectres.
raise_spectres_kaom_fire_beam_totem_stage – Number of fire beam stages of spectres.
raise_spectres_enable_summoned_ursa_rallying_cry – Whether the Rallying Cry of ursa spectres is active.
raise_spiders_spider_count – Number of spiders from Raise Spiders.
siphoning_trap_affected_enemies – Number of enemies affected by Siphoning Trap.
stance – Controls whether the player is in Blood Stance or Sand Stance. Possible values: (‘Blood’, ‘Sand’).
summon_holy_relic_enable_holy_relic_buff – Whether the Holy Relic buff of Summon Holy Relics is active.
summon_lightning_golem_enable_wrath – Whether a Lightning Golem’s wrath buff is active.
vortex_cast_on_frostbolt – Whether the player casts Vortex on a Frost Bolt.
wave_of_conviction_exposure_type – Controls which Exposure damage type is selected. Possible values: (‘Fire’, ‘Cold’, ‘Lightning’).
winter_orb_stages – Number of stages of Winter Orb.
enemy_physical_reduction – Whether enemies have physical damage reduction. Possible values: (20%, 30%, 40%).
enemy_hexproof – Whether enemies are hexproof.
less_curse_effect – Whether enemies have reduced effect of curses on them. Possible values: (25%, 40%, 60%).
enemy_avoid_poison_blind_bleed – Whether enemies have a chance to avoid poison, blind and bleed. Possible values: (25%, 45%, 65%).
enemy_resistances – Whether enemies have increased elemental and chaos resistances. Possible values: ((20%, 15%), (30%, 20%), (40%, 25%)).
elemental_equilibrium – Whether player have Elemental Equilibrium.
no_leech – Whether players cannot leech life/mana/energy shield.
reduced_flask_charges – Whether players gain reduced flask charges. Possible values: (30%, 40%, 50%).
minus_max_resists – Whether players have reduced maximum resistances. Possible values: (0%, 5-8%, 9-12%).
less_aoe – Whether players have less area of effect. Possible values: (15%, 20%, 25%).
enemy_avoid_status_ailment – Whether enemies have a chance to avoid status ailments. Possible values: (30%, 60%, 90%).
enemy_increased_accuracy – Whether enemies hav increased accuracy. Possible values: (30%, 40%, 50%).
less_armour_block – Whether players have less armour and block chance. Possible values: ((20%, 20%), (25%, 30%), (30%, 40%)).
point_blank – Whether players have Point Blank.
less_recovery – Whether players have less life/mana/energy shield recovery rate. Possible values: (20%, 40%, 60%).
no_regen – Whether players cannot regenerate life/mana/energy shield.
enemy_takes_reduced_extra_crit_damage – Whether enemies take reduced extra damage from critical strikes. Possible values: (25-30%, 31-35%, 36-40%).
curse_assassins_mark – Level of Assassin’s Mark applying to players.
curse_conductivity – Level Conductivity applying to players.
curse_despair – Level of Despair applying to players.
curse_elemental_weakness – Level of Elemental Weakness applying to players.
curse_enfeeble – Level of Enfeeble applying to players.
curse_flammability – Level of Flammability applying to players.
curse_frostbite – Level of Frostbite applying to players.
curse_poachers_mark – Level of Poacher’s Mark applying to players.
curse_projectile_weakness – Level of Projectile Weakness applying to players.
curse_punishment – Level of Punishment applying to players.
curse_temporal_chains – Level of Temporal Chains applying to players.
curse_vulnerability – Level of Vulnerability applying to players.
curse_warlords_mark – Level of Warlord’s Mark applying to players.
use_power_charges – Whether the player uses power charges.
max_power_charges – Whether the player is at maximum power charges.
use_frenzy_charges – Whether the player uses frenzy charges.
max_frenzy_charges – Whether the player is at maximum frenzy charges.
use_endurance_charges – Whether the player uses endurance charges.
max_endurance_charges – Whether the player is at maximum endurance charges.
use_siphoning_charges – Whether the player uses siphoning charges.
use_challenger_charges – Whether the player uses Challenger Charges.
max_challenger_charges – Whether the player is at maximum Challenger Charges.
use_blitz_charges – Whether the player uses Blitz Charges.
max_blitz_charges – Whether the player is at maximum Blitz Charges.
use_inspiration_charges – Whether the player uses Inspiration Charges.
max_inspiration_charges – Whether the player is at maximum Inspiration Charges.
max_siphoning_charges – Whether the player is at maximum siphoning charges.
minions_use_power_charges – Whether the player’s minions use power charges.
minions_use_frenzy_charges – Whether the player’s minions use frenzy charges.
minions_use_endurance_charges – Whether the player’s minions use endurance charges.
focus – Whether the player has Focus.
onslaught – Whether the player has Onslaught.
unholy_might – Whether the player has Unholy Might.
phasing – Whether the player has Phasing.
fortify – Whether the player has Fortify.
tailwind – Whether the player has Tailwind.
adrenaline – Whether the player has Adrenaline.
divinity – Whether the player has Divinity.
rage – Whether the player has Rage.
leeching – Whether the player is leeching.
leeching_life – Whether the player is leeching Life.
leeching_energy_shield – Whether the player is leeching Energy Shield.
leeching_mana – Whether the player is leeching Mana.
using_flask – Whether the player is using a flask.
has_totem – Whether the player has a totem.
number_of_nearby_allies – Number of nearby allies.
number_of_nearby_enemies – Number of nearby enemies.
number_of_nearby_corpses – Number of nearby corpses.
on_consecrated_ground – Whether the player is on consecrated ground.
on_burning_ground – Whether the player is on burning ground.
on_chilled_ground – Whether the player is on chilled ground.
on_shocked_ground – Whether the player is on shocked ground.
burning – Whether the player is burning.
ignited – Whether the player is ignited.
chilled – Whether the player is chilled.
frozen – Whether the player is frozen.
shocked – Whether the player is shocked.
bleeding – Whether the player is bleeding.
poisoned – Whether the player is poisoned.
number_of_poison_stacks – Number of poison stacks on the player.
only_one_nearby_enemy – Whether there is only one enemy nearby.
hit_recently – Whether the player has hit recently.
crit_recently – Whether the player has crit recently.
skill_crit_recently – Whether one the player’s skills has crit recently.
non_crit_recently – Whether the player has not crit recently.
killed_recently – Whether the player has killed recently.
number_of_enemies_killed_recently – Number of enemies killed by the player recently.
totems_killed_recently – Whether the player’s totems killed recently.
number_of_totems_killed_recently – Number of enemies killed by the player’s totems recently.
minions_killed_recently – Whether the player’s minions killed recently.
number_of_minions_killed_recently – Number of enemies killed by the player’s minions recently.
killed_affected_by_dot – Whether the player has killed an enemy affected by damage over time recently.
number_of_shocked_enemies_killed_recently – Number of shocked enemies killed by the player recently.
frozen_enemy_recently – Whether the player has frozen an enemy recently.
shattered_enemy_recently – Whether the player has shattered an enemy recently.
ignited_enemy_recently – Whether the player has ignited an enemy recently.
shocked_enemy_recently – Whether the player has shocked an enemy recently.
number_of_poisons_applied_recently – Number of poisons applied by the player recently.
been_hit_recently – Whether the player has been hit recently.
been_crit_recently – Whether the player has been crit recently.
been_savage_hit_recently – Whether the player has been savage hit recently.
hit_by_fire_damage_recently – Whether the player has been hit by fire damage recently.
hit_by_cold_damage_recently – Whether the player has been hit by cold damage recently.
hit_by_lightning_damage_recently – Whether the player has been hit by lightning damage recently.
blocked_recently – Whether the player has blocked recently.
blocked_attack_recently – Whether the player has blocked an attack recently.
blocked_spell_recently – Whether the player has blocked a spell recently.
energy_shield_recharge_started_recently – Whether the player’s energy shield recharge started recently.
pendulum_of_destruction – Controls Pendulum of Destruction mode. Possible values: (‘Area’, ‘Damage’).
elemental_conflux – Controls Elemental Conflux mode. Possible values: (‘Chilling’, ‘Shocking’, ‘Igniting’, ‘All’).
bastion_of_hope – Whether the player has Bastion of Hope.
her_embrace – Whether the player is in Her Embrace.
used_skill_recently – Whether the player has used a skill recently.
attacked_recently – Whether the player has attacked recently.
cast_spell_recently – Whether the player has cast a spell recently.
used_fire_skill_recently – Whether the player has used a fire skill recently.
used_cold_skill_recently – Whether the player has used a cold skill recently.
used_minion_skill_recently – Whether the player has used a minion skill recently.
used_movement_skill_recently – Whether the player has used a movement skill recently.
used_vaal_skill_recently – Whether the player has used a vaal skill recently.
used_warcry_recently – Whether the player has used a warcry recently.
used_warcry_in_past_8_seconds – Whether the player has used a warcry in the past 8 seconds.
number_of_mines_detonated_recently – Number of mines detonated recently.
number_of_traps_triggered_recently – Number of traps triggered recently.
consumed_corpses_recently – Whether the player has consumed corpses recently.
number_of_corpses_consumed_recently – Number of corpses consumed by the player recently.
taunted_enemy_recently – Whether the player has taunted an enemy recently.
blocked_hit_from_unique_enemy_in_past_ten_seconds – Whether the player has blocked a hit from an unique enemy in the past ten seconds.
lucky_crits – Whether the player’s hits are lucky.
number_of_times_skill_has_chained – Number of times the main skill has chained.
projectile_distance – Projectile travel distance.
enemy_in_close_range – Whether enemies are in close range.
enemy_moving – Whether enemies are moving.
enemy_on_full_life – Whether enemies are on full life.
enemy_on_low_life – Whether enemies are on low life.
enemy_cursed – Whether enemies are cursed.
enemy_bleeding – Whether enemies are bleeding.
enemy_poisoned – Whether enemies are poisoned.
enemy_number_of_poison_stacks – Number of poison stacks on enemies.
enemy_maimed – Whether enemies are maimed.
enemy_hindered – Whether enemies are hindered.
enemy_blinded – Whether enemies are blinded.
enemy_taunted – Whether enemies are taunted.
enemy_burning – Whether enemies are burning.
enemy_ignited – Whether enemies are ignited.
enemy_chilled – Whether enemies are chilled.
enemy_frozen – Whether enemies are frozen.
enemy_shocked – Whether enemies are shocked.
enemy_number_of_freeze_shock_ignite – Number of enemies frozen, shocked, or ignited recently.
enemy_intimidated – Whether enemies are intimidated.
enemy_unnerved – Whether enemies are unnerved.
enemy_covered_in_ash – Whether enemies are covered in ash.
enemy_rare_or_unique – Whether enemies are rare or unique.
enemy_boss – Whether enemies are bosses. Possible Values: (False, True, ‘Shaper’).
enemy_physical_damage_reduction – Enemy physical damage reduction.
enemy_fire_resist – Enemy fire resistance.
enemy_cold_resist – Enemy cold resistance.
enemy_lightning_resist – Enemy lightning resistance.
enemy_chaos_resist – Enemy chaos resistance.
enemy_hit_by_fire_damage – Whether enemies were hit by fire damage.
enemy_hit_by_cold_damage – Whether enemies were hit by cold damage.
enemy_hit_by_lightning_damage – Whether enemies were hit by lightning damage.
elemental_equilibrium_ignore_hit_damage – Whether to ignore skill hit damage resetting Elemental Equilibrium.
character_level – Overridden character/enemy level used to estimate hit and evasion chances, enemy life and damage.