Getting Started Filtering & Sorting Narrow down lists and random draws with filters, search by name, and choose the order of results.
Filters Filters are query parameters. Combine as many as you like: an item must match all of them. Separate several values with commas to match any of them.
Pyro or Hydro characters with 5 stars Copy /api/v1/characters?element=pyro,hydro&rarity=5&limit=2 GET /api/v1/characters?element=pyro,hydro&rarity=5&limit=2 Copy {
" count " : 22 ,
" next " : " https://cdn.genshin-api.com/api/v1/characters?element=pyro%2Chydro&rarity=5&limit=2&offset=2 " ,
" previous " : null ,
" results " : [
{
" id " : 12 ,
" slug " : " mona " ,
" name " : " Mona " ,
" url " : " https://cdn.genshin-api.com/api/v1/characters/mona " ,
" rarity " : {
" id " : 5 ,
" slug " : " 5-star " ,
" name " : " 5-Star " ,
" url " : " https://cdn.genshin-api.com/api/v1/rarities/5-star " ,
" icon " : " https://cdn.genshin-api.com/rarities/5-star.webp "
},
" element " : {
" id " : 5 ,
" slug " : " hydro " ,
" name " : " Hydro " ,
" url " : " https://cdn.genshin-api.com/api/v1/elements/hydro " ,
" icon " : " https://cdn.genshin-api.com/elements/hydro.svg "
},
" weaponType " : {
" id " : 4 ,
" slug " : " catalyst " ,
" name " : " Catalyst " ,
" url " : " https://cdn.genshin-api.com/api/v1/weapon-types/catalyst " ,
" icon " : " https://cdn.genshin-api.com/weapon-types/catalyst.webp "
},
" region " : {
" id " : 1 ,
" slug " : " mondstadt " ,
" name " : " Mondstadt " ,
" url " : " https://cdn.genshin-api.com/api/v1/regions/mondstadt " ,
" icon " : " https://cdn.genshin-api.com/regions/mondstadt.webp "
},
" gender " : " female " ,
" icon " : " https://cdn.genshin-api.com/characters/mona/icon.png "
},
{
" id " : 13 ,
" slug " : " diluc " ,
" name " : " Diluc " ,
" url " : " https://cdn.genshin-api.com/api/v1/characters/diluc " ,
" rarity " : {
" id " : 5 ,
" slug " : " 5-star " ,
" name " : " 5-Star " ,
" url " : " https://cdn.genshin-api.com/api/v1/rarities/5-star " ,
" icon " : " https://cdn.genshin-api.com/rarities/5-star.webp "
},
" element " : {
" id " : 6 ,
" slug " : " pyro " ,
" name " : " Pyro " ,
" url " : " https://cdn.genshin-api.com/api/v1/elements/pyro " ,
" icon " : " https://cdn.genshin-api.com/elements/pyro.svg "
},
" weaponType " : {
" id " : 2 ,
" slug " : " claymore " ,
" name " : " Claymore " ,
" url " : " https://cdn.genshin-api.com/api/v1/weapon-types/claymore " ,
" icon " : " https://cdn.genshin-api.com/weapon-types/claymore.webp "
},
" region " : {
" id " : 1 ,
" slug " : " mondstadt " ,
" name " : " Mondstadt " ,
" url " : " https://cdn.genshin-api.com/api/v1/regions/mondstadt " ,
" icon " : " https://cdn.genshin-api.com/regions/mondstadt.webp "
},
" gender " : " male " ,
" icon " : " https://cdn.genshin-api.com/characters/diluc/icon.png "
}
]
} Values are matched by slug, so they are case and space insensitive:region=Liyue and region=liyue are equivalent.
Search by name Every list accepts name for a partial match. For example,?name=hu matches Hu Tao.
Available filters Parameter Description rarityRarity the set is available in, e.g. 5 or 5-star. Matches any of the set rarities typeArtifact type slug the set has a piece for, e.g. circlet-of-logos releaseVersionRelease version, e.g. 5.0 or luna-i
Parameter Description mainStatPossible main stat slug, e.g. crit-rate
Parameter Description setArtifact set slug typeArtifact type slug, e.g. circlet-of-logos rarityRarity stars (1-5) or rarity slug, e.g. 5 or 5-star
Parameter Description rarityRarity stars (4-5) or rarity slug, e.g. 5 or 5-star elementElement slug weaponTypeWeapon type slug regionRegion slug gendermale | female bodyTypeshort | medium | tall releaseVersionRelease version, e.g. 4.2 or luna-i localSpecialtyLocal specialty slug, e.g. silk-flower ascensionStatAscension stat slug, e.g. crit-dmg materialItem or item group slug used to ascend the character or level up talents, e.g. juvenile-jade or diligence-books
Parameter Description characterCharacter slug, e.g. hu-tao elementElement slug, e.g. pyro regionRegion slug of the character releaseVersionRelease version, e.g. 1.3 or luna-i
Parameter Description typeDomain type slug, e.g. domains-of-blessing regionRegion slug elementRecommended element slug, e.g. pyro rewardItem or artifact set slug the domain rewards, e.g. teachings-of-freedom or crimson-witch-of-flames releaseVersionRelease version, e.g. 1.0 or luna-i
Parameter Description typeEnemy type slug, e.g. elite-enemies familyEnemy family slug, e.g. hilichurls groupEnemy group slug, e.g. samachurls regionRegion slug (only bosses have a region) elementDamage element slug, e.g. cryo dropItem or artifact set slug the enemy drops, e.g. damaged-mask releaseVersionRelease version, e.g. 5.0 or luna-i
Parameter Description familyEnemy family slug
Parameter Description typeItem type slug sourcegeneral-enemy-drops | elite-enemy-drops | normal-boss-drops | weekly-boss-drops | boss-drops | domains-of-mastery | domains-of-forgery | gathering domainDomain slug
Parameter Description typeItem type slug sourcegeneral-enemy-drops | elite-enemy-drops | normal-boss-drops | weekly-boss-drops | boss-drops | domains-of-mastery | domains-of-forgery | gathering groupItem group slug, e.g. hilichurl-materials regionRegion slug, for local specialties rarityRarity stars (1-5) or rarity slug, e.g. 4 or 4-star releaseVersionRelease version, e.g. 5.0 or luna-i daysDay of the week the item can be farmed: monday | tuesday | wednesday | thursday | friday | saturday | sunday
Parameter Description categorybasic | advanced | hidden elementElement slug, for DMG Bonus and RES stats
Parameter Description rarityRarity stars (1-5) or rarity slug, e.g. 5 or 5-star weaponTypeWeapon type slug secondaryStatSecondary stat slug, e.g. crit-rate seriesWeapon series, e.g. favonius-series materialItem or item group slug used to ascend the weapon, e.g. aerosiderite or slime-concentrate releaseVersionRelease version, e.g. 1.3 or luna-i
Sorting Use sort with a field name. Prefix it with - for descending order. Every resource can be sorted by id (default) and name; some add more fields, listed on each resource page.
Newest characters first Copy /api/v1/characters?sort=-releaseDate Random with filters The /random endpoint accepts the same filters andname, which is handy for games and quizzes: