Flyff logo
API docs by Redocly

Flyff Universe API (1.5.2)

Download OpenAPI specification:Download

Gala Lab: ir@gala.kr URL: http://galalab.kr/

Welcome to Flyff Universe Public API!

The API is still in development and specifications can change as well as the main URL.

Check Flyff Official Fansite Kit for high-quality 2D assets.

Contact the developers by mail or on the official Discord if you have questions, suggestions, or a bug to report.

Copyright 2021-2024 © Gala Lab Corp. All Rights Reserved.

Permission to use the data and images granted only for information sites and tools about the official game. Gala Lab reserves the right to no longer grant this permission at any time. Commercial use strictly prohibited. Use for in-game automation and cheating tools, or use in any other video game is strictly prohibited. Please contact the developers if you wish to verify that your use of this API is in accordance with the copyright.


Gala Lab Logo

Introduction

Currently limited to 300 calls per minute per IP. No size limitation on the request and the response.

Feel free to cache the results and fetch the data only when the data version changes.

Version History:

  • 1.4.1 - 2023/03/11 - Data update, updated documentation.
  • 2023/03/17 - Data update.
  • 2023/05/13 - Data update.
  • 1.4.2 - 2023/06/29 - Data update, updated documentation for NPC menus enum.
  • 1.4.3 - 2023/07/06 - Data update, updated documentation for item subcategories.
  • 1.5.0 - 2023/11/08 - Data update and API update for New Horizon expansion.
  • 1.5.1 - 2023/11/08 - Data update and API update adding possibleRandomStats on items.
  • 2023/11/28 - Data update.
  • 1.5.2 - 2024/02/15 - Data update and new housing routes.
  • 2024/02/17 - Data update.
  • 2024/03/15 - Data update.

Version

Get the version of the game data

Returns an unique ID representing the current version of the static game data

Responses

Response samples

Content type
application/json
1

Get the version of the game API

Returns the current version of the game API

Responses

Response samples

Content type
application/json
"1.2.0"

Class

id
required
integer

ID of the class

name
required
object (LocalizedText)

Text available in several languages

type
required
string
Enum: "beginner" "expert" "professional"

Type of the class

icon
required
string

Icon of the Class

minLevel
required
integer

Minimum player level for the Class

maxLevel
required
integer

Maximum player level for the Class

parent
integer

ID of the parent class

maxHP
required
string

Formula to compute the maximum Hit Points of the player

maxFP
required
string

Formula to compute the maximum Fatigue Points of the player

maxMP
required
string

Formula to compute the maximum Mana Points of the player

attackSpeed
required
float

Attack speed constant used in attack speed calculation

block
required
float

Blocking constant used in block calculation

critical
required
float

Critical chance constant used in critical chance calculation

required
object

Auto attack damage factors used in damage calculation

{
  • "id": 9686,
  • "name": {
    },
  • "type": "beginner",
  • "icon": "vagrant.png",
  • "minLevel": 1,
  • "maxLevel": 15,
  • "parent": 764,
  • "maxHP": "150+level*18+sta*level*0.18",
  • "maxFP": "level*0.6+sta*2.1",
  • "maxMP": "22+level*0.6+int*2.7",
  • "attackSpeed": 72,
  • "block": 0.2,
  • "critical": 1,
  • "autoAttackFactors": {
    }
}

Get all classes IDs

Returns an array containing the ID of all available classes

Responses

Response samples

Content type
application/json
[
  • 1689,
  • 296,
  • 2881
]

Find class by ID

Returns a single class

path Parameters
classId
required
integer
Example: 1689

ID of class to return

Responses

Response samples

Content type
application/json
{
  • "id": 9686,
  • "name": {
    },
  • "type": "beginner",
  • "icon": "vagrant.png",
  • "minLevel": 1,
  • "maxLevel": 15,
  • "parent": 764,
  • "maxHP": "150+level*18+sta*level*0.18",
  • "maxFP": "level*0.6+sta*2.1",
  • "maxMP": "22+level*0.6+int*2.7",
  • "attackSpeed": 72,
  • "block": 0.2,
  • "critical": 1,
  • "autoAttackFactors": {
    }
}

Find classes by a list of IDs

Returns an array with classes

path Parameters
classIds
required
any
Example: 1689,296,2881

IDs of classes to return separated by comma ,

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get class icon

Returns icon for the specified file name

path Parameters
style
required
any
Example: messenger

Style of the icon. Accepted values: messenger, old_female, old_male, target.

fileName
required
any
Example: vagrant.png

File name of the icon

Responses

World

id
required
integer

ID of the World

name
required
object (LocalizedText)

Text available in several languages

type
required
string
Enum: "main" "prison" "dungeon" "instance" "event"

Type of the World

width
required
integer

Width of the World in meters

height
required
integer

Height of the World in meters

tileName
required
string

Name of the world Tiles for navigator

tileSize
required
integer

World meters per Tile

flying
required
boolean

Whether players can fly in the World or not

pk
required
boolean

Whether players can kill other players in the World or not

inDoor
required
boolean

Whether the World has a sky or not

revivalWorld
integer

ID of the World where players revive when they die in the World

revivalKey
string

ID of the Lodestar where players revive when they die in the World

required
Array of objects

Special Places in the World

required
Array of objects

Revival places in the World

required
Array of objects

Continents in the World

{
  • "id": 6063,
  • "name": {
    },
  • "type": "dungeon",
  • "width": 10752,
  • "height": 5632,
  • "tileName": "wdmadrigal",
  • "tileSize": 512,
  • "flying": true,
  • "pk": true,
  • "inDoor": false,
  • "revivalWorld": 6063,
  • "revivalKey": "flaris",
  • "places": [
    ],
  • "lodestars": [
    ],
  • "continents": [
    ]
}

Get all worlds IDs

Returns an array containing the ID of all available worlds

Responses

Response samples

Content type
application/json
[
  • 4015,
  • 4839,
  • 6063
]

Find world by ID

Returns a single world

path Parameters
worldId
required
integer
Example: 4015

ID of world to return

Responses

Response samples

Content type
application/json
{
  • "id": 6063,
  • "name": {
    },
  • "type": "dungeon",
  • "width": 10752,
  • "height": 5632,
  • "tileName": "wdmadrigal",
  • "tileSize": 512,
  • "flying": true,
  • "pk": true,
  • "inDoor": false,
  • "revivalWorld": 6063,
  • "revivalKey": "flaris",
  • "places": [
    ],
  • "lodestars": [
    ],
  • "continents": [
    ]
}

Find worlds by a list of IDs

Returns an array with worlds

path Parameters
worldIds
required
any
Example: 4015,4839,6063

IDs of worlds to return separated by comma ,

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get world tile

Returns tile for the specified world and position

path Parameters
worldTileName
required
any
Example: wdmadrigal

Tile name of the world

tileX
required
any

X position of the tile

tileY
required
any

Y position of the tile

Responses

Monster

id
required
integer

ID of the Monster

name
required
object (LocalizedText)

Text available in several languages

event
required
boolean

Whether the monster is an event monster or not

levelHidden
required
boolean

Whether the monster's level is hidden or not

level
required
integer

Level of the Monster

rank
required
string
Enum: "small" "normal" "captain" "giant" "violet" "boss" "material" "super" "guard" "citizen" "worldboss"

Rank of the Monster

area
required
string
Enum: "normal" "dungeon"

Type of area where the Monster spawns

element
required
string (Element)
Enum: "fire" "water" "electricity" "wind" "earth" "none"

Natural element

icon
required
string

Icon of the Monster

booty
integer

ID of the booty Item dropped by the Monster

mineral
integer

ID of the mineral Item collected on the Catcher Monster

flying
required
boolean

Whether the Monster is flying or not

hp
required
integer

Hit Points of the Monster

mp
required
integer

Mana Points of the Monster

minAttack
required
integer

Minimum Attack of the Monster

maxAttack
required
integer

Maximum Attack of the Monster

defense
required
integer

Defense of the Monster

magicDefense
required
integer

Magic Defense of the Monster

sta
required
integer

Stamina of the Monster

str
required
integer

Strength of the Monster

dex
required
integer

Dexterity of the Monster

int
required
integer

Intelligence of the Monster

hitRate
required
integer

Ability of the Monster to inflict a successful hit to its target

parry
required
integer

Ability of the Monster to receive a Miss from its attacker. This value is equivalent to lowering the attacker's hitRate

runaway
required
boolean

Whether the Monster can run away when its Hit Points are low or not

resistFire
required
number

The monster's resistance to this element

resistWater
required
number

The monster's resistance to this element

resistWind
required
number

The monster's resistance to this element

resistEarth
required
number

The monster's resistance to this element

resistElectricity
required
number

The monster's resistance to this element

summoned
Array of integers

List of Monsters which can be summoned by the Monster

Array of objects

List of possible apply-on-hit skills

Array of objects

List of monsters this monster avenges

berserkThresholdHP
integer

Threshold in % of Hit Points to activate the Monster's berserk mode

berserkAttackPower
integer

Attack Power bonus in % when Monster's berserk mode is active

recoveryThresholdHP
integer

Threshold in % of Hit Points to recover the Monster's Hit Points

recoveryAmountHP
integer

Amount of Hit Points in % recovered when the threshold is reached

speed
required
integer

Speed of the Monster

experience
required
number

Amount of experience in % given to the player killing the Monster at the same level

experienceSharing
required
string
Enum: "normal" "area"

How the experience is distributed to the players

  • normal Experience is shared by amount of Damage done to the Monster and among Party members if there is a Party
  • area Experience is shared between all players in the area
experienceTable
required
Array of numbers

Amount of experience in % given to the player killing the Monster alone on a specific level

minDropGold
required
integer

Minimum amount of Penya dropped by the Monster

maxDropGold
required
integer

Maximum amount of Penya dropped by the Monster

required
Array of objects

Weapons used by the Monster to attack

required
Array of objects

List of items dropped by the Monster

object (Location)
required
Array of objects (Spawn)

Locations where the monster spawns

{
  • "id": 5745,
  • "name": {
    },
  • "event": false,
  • "levelHidden": false,
  • "level": 1,
  • "rank": "small",
  • "area": "normal",
  • "element": "fire",
  • "icon": "aibatt.png",
  • "booty": 7635,
  • "mineral": 7479,
  • "flying": false,
  • "hp": 120,
  • "mp": 100,
  • "minAttack": 15,
  • "maxAttack": 16,
  • "defense": 3,
  • "magicDefense": 1,
  • "sta": 20,
  • "str": 15,
  • "dex": 15,
  • "int": 15,
  • "hitRate": 40,
  • "parry": 3,
  • "runaway": true,
  • "resistFire": 0.3,
  • "resistWater": 0.3,
  • "resistWind": 0.3,
  • "resistEarth": 0.3,
  • "resistElectricity": 0.3,
  • "summoned": [
    ],
  • "appliedSkills": [
    ],
  • "avenge": [
    ],
  • "berserkThresholdHP": 30,
  • "berserkAttackPower": 80,
  • "recoveryThresholdHP": 5,
  • "recoveryAmountHP": 20,
  • "speed": 75,
  • "experience": 14.5,
  • "experienceSharing": "normal",
  • "experienceTable": [
    ],
  • "minDropGold": 10,
  • "maxDropGold": 40,
  • "attacks": [
    ],
  • "drops": [
    ],
  • "location": {
    },
  • "spawns": [
    ]
}

Get all monsters IDs

Returns an array containing the ID of all available monsters

Responses

Response samples

Content type
application/json
[
  • 5858,
  • 26,
  • 6047
]

Find monster by ID

Returns a single monster

path Parameters
monsterId
required
integer
Example: 26

ID of monster to return

Responses

Response samples

Content type
application/json
{
  • "id": 5745,
  • "name": {
    },
  • "event": false,
  • "levelHidden": false,
  • "level": 1,
  • "rank": "small",
  • "area": "normal",
  • "element": "fire",
  • "icon": "aibatt.png",
  • "booty": 7635,
  • "mineral": 7479,
  • "flying": false,
  • "hp": 120,
  • "mp": 100,
  • "minAttack": 15,
  • "maxAttack": 16,
  • "defense": 3,
  • "magicDefense": 1,
  • "sta": 20,
  • "str": 15,
  • "dex": 15,
  • "int": 15,
  • "hitRate": 40,
  • "parry": 3,
  • "runaway": true,
  • "resistFire": 0.3,
  • "resistWater": 0.3,
  • "resistWind": 0.3,
  • "resistEarth": 0.3,
  • "resistElectricity": 0.3,
  • "summoned": [
    ],
  • "appliedSkills": [
    ],
  • "avenge": [
    ],
  • "berserkThresholdHP": 30,
  • "berserkAttackPower": 80,
  • "recoveryThresholdHP": 5,
  • "recoveryAmountHP": 20,
  • "speed": 75,
  • "experience": 14.5,
  • "experienceSharing": "normal",
  • "experienceTable": [
    ],
  • "minDropGold": 10,
  • "maxDropGold": 40,
  • "attacks": [
    ],
  • "drops": [
    ],
  • "location": {
    },
  • "spawns": [
    ]
}

Find monsters by a list of IDs

Returns an array with monsters

path Parameters
monsterIds
required
any
Example: 5858,26,6047

IDs of monsters to return separated by comma ,

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get monster icon

Returns icon for the specified file name

path Parameters
fileName
required
any
Example: aibatt.png

File name of the icon

Responses

Item

id
required
integer

ID of the Item

name
required
object (LocalizedText)

Text available in several languages

description
required
object (LocalizedText)

Text available in several languages

icon
required
string

Icon of the Item

category
required
string
Enum: "weapon" "armor" "fashion" "jewelry" "flying" "collector" "quest" "trans" "fuel" "booty" "arrow" "charm" "recovery" "blinkwing" "firework" "pickuppet" "teleportring" "material" "buff" "monsterball" "pack" "scroll" "vendorskin" "raisedpet" "currency"

Category of the Item

subcategory
string
Enum: "armorcolor" "axe" "balloon" "board" "book" "boots" "bow" "broom" "car" "cloak" "cloth" "drink" "earring" "elementcard" "event" "food" "gauntlet" "glove" "glow" "hat" "helmet" "inventorybag" "knuckle" "letter" "mask" "mineral" "necklace" "petfeed" "piercingcard" "piercingdice" "pill" "protectscroll" "randomscroll" "refresher" "ring" "shield" "shoes" "specialstone" "staff" "stick" "suit" "sword" "townblinkwing" "trans" "upgradedice" "wand" "wings" "yoyo" "gacha" "globalgacha" "giftbox" "ampexp" "upgradescroll" "awakescroll" "visualcloak" "gem" "piece" "ultimatedice" "selectblinkwing" "selectbox" "hoverbike" "guildbag" "raisedpet" "raisedpettransmute" "harvestglove" "battlepass" "pkchip" "namecolor" "ticket" "fcoin" "rockpaperscissors" "sunstone" "rainbowrace"

Sub category of the Item when there is one

rarity
required
string
Enum: "common" "uncommon" "rare" "veryrare" "unique"

Rarity of the Item

class
integer

ID of the Class required to equip or use the Item

level
required
integer

Player level required to equip or use the Item

sex
string
Enum: "male" "female"

Player sex required to equip or use the Item

stack
required
integer

Number of units that can be stacked

buyPrice
integer

Purchase price of the Item at NPC

sellPrice
required
integer

Selling price of the Item at NPC

consumable
required
boolean

Whether the Item is a consumable or not

premium
required
boolean

Whether the Item is considered as premium or not

deletable
required
boolean

Whether the Item can be deleted or not

tradable
required
boolean

Whether the Item can be traded or not

shining
required
boolean

Whether the 3D Model of the Item has a shining effect or not

element
required
string (Element)
Enum: "fire" "water" "electricity" "wind" "earth" "none"

Natural element

durationRealTime
required
boolean

Whether the Buff duration is counted even when the player is offline or not

transy
integer

ID of the Male/Female counterpart Item when it is an armor

Array of objects

List of dismantling output from this item

Array of objects

Upgrade level information if the item is an accessory

cooldown
number

Time in Seconds to use the Item again

casting
number

Time in Seconds to equip or use the Item

duration
number

Duration in Seconds of the Buff

flightSpeed
integer

Flying Speed in km/h when the Item is a flying vehicle

guildContribution
integer

Amount of Guild contribution experience given when the Item is a Booty

attackSpeed
string
Enum: "veryslow" "slow" "normal" "fast" "veryfast" "fastest"

Attack Speed when the Item is a weapon

attackSpeedValue
number

Exact Attack Speed value when the Item is a weapon

attackRange
integer

Maximum distance in meters to hit the target when the Item is a weapon

twoHanded
boolean

Whether the item is two handed or not when the Item is a weapon

minAttack
integer

Minimum Attack when the Item is a weapon

maxAttack
integer

Maximum Attack when the Item is a weapon

additionalSkillDamage
integer

Additional Damage when using a Skill with the weapon

ultimateConvertible
boolean

Whether or not this item can be converted to ultimate

Array of objects (Ability)

The possible additional stats to roll, if any

consumedMP
integer

Consumed Mana Points when doing a Charged Attack with the wand

consumedItem
string

Category of the Item consumed when attacking with the weapon

triggerSkill
integer

ID of the Skill that can be triggered when using the Item

triggerSkillProbability
integer

Probability in % to trigger the Skill when using the Item

minDefense
integer

Minimum Defense when the Item is an armor

maxDefense
integer

Maximum Defense when the Item is an armor

object (Location)
Array of objects (Ability)

Special Abilities applied to the player when wearing or using the Item

object (Location)
required
Array of objects (Spawn)

Locations where the item drops directly on the ground

{
  • "id": 7635,
  • "name": {
    },
  • "description": {
    },
  • "icon": "gengemgem.png",
  • "category": "weapon",
  • "subcategory": "sword",
  • "rarity": "common",
  • "class": 9686,
  • "level": 1,
  • "sex": "male",
  • "stack": 999,
  • "buyPrice": 12,
  • "sellPrice": 3,
  • "consumable": true,
  • "premium": false,
  • "deletable": true,
  • "tradable": true,
  • "shining": false,
  • "element": "fire",
  • "durationRealTime": false,
  • "transy": 2410,
  • "dismantle": [
    ],
  • "upgradeLevels": [
    ],
  • "cooldown": 1.5,
  • "casting": 2.5,
  • "duration": 6,
  • "flightSpeed": 54,
  • "guildContribution": 14,
  • "attackSpeed": "normal",
  • "attackSpeedValue": 0.085,
  • "attackRange": 2,
  • "twoHanded": false,
  • "minAttack": 3,
  • "maxAttack": 4,
  • "additionalSkillDamage": 6,
  • "ultimateConvertible": true,
  • "possibleRandomStats": [
    ],
  • "consumedMP": 15,
  • "consumedItem": "arrow",
  • "triggerSkill": 3124,
  • "triggerSkillProbability": 25,
  • "minDefense": 110,
  • "maxDefense": 113,
  • "blinkwingTarget": {
    },
  • "abilities": [
    ],
  • "location": {
    },
  • "spawns": [
    ]
}

Get all items IDs

Returns an array containing the ID of all available items

Responses

Response samples

Content type
application/json
[
  • 4015,
  • 4839,
  • 6063
]

Find item by ID

Returns a single item

path Parameters
itemId
required
integer
Example: 7635

ID of item to return

Responses

Response samples

Content type
application/json
{
  • "id": 7635,
  • "name": {
    },
  • "description": {
    },
  • "icon": "gengemgem.png",
  • "category": "weapon",
  • "subcategory": "sword",
  • "rarity": "common",
  • "class": 9686,
  • "level": 1,
  • "sex": "male",
  • "stack": 999,
  • "buyPrice": 12,
  • "sellPrice": 3,
  • "consumable": true,
  • "premium": false,
  • "deletable": true,
  • "tradable": true,
  • "shining": false,
  • "element": "fire",
  • "durationRealTime": false,
  • "transy": 2410,
  • "dismantle": [
    ],
  • "upgradeLevels": [
    ],
  • "cooldown": 1.5,
  • "casting": 2.5,
  • "duration": 6,
  • "flightSpeed": 54,
  • "guildContribution": 14,
  • "attackSpeed": "normal",
  • "attackSpeedValue": 0.085,
  • "attackRange": 2,
  • "twoHanded": false,
  • "minAttack": 3,
  • "maxAttack": 4,
  • "additionalSkillDamage": 6,
  • "ultimateConvertible": true,
  • "possibleRandomStats": [
    ],
  • "consumedMP": 15,
  • "consumedItem": "arrow",
  • "triggerSkill": 3124,
  • "triggerSkillProbability": 25,
  • "minDefense": 110,
  • "maxDefense": 113,
  • "blinkwingTarget": {
    },
  • "abilities": [
    ],
  • "location": {
    },
  • "spawns": [
    ]
}

Find items by a list of IDs

Returns an array with items

path Parameters
itemIds
required
any
Example: 7635,9814,3070

IDs of items to return separated by comma ,

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get item icon

Returns icon for the specified file name

path Parameters
fileName
required
any
Example: weaswonormal.png

File name of the icon

Responses

Equipment Set

id
required
integer

ID of the Equipment Set

name
required
object (LocalizedText)

Text available in several languages

transy
required
integer

ID of the Male/Female counterpart EquipSet

parts
required
Array of integers

Items included in the Set

required
Array of objects

Special Abilities when the player wears several parts of the Set

{
  • "id": 4364,
  • "name": {
    },
  • "transy": 222,
  • "parts": [
    ],
  • "bonus": [
    ]
}

Get all equipment set IDs

Returns an array containing the ID of all available equipment sets

Responses

Response samples

Content type
application/json
[
  • 5670,
  • 4267,
  • 5303
]

Find equipment set by ID

Returns a single equipment set

path Parameters
equipSetId
required
integer
Example: 5670

ID of equipment set to return

Responses

Response samples

Content type
application/json
{
  • "id": 4364,
  • "name": {
    },
  • "transy": 222,
  • "parts": [
    ],
  • "bonus": [
    ]
}

Find equipment sets by a list of IDs

Returns an array with equipment sets

path Parameters
equipSetIds
required
any
Example: 5670,4267,5303

IDs of equipment sets to return separated by comma ,

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Skill

id
required
integer

ID of the Skill

name
required
object (LocalizedText)

Text available in several languages

description
required
object (LocalizedText)

Text available in several languages

icon
required
string

Icon of the Skill

class
integer

ID of the Class required to use the Skill

level
required
integer

Player level required to use the Skill

element
required
string (Element)
Enum: "fire" "water" "electricity" "wind" "earth" "none"

Natural element

Array of objects (Ability)

Special Abilities applied to the target when using the Skill

magic
required
boolean

Whether the Skill is Magic or not

target
required
string
Enum: "party" "line" "area" "single" "currentplayer"

Target of the Skill

combo
required
string
Enum: "general" "step" "circle" "finish"

Where the Skill can be placed in the Action Slot

debuff
required
boolean

Whether the Skill is used to attack/debuff the target or not

flying
required
boolean

Whether the Skill can be used while flying or not

passive
required
boolean

Whether the Skill is automatically used or not

consumedItem
string

Category of the Item consumed when using the Skill

triggerSkill
integer

ID of the Skill that can be triggered when using the Skill

skillPoints
integer

Number of Skill Points consumed by Skill Level

weapon
string

Sub category of the Weapon required to use the Skill

required
Array of objects

Required previous Skills

required
Array of objects

Levels of the Skill

{
  • "id": 6482,
  • "name": {
    },
  • "description": {
    },
  • "icon": "acrsupyoymaster.png",
  • "class": 9686,
  • "level": 1,
  • "element": "fire",
  • "abilities": [
    ],
  • "magic": true,
  • "target": "single",
  • "combo": "general",
  • "debuff": true,
  • "flying": true,
  • "passive": false,
  • "consumedItem": "arrow",
  • "triggerSkill": 1143,
  • "skillPoints": 1,
  • "weapon": "sword",
  • "requirements": [
    ],
  • "levels": [
    ]
}

Get all skills IDs

Returns an array containing the ID of all available skills

Responses

Response samples

Content type
application/json
[
  • 6482,
  • 2030,
  • 7395
]

Find skill by ID

Returns a single skill

path Parameters
skillId
required
integer
Example: 6482

ID of skill to return

Responses

Response samples

Content type
application/json
{
  • "id": 6482,
  • "name": {
    },
  • "description": {
    },
  • "icon": "acrsupyoymaster.png",
  • "class": 9686,
  • "level": 1,
  • "element": "fire",
  • "abilities": [
    ],
  • "magic": true,
  • "target": "single",
  • "combo": "general",
  • "debuff": true,
  • "flying": true,
  • "passive": false,
  • "consumedItem": "arrow",
  • "triggerSkill": 1143,
  • "skillPoints": 1,
  • "weapon": "sword",
  • "requirements": [
    ],
  • "levels": [
    ]
}

Find skills by a list of IDs

Returns an array with skills

path Parameters
skillIds
required
any
Example: 6482,2030,7395

IDs of skills to return separated by comma ,

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get skill icon

Returns icon for the specified file name

path Parameters
style
required
any
Example: colored

Style of the icon. Accepted values: colored, old.

fileName
required
any
Example: acrbowaimeds.png

File name of the icon

Responses

Party Skill

id
required
integer

ID of the Party Skill

name
required
object (LocalizedText)

Text available in several languages

description
required
object (LocalizedText)

Text available in several languages

icon
required
string

Icon of the Party Skill

level
required
integer

Party level required to use the Party Skill

consumedPoints
integer

Consumed Party Points when using the Party Skill

duration
number

Duration in Seconds of the Party Skill when it is a Buff

{
  • "id": 8037,
  • "name": {
    },
  • "description": {
    },
  • "icon": "trocall.png",
  • "level": 10,
  • "consumedPoints": 1,
  • "duration": 60
}

Get all party skills IDs

Returns an array containing the ID of all available party skills

Responses

Response samples

Content type
application/json
[
  • 8037,
  • 2475,
  • 2651
]

Find party skill by ID

Returns a single party skill

path Parameters
partySkillId
required
integer
Example: 8037

ID of party skill to return

Responses

Response samples

Content type
application/json
{
  • "id": 8037,
  • "name": {
    },
  • "description": {
    },
  • "icon": "trocall.png",
  • "level": 10,
  • "consumedPoints": 1,
  • "duration": 60
}

Find party skills by a list of IDs

Returns an array with party skills

path Parameters
partySkillIds
required
any
Example: 8037,2475,2651

IDs of party skills to return separated by comma ,

Responses

Response samples

Content type
application/json
[
  • {
    }
]

NPC

id
required
integer

ID of the NPC

name
required
object (LocalizedText)

Text available in several languages

menus
required
Array of strings
Items Enum: "trade" "dialog" "changeelem" "upgrade" "inputreward" "showreward" "piercing" "piercingremove" "attribute" "lodelight" "bank" "hairshop" "itemrepair" "post" "skinshop" "buff" "arenaenter" "arenaleave" "guildbank" "guildrank" "guildrankwar" "guildrankinfo" "guildsiegeapply" "guildsiegestate" "guildsiegecancel" "guildsiegejoin" "guildsiegelineup" "guildsiegejackpot" "guildsiegebestplayer" "guildsiegeranking" "guildsiegejackpot2" "guildsiegeinfo1" "guildsiegeinfo2" "guildsiegeinfo3" "guildsiegeinfo4" "guildsiegeinfo80" "guildsiegeapply80" "guildsiegestate80" "guildsiegejoin80" "guildsiegelineup80" "guildsiegeranking80" "guildsiegecancel80" "guildsiegeinfo60" "guildsiegeapply60" "guildsiegestate60" "guildsiegejoin60" "guildsiegelineup60" "guildsiegeranking60" "guildsiegecancel60" "roshambo" "exchangeroshambo" "upgradecard" "safeelementupgrade" "safeupgrade" "safepiercing" "createshiningpowerdice" "createjewels" "createuniqueweapon" "exchangerareitempieces" "exchangecardpieces" "removelevelreduction" "removecostumeblessing" "arenaranking" "arenareward" "accessoryupgrade" "safeaccessoryupgrade" "traderedchips" "tradebluechips" "petcandycrafting" "petsacrificing" "cosmeticwardrobe" "dungeon" "tradepkchips" "exchangefwc" "gachamachine" "reshufflecard" "tradegreenchips" "rainbowraceapply" "createultimate" "traderings" "tradeearrings" "tradenecklaces" "dismantle" "fwcboard" "fwcteleport" "fwcranking" "fwcspectate" "fwcexchange" "fwccollect" "tradekalgaschips" "gachamachine" "rockpaperscissors" "costumeboxupgrade" "buyplayerhouse" "joinplayerhouse" "visitplayerhouse" "bidguildhouse" "joinguildhouse" "kalgasassaultinfo" "kalgasassaultregister" "kalgasassaultentry" "kalgasassaultranking" "guestbookhouse"

Menus available at the NPC

required
Array of objects (Location)

Locations where you can find the NPC

image
required
string

Dialog image of the NPC

place
string (Place)
Enum: "lodestar" "lodelight" "flyingstation" "weaponstore" "armorstore" "foodstore" "magicstore" "generalstore" "publicoffice" "questoffice" "dungeon" "shieldstore" "warpzone" "instance"

Specific location in a world

Array of objects

NPC shop data

{
  • "id": 1689,
  • "name": {
    },
  • "menus": [
    ],
  • "locations": [
    ],
  • "image": "marche.png",
  • "place": "publicoffice",
  • "shop": [
    ]
}

Get all NPCs IDs

Returns an array containing the ID of all available NPCs

Responses

Response samples

Content type
application/json
[
  • 1689,
  • 296,
  • 2881
]

Find NPC by ID

Returns a single NPC

path Parameters
npcId
required
integer
Example: 1689

ID of NPC to return

Responses

Response samples

Content type
application/json
{
  • "id": 1689,
  • "name": {
    },
  • "menus": [
    ],
  • "locations": [
    ],
  • "image": "marche.png",
  • "place": "publicoffice",
  • "shop": [
    ]
}

Find NPCs by a list of IDs

Returns an array with NPCs

path Parameters
npcIds
required
any
Example: 1689,296,2881

IDs of NPCs to return separated by comma ,

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get NPC dialog image

Returns image for the specified file name

path Parameters
fileName
required
any
Example: marche.png

File name of the image

Responses

Quest

id
required
integer

ID of the Quest

name
required
object (LocalizedText)

Text available in several languages

type
required
string
Enum: "category" "normal" "repeat" "chain" "daily"

Type of the Quest

repeatable
required
boolean

Whether the Quest can be completed several times or not

removable
required
boolean

Whether the Quest can be removed by the player or not

partyShare
required
boolean

Whether monster kill count and item drops are shared across party members on the same Quest or not

parent
integer

ID of the parent Quest

beginNPC
integer

ID of the NPC launching the Quest

minLevel
integer

Minimum level required to begin the Quest

maxLevel
integer

Maximum level required to begin the Quest

beginClasses
Array of integers

List of player Classes able to begin the Quest

Array of objects

List of Quests required to begin the Quest

Array of objects

List of Items received when launching the Quest

endNPC
integer

ID of the NPC completing the Quest

Array of objects

List of Items required to complete the Quest

endTimeLimit
integer

Maximum time in seconds to complete the Quest

endTalkNPC
integer

ID of the NPC to talk to before completing the Quest

object (Spawn)

Object spawn area in the world

Array of objects

List of Monsters to kill before completing the Quest

Array of objects

List of Items removed when completing the Quest

endReceiveGold
integer or null

Amount of Penya received when completing the Quest. If the value is null then the player will receive Penya but the amount is hidden

endReceiveExperience
Array of numbers or null

Amount of experience in % given to the player completing the Quest on a specific level. If the value is null then the player will receive experience but the amount is hidden

endReceiveInventorySpaces
integer or null

Inventory spaces unlocked when completing the Quest. If the value is null then the player will unlock spaces but the amount is hidden

endReceiveSkillPoints
integer or null

Skill points received when completing the Quest. If the value is null then the player will receive Skill points but the amount is hidden

endReceiveKarma
string or null

Karma recovered when completing the Quest. If the value is null then the player will recover Karma but the amount is hidden

Array of objects or null

List of Items received when completing the Quest. If the value is null then the player will receive items but they are hidden

description
object (LocalizedText)

Text available in several languages

descriptionComplete
object (LocalizedText)

Text available in several languages

dialogsBegin
Array of objects (LocalizedText)

List of Dialogs when the NPC presents the Quest to the player

dialogsAccept
Array of objects (LocalizedText)

List of Dialogs when the player accepts the Quest

dialogsDecline
Array of objects (LocalizedText)

List of Dialogs when the player declines the Quest

dialogsComplete
Array of objects (LocalizedText)

List of Dialogs when the player completes the Quest

dialogsFail
Array of objects (LocalizedText)

List of Dialogs when the player fails to complete the Quest

{
  • "id": 1840,
  • "name": {
    },
  • "type": "chain",
  • "repeatable": false,
  • "removable": true,
  • "partyShare": true,
  • "parent": 821,
  • "beginNPC": 2595,
  • "minLevel": 1,
  • "maxLevel": 120,
  • "beginClasses": [
    ],
  • "beginQuests": [
    ],
  • "beginReceiveItems": [
    ],
  • "endNPC": 2595,
  • "endNeededItems": [
    ],
  • "endTimeLimit": 600,
  • "endTalkNPC": 9779,
  • "endVisitPlace": {
    },
  • "endKillMonsters": [
    ],
  • "endRemoveItems": [
    ],
  • "endReceiveGold": 10000,
  • "endReceiveExperience": [
    ],
  • "endReceiveInventorySpaces": 1,
  • "endReceiveSkillPoints": 40,
  • "endReceiveKarma": "+2000",
  • "endReceiveItems": [
    ],
  • "description": {
    },
  • "descriptionComplete": {
    },
  • "dialogsBegin": [
    ],
  • "dialogsAccept": [
    ],
  • "dialogsDecline": [
    ],
  • "dialogsComplete": [
    ],
  • "dialogsFail": [
    ]
}

Get all Quests IDs

Returns an array containing the ID of all available Quests

Responses

Response samples

Content type
application/json
[
  • 1840,
  • 821,
  • 5260
]

Find Quest by ID

Returns a single Quest

path Parameters
questId
required
integer
Example: 1840

ID of Quest to return

Responses

Response samples

Content type
application/json
{
  • "id": 1840,
  • "name": {
    },
  • "type": "chain",
  • "repeatable": false,
  • "removable": true,
  • "partyShare": true,
  • "parent": 821,
  • "beginNPC": 2595,
  • "minLevel": 1,
  • "maxLevel": 120,
  • "beginClasses": [
    ],
  • "beginQuests": [
    ],
  • "beginReceiveItems": [
    ],
  • "endNPC": 2595,
  • "endNeededItems": [
    ],
  • "endTimeLimit": 600,
  • "endTalkNPC": 9779,
  • "endVisitPlace": {
    },
  • "endKillMonsters": [
    ],
  • "endRemoveItems": [
    ],
  • "endReceiveGold": 10000,
  • "endReceiveExperience": [
    ],
  • "endReceiveInventorySpaces": 1,
  • "endReceiveSkillPoints": 40,
  • "endReceiveKarma": "+2000",
  • "endReceiveItems": [
    ],
  • "description": {
    },
  • "descriptionComplete": {
    },
  • "dialogsBegin": [
    ],
  • "dialogsAccept": [
    ],
  • "dialogsDecline": [
    ],
  • "dialogsComplete": [
    ],
  • "dialogsFail": [
    ]
}

Find Quests by a list of IDs

Returns an array with Quests

path Parameters
questIds
required
any
Example: 1840,821,5260

IDs of Quests to return separated by comma ,

Responses

Response samples

Content type
application/json
[
  • {
    }
]

PK

pointsPerKill
required
integer

The number of points your PK value increases by each kill

decreasePointDelaySec
required
integer

The number of seconds between each PK point decrease

decreasePointCount
required
integer

The number of points decreased every decreasePointDelaySec

dropChipMonsterFactor
required
float

The factor for dropping chips when dying to a monster instead of a player

required
Array of objects

Percentage of chips you will drop based on your stolen chip count

{
  • "pointsPerKill": 3,
  • "decreasePointDelaySec": 300,
  • "decreasePointCount": 1,
  • "dropChipMonsterFactor": 0.6,
  • "dropChipPercentages": [
    ]
}

Get all PK information

Returns an object containing information about PK

Responses

Response samples

Content type
application/json
{
  • "pointsPerKill": 3,
  • "decreasePointDelaySec": 300,
  • "decreasePointCount": 1,
  • "dropChipMonsterFactor": 0.6,
  • "dropChipPercentages": [
    ]
}

Achievement

id
required
integer

ID of the Achievement

name
required
object (LocalizedText)

Text available in several languages

description
required
object (LocalizedText)

Text available in several languages

type
required
string
Enum: "killmonster" "useitem" "jump" "stat" "class" "level" "playtime" "useskill" "connection" "hatchegg" "winrainbowrace"

Type of the Achievement

category
required
string
Enum: "general" "monsters" "consumables" "attendance"

Category of the Achievement

accountWide
required
boolean

Whether the Achievement is shared per Account

badgeReward
string

The badge received as a reward

required
Array of objects

Levels of the Achievement

mainMonster
integer

ID of the main Monster to kill

monsters
Array of integers

List of all Monsters that can be killed to complete the Achievement

mainItem
integer

ID of the main Item to use

items
Array of integers

List of all Items that can be used to complete the Achievement

stats
Array of strings
Items Enum: "str" "sta" "dex" "int"

List of all parameters that can be reached to complete the Achievement

mainSkill
integer

ID of the main Skill to use

skills
Array of integers

List of all Skills that can be used to complete the Achievement

mainClass
integer

ID of the main Class to reach

classes
Array of integers

List of all Classes that can be reached to complete the Achievement

{
  • "id": 58,
  • "name": {
    },
  • "description": {
    },
  • "type": "killmonster",
  • "category": "monsters",
  • "accountWide": true,
  • "badgeReward": "master6.png",
  • "levels": [
    ],
  • "mainMonster": 6413,
  • "monsters": [
    ],
  • "mainItem": 5325,
  • "items": [
    ],
  • "stats": [
    ],
  • "mainSkill": 9660,
  • "skills": [
    ],
  • "mainClass": 764,
  • "classes": [
    ]
}

Get all achievement IDs

Returns an array containing the ID of all available achievements

Responses

Response samples

Content type
application/json
[
  • 58,
  • 77,
  • 182
]

Find achievement by ID

Returns a single achievement

path Parameters
achievementId
required
integer
Example: 58

ID of achievement to return

Responses

Response samples

Content type
application/json
{
  • "id": 58,
  • "name": {
    },
  • "description": {
    },
  • "type": "killmonster",
  • "category": "monsters",
  • "accountWide": true,
  • "badgeReward": "master6.png",
  • "levels": [
    ],
  • "mainMonster": 6413,
  • "monsters": [
    ],
  • "mainItem": 5325,
  • "items": [
    ],
  • "stats": [
    ],
  • "mainSkill": 9660,
  • "skills": [
    ],
  • "mainClass": 764,
  • "classes": [
    ]
}

Find achivements by a list of IDs

Returns an array with achievements

path Parameters
achievementIds
required
any
Example: 58,77,182

IDs of achievements to return separated by comma ,

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upgrade Level Bonus

upgradeLevel
required
integer

The Upgrade Level (+X)

weaponAttack
required
integer

Attack bonus in % when the upgraded item is a Weapon

helmetDefense
integer

Defense bonus in % when the upgraded item is an Helmet

suitDefense
integer

Defense bonus in % when the upgraded item is a Suit

gauntletDefense
integer

Defense bonus in % when the upgraded item is a Gauntlet

bootsDefense
integer

Defense bonus in % when the upgraded item is Boots

shieldDefense
integer

Defense bonus in % when the upgraded item is a Shield

required
Array of objects (Ability)

Special Abilities applied to the player when all his equipment has the upgrade level

{
  • "upgradeLevel": 1,
  • "weaponAttack": 2,
  • "helmetDefense": 2,
  • "suitDefense": 2,
  • "gauntletDefense": 2,
  • "bootsDefense": 2,
  • "shieldDefense": 2,
  • "setAbilities": [
    ]
}

Get the upgrade bonus levels

Returns an array containing all the bonus per upgrade level

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Skill Awake

skills
required
object

Object containing possible awakes affecting skills for each rarity

parameters
required
object

Object containing possible awakes affecting parameters for each rarity

{
  • "skills": {
    },
  • "parameters": {
    }
}

Get the skill awake values

Returns an object containing all the skill awakes available for all weapon and shield types

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Raised Pets

petItemId
required
integer

The ID of the raised pet item

parameter
string
Enum: "str" "sta" "dex" "int" "attack" "def" "maxhp" "criticalchance" "criticaldamage"

Name of the parameter affected by this raised pet

rate
boolean

Whether or not the parameter is a rate

values
Array of integers

The value of the parameter at each level index

required
Array of objects

Information of each tier of this raised pet, by index

{
  • "petItemId": 8600,
  • "parameter": "str",
  • "rate": false,
  • "values": [
    ],
  • "tiers": [
    ]
}

Get the raised pet information

Returns an object containing all the information for each raised pet

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Dungeons

id
required
integer

ID of the dungeon

name
required
object (LocalizedText)

Text available in several languages

type
required
string
Enum: "party" "guild" "solo" "partyorsolo" "guildorsolo"

Type of the dungeon

image
required
string

The image of the dungeon

world
required
integer

The world ID of the dungeon

difficulty
required
string
Enum: "story" "normal" "medium" "hard" "extrahard" "nightmare" "cursed"

Type of dungeon

minLevel
required
integer

The minimum entry level of the dungeon

maxLevel
required
integer

The maximum entry level of the dungeon

cooldownSecs
required
integer

The cooldown of the dungeon in seconds

monsters
required
Array of integers

Array of monster IDs present in the dungeon

Array of objects

Array of modifiers applied on all monsters in the dungeon

requiredCreatorQuest
integer

The ID of the required completed quest from the creator of the dungeon

requiredCreatorItem
integer

The ID of the required item from the creator of the dungeon

requiredCreatorPenya
integer

The amount of penya required from the creator of the dungeon

minGuildLevel
integer

The minimum guild level required to enter the dungeon

Array of objects

The available curses on this dungeon

{
  • "id": 134,
  • "name": {
    },
  • "type": "guildorsolo",
  • "image": "storm.png",
  • "world": 3171,
  • "difficulty": "normal",
  • "minLevel": 1,
  • "maxLevel": 140,
  • "cooldownSecs": 172800,
  • "monsters": [
    ],
  • "monsterMods": [
    ],
  • "requiredCreatorQuest": 2032,
  • "requiredCreatorItem": 1823,
  • "requiredCreatorPenya": 50000,
  • "minGuildLevel": 25,
  • "availableCurses": [
    ]
}

Get dungeons information

Returns an array containing all the information for each dungeon

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Exchange Menus

menu
required
string

The name of the NPC menu

required
Array of objects

List of item exchanges

{
  • "menu": "traderedchips",
  • "exchanges": [
    ]
}

Get the item exchange menus

Returns an array containing all the item exchange menus and their exchanges

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Housing Template

id
required
integer

ID of the template

name
required
object (LocalizedText)

Text available in several languages

image
required
string

Filename of the preview image

world
required
integer

The ID of the template's world

size
required
string
Enum: "small" "medium" "large" "extralarge"

The size of the template

{
  • "id": 1553,
  • "name": {
    },
  • "image": "blankWorld.png",
  • "world": 1233,
  • "size": "small"
}

Get all housing template IDs

Returns an array containing the ID of all available housing templates

Responses

Response samples

Content type
application/json
[
  • 1689,
  • 296,
  • 2881
]

Find housing template by ID

Returns a single housing template

path Parameters
templateId
required
integer
Example: 1689

ID of housing template to return

Responses

Response samples

Content type
application/json
{
  • "id": 1553,
  • "name": {
    },
  • "image": "blankWorld.png",
  • "world": 1233,
  • "size": "small"
}

Find housing templates by a list of IDs

Returns an array with housing templates

path Parameters
templateIds
required
any
Example: 1689,296,2881

IDs of templates to return separated by comma ,

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Housing template preview image

Returns image for the specified file name

path Parameters
fileName
required
any
Example: BlankWorld.png

File name of the image

Responses

Housing Pack

packItemId
required
integer

ID of the pack

Array of objects

Array of props and furniture available in the pack

Array of objects

Array of NPCs available in the pack

{
  • "packItemId": 14345,
  • "objects": [
    ],
  • "npcs": [
    ]
}

Get all housing pack IDs

Returns an array containing the ID of all available housing packs

Responses

Response samples

Content type
application/json
[
  • 1689,
  • 296,
  • 2881
]

Find housing pack by ID

Returns a single housing pack

path Parameters
packId
required
integer
Example: 1689

ID of housing pack to return

Responses

Response samples

Content type
application/json
{
  • "packItemId": 14345,
  • "objects": [
    ],
  • "npcs": [
    ]
}

Find housing packs by a list of IDs

Returns an array with housing packs

path Parameters
packIds
required
any
Example: 1689,296,2881

IDs of packs to return separated by comma ,

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Language

id
required
string

ID of the Language

name
required
string

Name of the Language

flag
required
string

Flag of the Language

{
  • "id": "en",
  • "name": "English",
  • "flag": "en.png"
}

Get all languages

Returns an array containing all the languages

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get language flag

Returns flag for the specified file name

path Parameters
fileName
required
any
Example: en.png

File name of the flag

Responses

LocalizedText

object (LocalizedText)

Text available in several languages

{
  • "en": "Julia",
  • "fr": "[Intendante de Flarine] Julia",
  • "kr": "쥬리아"
}

Location

world
required
integer

ID of the world

x
required
number

X coordinate in the world

y
required
number

Y coordinate in the world

z
required
number

Z coordinate in the world

continent
integer

ID of the Continent in the world

{
  • "world": 6063,
  • "x": 6959.104,
  • "y": 100,
  • "z": 3213.523,
  • "continent": 8641
}

Spawn

world
required
integer

ID of the world

left
required
number

Lower X coordinate in the world

right
required
number

Upper X coordinate in the world

top
required
number

Lower Z coordinate in the world

bottom
required
number

Upper Z coordinate in the world

continent
integer

ID of the Continent in the world

aggressivity
integer

Probability in % that a spawned monster is aggressive

{
  • "world": 6063,
  • "left": 1190,
  • "right": 1236,
  • "top": 1351,
  • "bottom": 1400,
  • "continent": 8641,
  • "aggressivity": 100
}

Ability

parameter
required
string
Enum: "str" "dex" "int" "sta" "speed" "attackspeed" "attackspeedrate" "jumpheight" "bowrange" "def" "parry" "reflectdamage" "rangedblock" "meleeblock" "magicdefense" "electricitydefense" "firedefense" "winddefense" "waterdefense" "earthdefense" "attack" "hitrate" "magicattack" "swordattack" "axeattack" "knuckleattack" "yoyoattack" "bowattack" "earthmastery" "firemastery" "watermastery" "electricitymastery" "windmastery" "damage" "criticalchance" "elementattack" "skillchance" "attribute" "maxhp" "maxmp" "maxfp" "hprecovery" "mprecovery" "fprecovery" "hprecoveryafterkill" "mprecoveryafterkill" "fprecoveryafterkill" "decreasedmpconsumption" "decreasedfpconsumption" "minability" "maxability" "attributeimmunity" "autohp" "autohppvp" "decreasedcastingtime" "criticaldamage" "skilldamage" "hprestoration" "criticalresist" "healing" "pvpdamagereduction" "magicdefense" "pvpdamage" "pvedamage" "penya" "hp" "mp" "fp" "allelementsdefense" "allstats" "attackandmaxhp" "defenseandhitratedecrease" "cure" "movement" "allelementsmastery" "allrecovery" "allrecoveryafterkill" "decreasedfpandmpconsumption" "removealldebuff" "block" "removedebuff" "damageandstealhp" "stealhp" "explostdecreaseatrevival" "cheerpoint" "incomingdamage" "spiritstrike" "stealfp" "exprate" "droprate" "fprecoveryautoattack" "bleedandpoisonresist" "pvedamagereduction" "blockpenetration" "damageoffload" "incominghealing" "multistrike" "monsterexp" "monsterexpanddrop" "hppercentrecovery" "expanddrop" "allspeed" "arcaneinsightchance" "ripostereflexchance" "bossmonsterdamage"

Parameter of the Ability

add
number

Value added

addMax
number

The maximum possible value to be added. When present, add is the minimum value

set
number

Value overwriting all added values

rate
boolean

Whether the value is a % rate or a flat value

attribute
string
Enum: "rooting" "stun" "hitrate" "invisibility" "poison" "slow" "double" "bleeding" "silent" "counterattackdamage" "counterattack" "loot" "moonbeam" "hitrateandpoison" "hitrateandpoisonandstun" "lootandslow" "poisonandbleedingandmoonbeam" "stunandrooting" "forcedblock"

Type of Attribute when the parameter is attribute, cure or attributeimmunity

dotValue
integer

Value used to compute the Damage done when attribute is poison or bleeding

dotMode
string
Enum: "currentdamage" "standardattack" "fixedvalue" "stacks"

Method used to compute the Damage done when attribute is poison or bleeding

skill
integer

ID of the Skill that has a chance to trigger when parameter is skillchance

skillLevel
integer

Level of the Skill that has a chance to trigger when parameter is skillchance

pvp
boolean

Whether the Skill can trigger in PvP or not when parameter is skillchance

pve
boolean

Whether the Skill can trigger in PvE or not when parameter is skillchance

{
  • "parameter": "maxhp",
  • "add": 1,
  • "addMax": 5,
  • "set": 0,
  • "rate": true,
  • "attribute": "stun",
  • "dotValue": 10,
  • "dotMode": "currentdamage",
  • "skill": 7599,
  • "skillLevel": 2,
  • "pvp": true,
  • "pve": true
}

Place

string (Place)
Enum: "lodestar" "lodelight" "flyingstation" "weaponstore" "armorstore" "foodstore" "magicstore" "generalstore" "publicoffice" "questoffice" "dungeon" "shieldstore" "warpzone" "instance"

Specific location in a world

"publicoffice"

Get place icon

Returns icon for the specified file name

path Parameters
fileName
required
any
Example: publicoffice.png

File name of the icon

Responses

Element

string (Element)
Enum: "fire" "water" "electricity" "wind" "earth" "none"

Natural element

"fire"

Get element icon

Returns icon for the specified file name

path Parameters
style
required
any
Example: pc

Style of the icon. Accepted values: pc, mobile, masquerade.

fileName
required
any
Example: fire.png

File name of the icon

Responses

Badge

string (Badge)

Player badge

"master6.png"

Get a badge icon

Returns icon for the specified file name

path Parameters
fileName
required
any
Example: master6.png

File name of the icon

Responses

Color

r
required
integer

Red component

g
required
integer

Green component

b
required
integer

Blue component

a
integer

Alpha component

{
  • "r": 255,
  • "g": 255,
  • "b": 255,
  • "a": 125
}