MapleStory IO
The unofficial MapleStory API Documentation for developers.
We have a public Discord here: https://discord.gg/WhmT8dU!
GET /api/server/:worldName/icon
Gets the raw icon of a world
  • :worldNameThe ID of the item
"Image/PNG"
GET /api/item/:itemId/icon
Gets the inventory icon of an item
  • :itemIdThe ID of the item
"Image/PNG"
GET /api/item/:itemId/iconRaw
Gets the raw icon of an item
  • :itemIdThe ID of the item
"Image/PNG"
GET /api/item/list
Gets a listing of all items we know of
[
  {
    "id": 12345,
    "name": "Awesome Weapon"
  }
]
GET /api/item/:itemId
Gets a single item
  • :itemIdThe ID of the item
{
  "Description": "...",
  "MetaInfo": "...",
  "TypeInfo": "...",
  "id": 1382223
}
GET /api/character/:characterName
Gets the ranking information of a character
  • :characterNameThe name of the player to look up
{
  "name": "SomePerson123",
  "job": "Magician",
  "ranking": 1,
  "world": "Khaini",
  "level": 255,
  "exp": 4339186,
  "rankMovement": 1,
  "rankDirection": "up",
  "avatar": "/api/character/SomePerson123/avatar",
  "got": "2016-10-05T04:48:21.537Z",
  "avatarData": "data:image/png;base64,"
}
GET /api/character/:characterName/world/:worldName
Gets the ranking information of a character
  • :characterNameThe name of the player to look up
{
  "name": "SomePerson123",
  "job": "Magician",
  "ranking": 1,
  "world": "Khaini",
  "level": 255,
  "exp": 4339186,
  "rankMovement": 1,
  "rankDirection": "up",
  "avatar": "/api/character/SomePerson123/avatar",
  "got": "2016-10-05T04:48:21.537Z",
  "avatarData": "data:image/png;base64,"
}
GET /api/character/:characterName/job/:jobName/
Gets the ranking information of a character
  • :characterNameThe name of the player to look up
{
  "name": "SomePerson123",
  "job": "Magician",
  "ranking": 1,
  "world": "Khaini",
  "level": 255,
  "exp": 4339186,
  "rankMovement": 1,
  "rankDirection": "up",
  "avatar": "/api/character/SomePerson123/avatar",
  "got": "2016-10-05T04:48:21.537Z",
  "avatarData": "data:image/png;base64,"
}
GET /api/character/:characterName/fame
Gets the fame ranking information of a character
  • :characterNameThe name of the player to look up
{
  "name": "SomePerson123",
  "job": "Magician",
  "ranking": 1,
  "world": "Khaini",
  "fame": 2377,
  "rankMovement": 1,
  "rankDirection": "up",
  "avatar": "/api/character/SomePerson123/avatar",
  "got": "2016-10-05T04:48:21.537Z",
  "avatarData": "data:image/png;base64,"
}
GET /api/character/:characterName/avatar
Gets the avatar of a character
  • :characterNameThe name of the player to look up
"Image/PNG"
Item names, icons, descriptions, and character information thereof are the sole property of NEXON and therefor applies to their Terms of Use. All in-game information is provided by a private source.