Sign in
basic

Find and get servant data

Search and return the list of matched servant entities.

  • name: servant name. Searching JP data using English name works too.
  • excludeCollectionNo: int, defaults to 0. Won't return records with the specified collectionNo.
  • type: servant type, defaults to [normal, heroine, enemyCollectionDetail]. See the NiceSvtType enum for the options.
  • flag: svt flag. See the NiceSvtFlag enum for the options.
  • rarity: rarity of the servant.
  • className: an item in the className enum, defaults to PLAYABLE_CLASS_LIST. See the className detail in the Nice Servant response.
  • gender: female, male or unknown.
  • attribute: human, sky, earth, star or beast.
  • trait: an integer or an item in the trait enum. See the traits detail in the Nice Servant response.
  • notTrait: an integer or an item in the trait enum. The result entities won't have any of the traits in the list.
  • voiceCondSvt: servant collectionNo or servant ID. Will find the servants that have voice lines directed to the given servants.
  • profileContains: string. Will search the servant's profile comments for the string.

At least one of name, type, rarity, className, gender, attribute, trait or voiceCondSvt is required for the query.

  • lang: returns English names if querying JP data. Doesn't do anything if querying NA data.
get/basic/{region}/servant/search

Path parameters

region'JP' | 'NA' | 'CN' | 'KR' | 'TW' required

Region Enum

Query parameters

lang'jp' | 'en'

Language Enum

namestring nullable
illustratorstring nullable
cvstring nullable
excludeCollectionNointeger[]
typeNiceSvtType[]
flagNiceSvtFlag[]
rarityinteger[]
classNameSvtClass[]
genderNiceGender[]
attributeAttribute[]
voiceCondSvtinteger[]
profileContainsstring nullable

Response

Basic Servant Entities

idinteger required
collectionNointeger required
namestring required
originalNamestring required
overwriteNamestring nullable
originalOverwriteNamestring nullable
type'normal' | 'heroine' | 'combineMaterial' | 'enemy' | 'enemyCollection' | 'servantEquip' | 'statusUp' | 'svtEquipMaterial' | 'enemyCollectionDetail' | 'all' | 'commandCode' | 'svtMaterialTd' required

Servant Type Enum

flag'onlyUseForNpc' | 'svtEquipFriendShip' | 'ignoreCombineLimitSpecial' | 'svtEquipExp' | 'svtEquipChocolate' | 'svtEquipManaExchange' | 'svtEquipCampaign' | 'svtEquipEvent' | 'svtEquipEventReward' | 'svtEquipRarityLevelNumMission' | 'normal' | 'goetia' | 'matDropRateUpCe' | 'unknown' required

Servant Flag Enum

flagsNiceSvtFlagOriginal[] required
classIdinteger required
attribute'none' | 'default' | 'human' | 'sky' | 'earth' | 'star' | 'beast' | 'void' required

Svt Attribute

rarityinteger required
atkMaxinteger required
hpMaxinteger required
facestring uri required
costumeobject required

Mapping <Costume BattleCharaID, Costume Detail>.

Changes

No recorded changes to this endpoint across all 1 revision of this API.