Skip to content

Commit 209e0f2

Browse files
author
ExLin
committed
ZZZ docs and reorganization for EN
1 parent 4e7c0a4 commit 209e0f2

File tree

3 files changed

+514
-289
lines changed

3 files changed

+514
-289
lines changed

‎api.md‎

Lines changed: 3 additions & 289 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
# Enka.Network - API
22

3-
## Table of Content
4-
5-
- [Getting Started](#getting-started)
6-
- [Data Structure Info](#data-structure-info)
7-
- [Definitions](#definitions)
8-
- [Icons and Images](#icons-and-images)
9-
- [Localizations](#localizations)
3+
## Game API Docs
4+
- [Genshin Impact](docs/gi/api.md)
5+
- [Zenless Zone Zero](docs/zzz/api.md)
106

117
## Getting Started
128

@@ -93,285 +89,3 @@ If a build has a `live: true` field, that means it's not a "saved" build, but si
9389
As outlined in [UID endpoints](#uid-endpoints), when you make a UID request, you could get an `owner` object. You can construct the URL using these fields in the object:
9490

9591
`https://enka.network/api/profile/{owner.username}/hoyos/{owner.hash}/builds/`
96-
97-
98-
99-
## Data Structure Info
100-
101-
| Name | Description |
102-
| :--- | :---------- |
103-
| [playerInfo](#playerinfo) | Profile Info |
104-
| [avatarInfoList](#avatarinfolist) | List of detailed information for every character from showcase |
105-
106-
### playerInfo
107-
108-
For basic data of characters by ID, go to [store/characters.json](https://github.com/EnkaNetwork/API-docs/blob/master/store/characters.json). <br />
109-
For any additional info, check the [Characters Data](https://gitlab.com/Dimbreath/AnimeGameData/-/blob/master/ExcelBinOutput/AvatarExcelConfigData.json).
110-
111-
| Name | Description |
112-
| :--- | :--------- |
113-
| nickname | Player Nickname |
114-
| signature | Profile Signature |
115-
| worldLevel | Player World Level |
116-
| namecardId | Profile Namecard ID |
117-
| finishAchievementNum | Number of Completed Achievements |
118-
| towerFloorIndex | Abyss Floor |
119-
| towerLevelIndex | Abyss Floor's Chamber |
120-
| [showAvatarInfoList](#showavatarinfolist) | List of Character IDs and Levels |
121-
| showNameCardIdList | List of Namecard IDs |
122-
| profilePicture.avatarId | Character ID of Profile Picture |
123-
124-
#### showAvatarInfoList
125-
126-
| Name | Description |
127-
| :--- | :--------- |
128-
| avatarId | Character ID |
129-
| level | Character Level |
130-
| costumeId | ID of character's skin. Check `"Costumes"` in [store/characters.json](https://github.com/EnkaNetwork/API-docs/blob/master/store/characters.json) |
131-
132-
### avatarInfoList
133-
134-
For basic data of characters by ID, go to [store/characters.json](https://github.com/EnkaNetwork/API-docs/blob/master/store/characters.json). <br />
135-
For any additional info, check the [Characters Data](https://gitlab.com/Dimbreath/AnimeGameData/-/blob/master/ExcelBinOutput/AvatarExcelConfigData.json).
136-
137-
| Name | Description |
138-
| :--- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
139-
| avatarID | Character ID |
140-
| talentIdList | List of Constellation IDs <br /> There is no data if 0 Constellation |
141-
| [propMap](#propmap) | Character Info Properties List |
142-
| fightPropMap -> `{id: value}` | Map of Character's Combat Properties. <br />Check the [Definitions for IDs](#fightprop) |
143-
| skillDepotId | Character Skill Set ID <br />[Skills Data](https://gitlab.com/Dimbreath/AnimeGameData/-/blob/master/ExcelBinOutput/AvatarSkillDepotExcelConfigData.json) -> `"id"` |
144-
| inherentProudSkillList | List of Unlocked Skill Ids <br />[Skills Data](https://gitlab.com/Dimbreath/AnimeGameData/-/blob/master/ExcelBinOutput/AvatarSkillDepotExcelConfigData.json) -> `"inherentProudSkillOpens"` |
145-
| skillLevelMap -> `{skill_id: level}`| Map of Skill Levels <br /> [Skills Data](https://gitlab.com/Dimbreath/AnimeGameData/-/blob/master/ExcelBinOutput/AvatarSkillDepotExcelConfigData.json) -> `"inherentProudSkillOpens"` |
146-
| [equipList](#equiplist) | List of Equipments: Weapon, Ariftacts |
147-
| fetterInfo.expLevel | Character Friendship Level |
148-
149-
#### propMap
150-
151-
| Name | Description |
152-
| :--- | :--------- |
153-
| type | ID of Property Type, Check the [Definitions for IDs](#prop) |
154-
| ival | Ignore it |
155-
| val | Value of Property |
156-
157-
#### equipList
158-
159-
| Name | Description |
160-
| :--- | :--------- |
161-
| itemId | Equipment ID <br /> [Artifacts Data](https://gitlab.com/Dimbreath/AnimeGameData/-/blob/master/ExcelBinOutput/ReliquaryExcelConfigData.json) -> `"id"` <br /> [Weapons Data](https://gitlab.com/Dimbreath/AnimeGameData/-/blob/master/ExcelBinOutput/WeaponExcelConfigData.json) -> `"id"` |
162-
| [weapon](#weapon) `[Weapon Only]` | Weapon Base Info |
163-
| [reliquary](#reliquary) `[Artifact Only]` | Artifact Base Info |
164-
| [flat](#flat) | Detailed Info of Equipment |
165-
166-
#### weapon
167-
168-
For any additional info about weapons, check the [Weapons Data](https://gitlab.com/Dimbreath/AnimeGameData/-/blob/master/ExcelBinOutput/WeaponExcelConfigData.json)
169-
170-
| Name | Description |
171-
| :--- | :---------- |
172-
| level | Weapon Level |
173-
| promoteLevel | Weapon Ascension Level |
174-
| affixMap | Weapon Refinement Level `[0-4]` |
175-
176-
177-
#### reliquary
178-
179-
For any additional info about artifacts, check the [Artifacts Data](https://gitlab.com/Dimbreath/AnimeGameData/-/blob/master/ExcelBinOutput/ReliquaryExcelConfigData.json)
180-
181-
| Name | Description |
182-
| :--- | :---------- |
183-
| level | Artifact Level `[1-21]` |
184-
| mainPropId | Artifact Main Stat ID <br /> [MainProps Data](https://gitlab.com/Dimbreath/AnimeGameData/-/blob/master/ExcelBinOutput/ReliquaryMainPropExcelConfigData.json) |
185-
| appendPropIdList | List of IDs of the artifact substats <br /> [AppendProp Data](https://gitlab.com/Dimbreath/AnimeGameData/-/blob/master/ExcelBinOutput/ReliquaryAffixExcelConfigData.json) |
186-
187-
#### flat
188-
189-
| Name | Description |
190-
| :--- | :---------- |
191-
| nameTextHashMap | Hash for Equipment Name <br /> Check [Localizations](#localizations) |
192-
| setNameTextHashMap `[Artifact Only]`| Hash for Artifact Set Name <br /> Check [Localizations](#localizations)|
193-
| rankLevel | Rarity Level of Equipment |
194-
| [reliquaryMainstat](#reliquarymainstat-reliquarysubstats-weaponstats) `[Artifact Only]` | Artifact Main Stat |
195-
| [reliquarySubstats](#reliquarymainstat-reliquarysubstats-weaponstats) `[Artifact Only]` | List of Artifact Substats |
196-
| [weaponStats](#reliquarymainstat-reliquarysubstats-weaponstats) `[Weapon Only]`| List of Weapon Stat: Base ATK, Substat |
197-
| [itemType](#itemtype) | Equipment Type: Weapon or Artifact |
198-
| icon | Equipment Icon Name <br /> [Icon name usage](#icons-and-images)|
199-
| [equipType](#equiptype) `[Artifact Only]` | Artifact Type |
200-
201-
#### reliquaryMainstat, reliquarySubstats, weaponStats
202-
203-
| Name | Description |
204-
| :--- | :---------- |
205-
| mainPropId / appendPropID | Equipment Append Property Name. Check the [Definitions for Names](#appendprop)|
206-
| propValue | Property Value |
207-
208-
## Definitions
209-
210-
### Prop
211-
212-
| Type | Description |
213-
| :--: | :---------- |
214-
| 1001 | XP |
215-
| 1002 | Ascension |
216-
| 4001 | Level |
217-
218-
### FightProp
219-
220-
| Type | Description |
221-
| :--: |:--------------------------------------------------|
222-
| 1 | Base HP |
223-
| 2 | HP |
224-
| 3 | HP% |
225-
| 4 | Base ATK |
226-
| 5 | ATK |
227-
| 6 | ATK% |
228-
| 7 | Base DEF |
229-
| 8 | DEF |
230-
| 9 | DEF% |
231-
| 10 | Base SPD |
232-
| 11 | SPD% |
233-
| 20 | CRIT Rate |
234-
| 22 | CRIT DMG |
235-
| 23 | Energy Recharge |
236-
| 26 | Healing Bonus |
237-
| 27 | Incoming Healing Bonus |
238-
| 28 | Elemental Mastery |
239-
| 29 | Physical RES |
240-
| 30 | Physical DMG Bonus |
241-
| 40 | Pyro DMG Bonus |
242-
| 41 | Electro DMG Bonus |
243-
| 42 | Hydro DMG Bonus |
244-
| 43 | Dendro DMG Bonus |
245-
| 44 | Anemo DMG Bonus |
246-
| 45 | Geo DMG Bonus |
247-
| 46 | Cryo DMG Bonus |
248-
| 50 | Pyro RES |
249-
| 51 | Electro RES |
250-
| 52 | Hydro RES |
251-
| 53 | Dendro RES |
252-
| 54 | Anemo RES |
253-
| 55 | Geo RES |
254-
| 56 | Cryo RES |
255-
| 70 | Pyro Energy Cost |
256-
| 71 | Electro Energy Cost |
257-
| 72 | Hydro Energy Cost |
258-
| 73 | Dendro Energy Cost |
259-
| 74 | Anemo Energy Cost |
260-
| 75 | Cryo Energy Cost |
261-
| 76 | Geo Energy Cost |
262-
| 77 | Maximum Special Energy |
263-
| 78 | Special Energy Cost |
264-
| 80 | Cooldown reduction |
265-
| 81 | Shield Strength |
266-
| 1000 | Current Pyro Energy |
267-
| 1001 | Current Electro Energy |
268-
| 1002 | Current Hydro Energy |
269-
| 1003 | Current Dendro Energy |
270-
| 1004 | Current Anemo Energy |
271-
| 1005 | Current Cryo Energy |
272-
| 1006 | Current Geo Energy |
273-
| 1007 | Current Special Energy |
274-
| 1010 | Current HP |
275-
| 2000 | Max HP |
276-
| 2001 | ATK |
277-
| 2002 | DEF |
278-
| 2003 | SPD |
279-
| 3025 | Elemental reaction CRIT Rate |
280-
| 3026 | Elemental reaction CRIT DMG |
281-
| 3027 | Elemental reaction (Overloaded) CRIT Rate |
282-
| 3028 | Elemental reaction (Overloaded) CRIT DMG |
283-
| 3029 | Elemental reaction (Swirl) CRIT Rate |
284-
| 3030 | Elemental reaction (Swirl) CRIT DMG |
285-
| 3031 | Elemental reaction (Electro-Charged) CRIT Rate |
286-
| 3032 | Elemental reaction (Electro-Charged) CRIT DMG |
287-
| 3033 | Elemental reaction (Superconduct) CRIT Rate |
288-
| 3034 | Elemental reaction (Superconduct) CRIT DMG |
289-
| 3035 | Elemental reaction (Burn) CRIT Rate |
290-
| 3036 | Elemental reaction (Burn) CRIT DMG |
291-
| 3037 | Elemental reaction (Frozen (Shattered)) CRIT Rate |
292-
| 3038 | Elemental reaction (Frozen (Shattered)) CRIT DMG |
293-
| 3039 | Elemental reaction (Bloom) CRIT Rate |
294-
| 3040 | Elemental reaction (Bloom) CRIT DMG |
295-
| 3041 | Elemental reaction (Burgeon) CRIT Rate |
296-
| 3042 | Elemental reaction (Burgeon) CRIT DMG |
297-
| 3043 | Elemental reaction (Hyperbloom) CRIT Rate |
298-
| 3044 | Elemental reaction (Hyperbloom) CRIT DMG |
299-
| 3045 | Base Elemental reaction CRIT Rate |
300-
| 3046 | Base Elemental reaction CRIT DMG |
301-
302-
### ItemType
303-
304-
| Name | Description |
305-
| :--- | :---------- |
306-
| ITEM_WEAPON | Weapon |
307-
| ITEM_RELIQUARY | Artifact |
308-
309-
### EquipType
310-
311-
| Name | Description |
312-
| :--- | :---------- |
313-
| EQUIP_BRACER | Flower |
314-
| EQUIP_NECKLACE | Feather |
315-
| EQUIP_SHOES | Sands |
316-
| EQUIP_RING | Goblet |
317-
| EQUIP_DRESS | Circlet |
318-
319-
### AppendProp
320-
321-
| Name | Description |
322-
| :--- |:-------------------|
323-
| FIGHT_PROP_BASE_ATTACK `[Weapon]` | Base ATK |
324-
| FIGHT_PROP_HP | Flat HP |
325-
| FIGHT_PROP_ATTACK | Flat ATK |
326-
| FIGHT_PROP_DEFENSE | Flat DEF |
327-
| FIGHT_PROP_HP_PERCENT | HP% |
328-
| FIGHT_PROP_ATTACK_PERCENT | ATK% |
329-
| FIGHT_PROP_DEFENSE_PERCENT | DEF% |
330-
| FIGHT_PROP_CRITICAL | Crit RATE |
331-
| FIGHT_PROP_CRITICAL_HURT | Crit DMG |
332-
| FIGHT_PROP_CHARGE_EFFICIENCY | Energy Recharge |
333-
| FIGHT_PROP_HEAL_ADD | Healing Bonus |
334-
| FIGHT_PROP_ELEMENT_MASTERY | Elemental Mastery |
335-
| FIGHT_PROP_PHYSICAL_ADD_HURT | Physical DMG Bonus |
336-
| FIGHT_PROP_FIRE_ADD_HURT | Pyro DMG Bonus |
337-
| FIGHT_PROP_ELEC_ADD_HURT | Electro DMG Bonus |
338-
| FIGHT_PROP_WATER_ADD_HURT | Hydro DMG Bonus |
339-
| FIGHT_PROP_WIND_ADD_HURT | Anemo DMG Bonus |
340-
| FIGHT_PROP_ICE_ADD_HURT | Cryo DMG Bonus |
341-
| FIGHT_PROP_ROCK_ADD_HURT | Geo DMG Bonus |
342-
| FIGHT_PROP_GRASS_ADD_HURT | Dendro DMG Bonus |
343-
344-
## Icons and Images
345-
346-
You can get icons of characters, weapons and artifacts via Enka, by URL `https://enka.network/ui/[icon_name].png`.
347-
Usually icon name starts with `"UI_"` or `"Skill_"` for [characters talents](#characters-talents-and-consts).
348-
For example https://enka.network/ui/UI_AvatarIcon_Side_Ambor.png.
349-
350-
### Weapons and Artifacts
351-
352-
Go to [flat](#flat) and look for `icon`.
353-
354-
### Characters, Talents and Consts
355-
356-
Go to [store/characters.json](https://github.com/EnkaNetwork/API-docs/blob/master/store/characters.json) and look for anything related to "UI_XXXXXX" or "Skill_XXXXXX" by character ID.
357-
358-
## Localizations
359-
360-
You may notice `"NameTextMapHash"` in [store/characters.json](https://github.com/EnkaNetwork/API-docs/blob/master/store/characters.json), `"nameTextHashMap"` and `"setNameTextHashMap"` at [flat](#flat) that could be used as a key to get basic localization data of characters, weapons and artifacts from [store/loc.json](https://github.com/EnkaNetwork/API-docs/blob/master/store/loc.json).
361-
Also you can get localization data of [AppendProp](#appendprop) by using property name as a key - `"FIGHT_PROP_HP"`, `"FIGHT_PROP_HEAL_ADD"` etc.
362-
363-
For any additional info about names, descriptions and etc, check the [TextMap Data](https://gitlab.com/Dimbreath/AnimeGameData/-/tree/master/TextMap), only includes languages supported by game.
364-
365-
## Wrappers
366-
367-
TS/JS - https://www.npmjs.com/package/enkanetwork.js - [Jelosus1](https://github.com/Jelosus2)
368-
369-
TS/JS - https://github.com/yuko1101/enka-network-api - [yuko1101](https://github.com/yuko1101)
370-
371-
Rust - https://github.com/eratou/enkanetwork-rs - [eratou](https://github.com/eratou)
372-
373-
Python - https://github.com/mrwan200/enkanetwork.py - [mrwan200](https://github.com/mrwan200)
374-
375-
Python - https://github.com/seriaati/enka-py - [seriaati](https://github.com/seriaati)
376-
377-
Java - https://github.com/kazuryyx/EnkaNetworkAPI - [kazury](https://github.com/kazuryyx)

0 commit comments

Comments
 (0)