API Reference

enums

Classes:

• GIElement –

  Represent a Genshin Impact element.

• Game –

  Represent games supported by the Hakushin API.

• HSRElement –

  Represent an HSR element.

• HSREndgameType –

  Represent an HSR endgame.

• HSRPath –

  Represent an HSR character path.

• Language –

  Represent languages supported by the Hakushin API.

• MWCostumeBodyType –

  Miliastra Wonderland costume body types

• ZZZAttackType –

  Represent a ZZZ character attack type.

• ZZZElement –

  Represent a ZZZ character element.

• ZZZSkillType –

  Represent a ZZZ character skill type.

• ZZZSpecialty –

  Represent a ZZZ character specialty.

GIElement

Represent a Genshin Impact element.

Returned by:

• API Reference Models API Reference  gi  Character  element

Attributes:

• ANEMO –
• CRYO –
• DENDRO –
• ELECTRO –
• GEO –
• HYDRO –
• PYRO –

ANEMO class-attribute instance-attribute

ANEMO = 'Anemo'

CRYO class-attribute instance-attribute

CRYO = 'Cryo'

DENDRO class-attribute instance-attribute

DENDRO = 'Dendro'

ELECTRO class-attribute instance-attribute

ELECTRO = 'Electro'

GEO class-attribute instance-attribute

GEO = 'Geo'

HYDRO class-attribute instance-attribute

HYDRO = 'Hydro'

PYRO class-attribute instance-attribute

PYRO = 'Pyro'

Game

Represent games supported by the Hakushin API.

Used by:

• API Reference API Reference  utils
  •  get_ascension_from_level
  •  get_max_level_from_ascension

Attributes:

• GI –

  Genshin Impact.

• HSR –

  Honkai: Star Rail.

• ZZZ –

  Zenless Zone Zero.

GI class-attribute instance-attribute

GI = 'gi'

Genshin Impact.

HSR class-attribute instance-attribute

HSR = 'hsr'

Honkai: Star Rail.

ZZZ class-attribute instance-attribute

ZZZ = 'zzz'

Zenless Zone Zero.

HSRElement

Represent an HSR element.

Returned by:

• API Reference Models API Reference  hsr
  •  Character  element
  •  ChildMonster  stance_weak_list
  •  DamageTypeResistance  element
  •  EndgameStage
    •  first_half_weaknesses
    •  second_half_weaknesses
  •  HSREnemySkill  damage_type
  •  Monster  weaknesses
  •  ProcessedEnemy  weaknesses

Attributes:

• FIRE –
• ICE –
• IMAGINARY –
• PHYSICAL –
• QUANTUM –
• THUNDER –
• WIND –

FIRE class-attribute instance-attribute

FIRE = 'Fire'

ICE class-attribute instance-attribute

ICE = 'Ice'

IMAGINARY class-attribute instance-attribute

IMAGINARY = 'Imaginary'

PHYSICAL class-attribute instance-attribute

PHYSICAL = 'Physical'

QUANTUM class-attribute instance-attribute

QUANTUM = 'Quantum'

THUNDER class-attribute instance-attribute

THUNDER = 'Thunder'

WIND class-attribute instance-attribute

WIND = 'Wind'

HSREndgameType

Represent an HSR endgame.

Returned by:

• API Reference Models API Reference  hsr  EndgameSummary  type

Attributes:

• APOCALYPTIC_SHADOW –
• MEMORY_OF_CHAOS –
• PURE_FICTION –

APOCALYPTIC_SHADOW class-attribute instance-attribute

APOCALYPTIC_SHADOW = 'boss'

MEMORY_OF_CHAOS class-attribute instance-attribute

MEMORY_OF_CHAOS = 'maze'

PURE_FICTION class-attribute instance-attribute

PURE_FICTION = 'story'

HSRPath

Represent an HSR character path.

Returned by:

• API Reference Models API Reference  hsr
  •  Character  path
  •  LightCone  path
  •  LightConeDetail  path

Attributes:

• ABUNDANCE –
• DESTRUCTION –
• ELATION –
• ERUDITION –
• HARMONY –
• NIHILITY –
• PRESERVATION –
• REMEMBRANCE –
• THE_HUNT –

ABUNDANCE class-attribute instance-attribute

ABUNDANCE = 'Priest'

DESTRUCTION class-attribute instance-attribute

DESTRUCTION = 'Warrior'

ELATION class-attribute instance-attribute

ELATION = 'Elation'

ERUDITION class-attribute instance-attribute

ERUDITION = 'Mage'

HARMONY class-attribute instance-attribute

HARMONY = 'Shaman'

NIHILITY class-attribute instance-attribute

NIHILITY = 'Warlock'

PRESERVATION class-attribute instance-attribute

PRESERVATION = 'Knight'

REMEMBRANCE class-attribute instance-attribute

REMEMBRANCE = 'Memory'

THE_HUNT class-attribute instance-attribute

THE_HUNT = 'Rogue'

Language

Represent languages supported by the Hakushin API.

Attributes:

• EN –

  English.

• JA –

  Japanese.

• KO –

  Korean.

• ZH –

  Simple Chinese.

EN class-attribute instance-attribute

EN = 'en'

English.

JA class-attribute instance-attribute

JA = 'ja'

Japanese.

KO class-attribute instance-attribute

KO = 'ko'

Korean.

ZH class-attribute instance-attribute

ZH = 'zh'

Simple Chinese.

MWCostumeBodyType

Miliastra Wonderland costume body types

Attributes:

• BOY –
• GIRL –

BOY class-attribute instance-attribute

BOY = 'BODY_BOY'

GIRL class-attribute instance-attribute

GIRL = 'BODY_GIRL'

ZZZAttackType

Represent a ZZZ character attack type.

Returned by:

• API Reference Models API Reference  zzz  Character  attack_type

Attributes:

• PIERCE –
• SLASH –
• STRIKE –

PIERCE class-attribute instance-attribute

PIERCE = 103

SLASH class-attribute instance-attribute

SLASH = 101

STRIKE class-attribute instance-attribute

STRIKE = 102

ZZZElement

Represent a ZZZ character element.

Returned by:

• API Reference Models API Reference  zzz  Character  element

Attributes:

• ELECTRIC –
• ETHER –
• FIRE –
• ICE –
• PHYSICAL –
• WIND –

ELECTRIC class-attribute instance-attribute

ELECTRIC = 203

ETHER class-attribute instance-attribute

ETHER = 205

FIRE class-attribute instance-attribute

FIRE = 201

ICE class-attribute instance-attribute

ICE = 202

PHYSICAL class-attribute instance-attribute

PHYSICAL = 200

WIND class-attribute instance-attribute

WIND = 204

ZZZSkillType

Represent a ZZZ character skill type.

Returned by:

• API Reference Models API Reference  zzz
  •  CharacterDetail  skills
  •  CharacterSkill  type

Attributes:

• ASSIST –
• BASIC –
• CHAIN –
• CORE –
• DODGE –
• PASSIVE –
• SPECIAL –

ASSIST class-attribute instance-attribute

ASSIST = 'assist'

BASIC class-attribute instance-attribute

BASIC = 'basic'

CHAIN class-attribute instance-attribute

CHAIN = 'chain'

CORE class-attribute instance-attribute

CORE = 'core'

DODGE class-attribute instance-attribute

DODGE = 'dodge'

PASSIVE class-attribute instance-attribute

PASSIVE = 'passive'

SPECIAL class-attribute instance-attribute

SPECIAL = 'special'

ZZZSpecialty

Represent a ZZZ character specialty.

Returned by:

• API Reference Models API Reference  zzz
  •  Character  specialty
  •  Weapon  specialty
  •  WeaponType  type

Attributes:

• ANOMALY –
• ATTACK –
• DEFENSE –
• RUPTURE –
• STUN –
• SUPPORT –

ANOMALY class-attribute instance-attribute

ANOMALY = 3

ATTACK class-attribute instance-attribute

ATTACK = 1

DEFENSE class-attribute instance-attribute

DEFENSE = 5

RUPTURE class-attribute instance-attribute

RUPTURE = 6

STUN class-attribute instance-attribute

STUN = 2

SUPPORT class-attribute instance-attribute

SUPPORT = 4