website·Indexed 30 days ago
https://enka-network-api.vercel.app/API documentation for Enka Network, featuring classes and interfaces for Genshin Impact data such as GenshinUser, ICharacter, IWeapon, and IArtifact. Includes the EnkaClient for managing user data, cache options, and utility functions for character and skill attribute resolution.
IGOOD interface defines the structure for item-related data in the API. It inherits from IGOODComponent and contains metadata about the source and version, as well as optional collections of game assets like artifacts, characters, materials, and weapons.interface IGOOD extends IGOODComponent {
format: GOOD;
source: string;
version: number;
artifacts?: IArtifact[];
characters?: ICharacter[];
materials?: Record<string, number>;
weapons?: IWeapon[];
}UniqueSkill class is a base class for character skills in the Enka Network API. It inherits from UpgradableSkill and is extended by ElementalSkill and ElementalBurst.ElementalSkill class inherits from UniqueSkill. It is used to represent and manage the elemental skill of a character, providing access to its metadata, cooldowns, and upgrade requirements.DetailedGenshinUser class extends GenshinUser and implements the IGOODComponentResolvable<IGOOD> interface. It is used to represent a detailed profile of a Genshin Impact user, providing access to achievements, characters, and profile settings.ElementalBurst class represents a character's burst skill. It inherits from the UniqueSkill class and provides access to skill properties such as cooldown, energy costs, and upgrade requirements.ArtifactSplitSubstat class extends StatProperty and is used to represent and manage individual artifact substats. It provides utilities for calculating values, handling percentage-based stats, and retrieving associated text assets via an EnkaClient.IArtifact interface extends IGOODComponent and represents an artifact object. It contains metadata about the artifact's level, rarity, location, and its statistical properties including main stats and substats.interface IArtifact extends IGOODComponent {
level: number;
location: string;
lock: boolean;
mainStatKey: StatKey;
rarity: number;
setKey: string;
slotKey: SlotKey;
substats: ISubstat[];
astralMark?: boolean;
elixirCrafted?: boolean;
totalRolls?: number;
unactivatedSubstats?: ISubstat[];
}DynamicTextAssets class is used for text assets containing placeholders. Use getReplacedText() to resolve these placeholders based on the user information provided in the EnkaClient configuration.const enka = new EnkaClient({
defaultLanguage: "en",
textAssetsDynamicData: {
userInfo: {
travelerGender: "FEMALE", // Lumine
travelerNickname: "nickname",
platform: "PC",
}
}
});
// Assuming dynamicTextAssets is an instance of DynamicTextAssets
// Original: "#Hello {M:Mr}{F:Ms}.{NICKNAME}. {LAYOUT_MOBILE#Tap}{LAYOUT_PC#Press}{LAYOUT_PS#Press} the button."
dynamicTextAssets.get();
// Returns the raw string with placeholders
dynamicTextAssets.getReplacedText();
// Returns: "Hello Ms.nickname. Press the button."
dynamicTextAssets.copyWithUserInfo({
travelerGender: "MALE", // Aether
travelerNickname: "Tom",
platform: "MOBILE",
}).getReplacedText();
// Returns: "Hello Mr.Tom. Tap the button."CharacterData class is used to manage and access character-specific information. It requires a data object and an instance of EnkaClient for initialization.const character = new CharacterData(data, enkaClient, optionalSkillDepotId);The CachedAssetsManager provides several methods to maintain the local game data cache:
checkForUpdates(): Checks if the local cache needs updating.updateContents(): Updates the cache contents.fetchAllContents(): Ensures all required contents are downloaded.refreshAllData(): Refreshes all cached data.cacheDirectorySetup(): Sets up the directory for the cache.enka-network-api package using npm. Node.js 16 or newer is required. You can choose to install with or without the Genshin cache data, or use a proxy for the cache download.# Standard installation including cache data
npm install enka-network-api@latest
# Install using ghproxy.com for cache data
npm install enka-network-api@latest --enka-ghproxy=true
# Install without downloading the cache (use if cache is already moved to another folder)
npm install enka-network-api@latest --enka-nocache=true