Skip to content

API Reference

Element

Bases: StrEnum

Enumeration of character elements.

Source code in ambr/enums.py 
78
79
80
81
82
83
84
85
86
87
class Element(StrEnum):
    """Enumeration of character elements."""

    ANEMO = "Wind"
    GEO = "Rock"
    ELECTRO = "Electric"
    PYRO = "Fire"
    HYDRO = "Water"
    CRYO = "Ice"
    DENDRO = "Grass"

ExtraLevelType

Bases: IntEnum

Enumeration for identifying which talent gets extra levels from constellations.

Source code in ambr/enums.py 
 99
100
101
102
103
104
class ExtraLevelType(IntEnum):
    """Enumeration for identifying which talent gets extra levels from constellations."""

    NORMAL = 1
    SKILL = 2
    ULTIMATE = 9

Language

Bases: StrEnum

Supported languages for the API data.

Source code in ambr/enums.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
class Language(StrEnum):
    """Supported languages for the API data."""

    CHT = "cht"
    """Traditional Chinese."""
    CHS = "chs"
    """Simplified Chinese."""
    DE = "de"
    """German."""
    EN = "en"
    """English."""
    ES = "es"
    """Spanish."""
    FR = "fr"
    """French."""
    ID = "id"
    """Indonesian."""
    JP = "jp"
    """Japanese."""
    KR = "kr"
    """Korean."""
    PT = "pt"
    """Portuguese."""
    RU = "ru"
    """Russian."""
    TH = "th"
    """Thai."""
    VI = "vi"
    """Vietnamese."""
    IT = "it"
    """Italian."""
    TR = "tr"
    """Turkish."""

CHS = 'chs' class-attribute instance-attribute

Simplified Chinese.

CHT = 'cht' class-attribute instance-attribute

Traditional Chinese.

DE = 'de' class-attribute instance-attribute

German.

EN = 'en' class-attribute instance-attribute

English.

ES = 'es' class-attribute instance-attribute

Spanish.

FR = 'fr' class-attribute instance-attribute

French.

ID = 'id' class-attribute instance-attribute

Indonesian.

IT = 'it' class-attribute instance-attribute

Italian.

JP = 'jp' class-attribute instance-attribute

Japanese.

KR = 'kr' class-attribute instance-attribute

Korean.

PT = 'pt' class-attribute instance-attribute

Portuguese.

RU = 'ru' class-attribute instance-attribute

Russian.

TH = 'th' class-attribute instance-attribute

Thai.

TR = 'tr' class-attribute instance-attribute

Turkish.

VI = 'vi' class-attribute instance-attribute

Vietnamese.

SpecialStat

Bases: StrEnum

Enumeration of character specialized ascension stats.

Source code in ambr/enums.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
class SpecialStat(StrEnum):
    """Enumeration of character specialized ascension stats."""

    CRIT_RATE = "FIGHT_PROP_CRITICAL"
    CRITI_DMG = "FIGHT_PROP_CRITICAL_HURT"

    BASE_ATTACK = "FIGHT_PROP_BASE_ATTACK"
    ATTACK = "FIGHT_PROP_ATTACK_PERCENT"
    HP = "FIGHT_PROP_HP_PERCENT"
    DEFENSE = "FIGHT_PROP_DEFENSE_PERCENT"

    HEAL_BONUS = "FIGHT_PROP_HEAL_ADD"
    ELEMENTAL_MASTERY = "FIGHT_PROP_ELEMENT_MASTERY"
    ENERGY_RECHARGE = "FIGHT_PROP_CHARGE_EFFICIENCY"

    HYDRO_DMG_BONUS = "FIGHT_PROP_WATER_ADD_HURT"
    PYRO_DMG_BONUS = "FIGHT_PROP_FIRE_ADD_HURT"
    ELECTRO_DMG_BONUS = "FIGHT_PROP_ELEC_ADD_HURT"
    ANEMO_DMG_BONUS = "FIGHT_PROP_WIND_ADD_HURT"
    CRYO_DMG_BONUS = "FIGHT_PROP_ICE_ADD_HURT"
    GEO_DMG_BONUS = "FIGHT_PROP_ROCK_ADD_HURT"
    DENDRO_DMG_BONUS = "FIGHT_PROP_GRASS_ADD_HURT"
    PHYSICAL_DMG_BONUS = "FIGHT_PROP_PHYSICAL_ADD_HURT"

TalentType

Bases: IntEnum

Enumeration of character talent types.

Source code in ambr/enums.py 
90
91
92
93
94
95
96
class TalentType(IntEnum):
    """Enumeration of character talent types."""

    NORMAL = 0
    SKILL = 1  # Often referred to as Elemental Skill
    ULTIMATE = 2  # Often referred to as Elemental Burst
    PASSIVE = 3  # Passive talents

WeaponType

Bases: StrEnum

Enumeration of character weapon types.

Source code in ambr/enums.py 
43
44
45
46
47
48
49
50
class WeaponType(StrEnum):
    """Enumeration of character weapon types."""

    BOW = "WEAPON_BOW"
    CATALYST = "WEAPON_CATALYST"
    CLAYMORE = "WEAPON_CLAYMORE"
    SWORD = "WEAPON_SWORD_ONE_HAND"
    POLE = "WEAPON_POLE"