Sign in
basic

Find and get function data

Search and return the list of matched buffs.

  • popupText: string.
  • type: an item of NiceFuncType.
  • targetType: an item of NiceFuncTargetType.
  • targetTeam: player, enemy or playerAndEnemy.
  • vals: an integer or a trait enum. Note that trait enums will be converted to integers before searching so the search might return vals with buffs that have the same ids.
  • tvals: an integer or a trait enum.
  • questTvals: integer.
  • funcIndividuality: an integer or a trait enum.

At least one of the parameter is required for the query.

  • reverse: Reverse lookup the skills that have this function and return the reversed skill objects.
  • reverseDepth: Controls the depth of the reverse lookup: func -> skill/np -> servant.
  • lang: returns English servant names if querying JP data. Doesn't do anything if querying NA data.
get/basic/{region}/function/search

Path parameters

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

Region Enum

Query parameters

reverseboolean
reverseDepth'function' | 'skillNp' | 'servant'

Reverse Data Depth

popupTextstring nullable
typeNiceFuncType[]
targetTypeNiceFuncTargetType[]
targetTeamFuncApplyTarget[]
lang'jp' | 'en'

Language Enum

Response

Function entity

funcIdinteger required
funcType'none' | 'addState' | 'subState' | 'damage' | 'damageNp' | 'gainStar' | 'gainHp' | 'gainNp' | 'lossNp' | 'shortenSkill' | 'extendSkill' | 'releaseState' | 'lossHp' | 'instantDeath' | 'damageNpPierce' | 'damageNpIndividual' | 'addStateShort' | 'gainHpPer' | 'damageNpStateIndividual' | 'hastenNpturn' | 'delayNpturn' | 'damageNpHpratioHigh' | 'damageNpHpratioLow' | 'cardReset' | 'replaceMember' | 'lossHpSafe' | 'damageNpCounter' | 'damageNpStateIndividualFix' | 'damageNpSafe' | 'callServant' | 'ptShuffle' | 'lossStar' | 'changeServant' | 'changeBg' | 'damageValue' | 'withdraw' | 'fixCommandcard' | 'shortenBuffturn' | 'extendBuffturn' | 'shortenBuffcount' | 'extendBuffcount' | 'changeBgm' | 'displayBuffstring' | 'resurrection' | 'gainNpBuffIndividualSum' | 'setSystemAliveFlag' | 'forceInstantDeath' | 'damageNpRare' | 'gainNpFromTargets' | 'gainHpFromTargets' | 'lossHpPer' | 'lossHpPerSafe' | 'shortenUserEquipSkill' | 'quickChangeBg' | 'shiftServant' | 'damageNpAndOrCheckIndividuality' | 'absorbNpturn' | 'overwriteDeadType' | 'forceAllBuffNoact' | 'breakGaugeUp' | 'breakGaugeDown' | 'moveToLastSubmember' | 'extendUserEquipSkill' | 'updateEnemyEntryMaxCountEachTurn' | 'expUp' | 'qpUp' | 'dropUp' | 'friendPointUp' | 'eventDropUp' | 'eventDropRateUp' | 'eventPointUp' | 'eventPointRateUp' | 'transformServant' | 'qpDropUp' | 'servantFriendshipUp' | 'userEquipExpUp' | 'classDropUp' | 'enemyEncountCopyRateUp' | 'enemyEncountRateUp' | 'enemyProbDown' | 'getRewardGift' | 'sendSupportFriendPoint' | 'movePosition' | 'revival' | 'damageNpIndividualSum' | 'damageValueSafe' | 'friendPointUpDuplicate' | 'moveState' | 'changeBgmCostume' | 'lossCommandSpell' | 'gainCommandSpell' | 'updateEntryPositions' | 'buddyPointUp' | 'addFieldChangeToField' | 'subFieldBuff' | 'eventFortificationPointUp' | 'gainNpIndividualSum' | 'setQuestRouteFlag' | 'lastUsePlayerSkillCopy' | 'changeEnemyMasterFace' | 'damageValueSafeOnce' | 'addBattleValue' | 'setBattleValue' | 'gainMultiplyNp' | 'lossMultiplyNp' | 'addBattlePoint' | 'damageNpBattlePointPhase' | 'setNpExecutedState' | 'hideOverGauge' | 'gainNpTargetSum' | 'enemyCountChange' | 'displayBattleMessage' | 'generateBattleSkillDrop' | 'changeMasterFace' | 'enableMasterSkill' | 'enableMasterCommandSpell' | 'battleModelChange' | 'gainNpCriticalstarSum' | 'addBattleMissionValue' | 'setBattleMissionValue' | 'changeEnemyStatusUiType' | 'swapFieldPosition' | 'setDisplayDirectBattleMessageInFsm' | 'addStateToField' | 'addStateShortToField' | 'gainNpFromOtherUsedNpValue' | 'hastenNpturnFromOtherUsedNpturn' | 'damageFuncType164' | 'damageFuncType165' | 'subBattlePoint' | 'setBattleMissionValueAsMax' | 'addStateUserEquipSkillAvailable' | 'addStateShortUserEquipSkillAvailable' required

Function Type Enum

funcTargetType'self' | 'ptOne' | 'ptAnother' | 'ptAll' | 'enemy' | 'enemyAnother' | 'enemyAll' | 'ptFull' | 'enemyFull' | 'ptOther' | 'ptOneOther' | 'ptRandom' | 'enemyOther' | 'enemyRandom' | 'ptOtherFull' | 'enemyOtherFull' | 'ptselectOneSub' | 'ptselectSub' | 'ptOneAnotherRandom' | 'ptSelfAnotherRandom' | 'enemyOneAnotherRandom' | 'ptSelfAnotherFirst' | 'ptSelfBefore' | 'ptSelfAfter' | 'ptSelfAnotherLast' | 'commandTypeSelfTreasureDevice' | 'fieldOther' | 'enemyOneNoTargetNoAction' | 'ptOneHpLowestValue' | 'ptOneHpLowestRate' | 'enemyRange' | 'handCommandcardRandomOne' | 'fieldAll' | 'noTarget' | 'fieldRandom' | 'playerAttackPreselectTargetPtOne' required

Function Target Type Enum

funcTargetTeam'player' | 'enemy' | 'playerAndEnemy' required

Function Target Team Enum

funcPopupTextstring required

Changes

Changed in 1 of the 3 revisions of this API.224

  • 564e53338c76224See the full diff
    • ▲

      removed the enum value addStateFuncType169 from the property items/ of the query request parameter type

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value addStateFuncType170 from the property items/ of the query request parameter type

      request-parameter-property-enum-value-removed

    • ●

      added the new addStateShortUserEquipSkillAvailable enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new addStateUserEquipSkillAvailable enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value addStateShortUserEquipSkillAvailable to the property items/ of the query request parameter type

      request-parameter-property-enum-value-added

    • ○

      added the enum value addStateUserEquipSkillAvailable to the property items/ of the query request parameter type

      request-parameter-property-enum-value-added

    • ○

      removed the addStateFuncType169 enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the addStateFuncType170 enum value from the / response property for the response status

      response-property-enum-value-removed

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.