Developers

Welcome to the API documentation for MapleStatus.info! Here you will find information on how to use our API to get the latest server status. Our APIs power our game status checkers and allow developers like you to access them and use them for your own projects. Our documentation for our REST APIs is available below.

Getting Started

Before we get started, we ask for you (if you are using our APIs for a public project) to please give us a credit wherever possible. Drop a link to our website and encourage them to donate to us.

Speaking of donating, this website isn't running for free. There are costs associated with running this site and it's servers. If you are able to, we kindly ask you to donate to us whenever you can! Donating helps pay for the servers, tools we use to speed up development, and a cup of coffee to keep the developer happy! 😊

Donate with PayPal

Authentication

Our API is open and free to use. We do not require any authentication to use our APIs. However, we do ask that you follow our guidelines and respect our servers. We reserve the right to block any IP address that is abusing our services.

Rate Limits

There is currently a rate limit of 150 requests per minute. Note that every minute starts at 0 seconds and not at your first request.

REST API Reference

API Base URL

All of the URLs mentioned in this documentation currently have the following as its base.

https://maplestatus.info/api

GET Get a list of games

/games

Sample response (/games):

[
  {
    "_id": "maplestory",
    "name": "MapleStory",
    "background": "maplestory_worldsunite.jpg"
  }
]

GET Get game info

/games/:game_id

Sample response (/games/maplestory):

{
  "_id": "maplestory",
  "name": "MapleStory",
  "background": "maplestory_worldsunite.jpg"
}

GET Get a list of game locales

/games/:game_id/locales

Sample response (/games/maplestory/locales):

[
  {
    "_id": "global",
    "name": "MapleStory Global",
    "localized": {
      "ko": "메이플스토리 글로벌"
    },
    "website": "http://maplestory.nexon.net",
    "background": "maplestory_worldsunite.jpg",
    "is_default": 1
  },
  {
    "_id": "sea",
    "name": "MapleStorySEA",
    "localized": {
      "ko": "메이플스토리 동남아시아"
    },
    "website": "http://maplesea.com",
    "background": "maplestory_worldsunite.jpg",
    "is_default": 0
  },
  {
    "_id": "korea",
    "name": "MapleStory Korea",
    "localized": {
      "ko": "메이플스토리 대한민국"
    },
    "website": "http://maplestory.nexon.com",
    "background": "maplestory_worldsunite.jpg",
    "is_default": 0
  },
  {
    "_id": "japan",
    "name": "MapleStory Japan",
    "localized": {
      "ko": "메이플스토리 일본"
    },
    "website": "https://maplestory.nexon.co.jp/",
    "background": "maplestory_worldsunite.jpg",
    "is_default": 0
  },
  {
    "_id": "china",
    "name": "MapleStory China (冒险岛)",
    "localized": {
      "ko": "메이플스토리 중국 (冒险岛)",
      "zh-CN": "冒险岛",
      "zh-TW": "冒险岛",
      "zh": "冒险岛"
    },
    "website": "http://mxd.sdo.com/web6/index/index.asp",
    "background": "maplestory_worldsunite.jpg",
    "is_default": 0
  },
  {
    "_id": "taiwan",
    "name": "MapleStory Taiwan (新楓之谷)",
    "localized": {
      "ko": "메이플스토리 대만 (新楓之谷)",
      "zh-TW": "新楓之谷",
      "zh-CN": "新楓之谷",
      "zh": "新楓之谷"
    },
    "website": "https://tw.beanfun.com/maplestory/",
    "background": "maplestory_worldsunite.jpg",
    "is_default": 0
  },
  {
    "_id": "korea-test",
    "name": "MapleStory Korea Test",
    "localized": {
      "ko": "메이플스토리 테스트월드 "
    },
    "website": "https://maplestory.nexon.com/Testworld/Main",
    "background": "maplestory_worldsunite.jpg",
    "is_default": 0
  }
]

GET Get game's locale info

/games/:game_id/:locale_id

Sample response (/games/maplestory/global):

{
  "_id": "global",
  "name": "MapleStory Global",
  "localized": {
    "ko": "메이플스토리 글로벌"
  },
  "website": "http://maplestory.nexon.net",
  "background": "maplestory_worldsunite.jpg",
  "is_default": 1,
  "game_parent": "MapleStory",
  "game_slug": "maplestory"
}

GET Get a list of all the game's worlds

/games/:game_id/:locale_id/worlds

Sample response (/games/maplestory/global/worlds):

[
  {
    "_id": "login-north-america",
    "name": "Login (North America)",
    "icon": "mushroom"
  },
  {
    "_id": "login-europe",
    "name": "Login (Europe)",
    "icon": "mushroom"
  },
  {
    "_id": "scania",
    "name": "Scania",
    "icon": "scania"
  },
  {
    "_id": "bera",
    "name": "Bera",
    "icon": "bera"
  },
  {
    "_id": "aurora",
    "name": "Aurora",
    "icon": "aurora"
  },
  {
    "_id": "elysium",
    "name": "Elysium",
    "icon": "elysium"
  },
  {
    "_id": "reboot",
    "name": "Reboot",
    "icon": "reboot"
  },
  {
    "_id": "luna",
    "name": "Luna",
    "icon": "luna"
  },
  {
    "_id": "reboot-europe",
    "name": "Reboot (Europe)",
    "icon": "reboot"
  }
]

GET Get a list of all the game's worlds with its respective servers

/games/:game_id/:locale_id/worlds/servers

Sample response (/games/maplestory/global/worlds/servers):

[
  {
    "info": {
      "_id": "login-north-america",
      "name": "Login (North America)",
      "icon": "mushroom"
    },
    "data": [
      {
        "_id": "login-1",
        "name": "Login 1",
        "status": true,
        "latency": {
          "now": {
            "rating": "normal",
            "value": 21
          }
        },
        "last_updated": "2019-09-10T16:04:06+00:00"
      },
      {
        "_id": "login-2",
        "name": "Login 2",
        "status": true,
        "latency": {
          "now": {
            "rating": "normal",
            "value": 21
          }
        },
        "last_updated": "2019-09-10T16:04:06+00:00"
      },
      {
        "_id": "login-3",
        "name": "Login 3",
        "status": true,
        "latency": {
          "now": {
            "rating": "normal",
            "value": 20
          }
        },
        "last_updated": "2019-09-10T16:04:06+00:00"
      },
      {
        "_id": "cross-world",
        "name": "Cross World",
        "status": true,
        "latency": {
          "now": {
            "rating": "normal",
            "value": 21
          }
        },
        "last_updated": "2019-09-10T16:04:06+00:00"
      }
    ]
  },
  {
    "info": {
      "_id": "login-europe",
      "name": "Login (Europe)",
      "icon": "mushroom"
    },
    "data": [
      {
        "_id": "login",
        "name": "Login",
        "status": true,
        "latency": {
          "now": {
            "rating": "normal",
            "value": 145
          }
        },
        "last_updated": "2019-09-10T16:04:07+00:00"
      }
    ]
  }
]

GET Get a list of all the world's servers

/games/:game_id/:locale_id/:world_id

Sample response (/games/maplestory/global/login-north-america):

{
  "info": {
    "_id": "login-north-america",
    "name": "Login (North America)",
    "icon": "mushroom"
  },
  "data": [
    {
      "_id": "login-1",
      "name": "Login 1",
      "status": true,
      "latency": {
        "now": {
          "rating": "normal",
          "value": 21
        }
      },
      "last_updated": "2019-09-10T16:12:01+00:00"
    },
    {
      "_id": "login-2",
      "name": "Login 2",
      "status": true,
      "latency": {
        "now": {
          "rating": "normal",
          "value": 21
        }
      },
      "last_updated": "2019-09-10T16:12:01+00:00"
    },
    {
      "_id": "cross-world",
      "name": "Cross World",
      "status": true,
      "latency": {
        "now": {
          "rating": "normal",
          "value": 21
        }
      },
      "last_updated": "2019-09-10T16:12:01+00:00"
    }
  ]
}

GET Get information on a server

/games/:game_id/:locale_id/:world_id/:server_id

Sample response (/games/maplestory/global/login-north-america/cross-world):

{
  "info": {
    "_id": "login-north-america",
    "name": "Login (North America)",
    "icon": "mushroom"
  },
  "data": {
    "_id": "cross-world",
    "name": "Cross World",
    "status": true,
    "latency": {
      "now": {
        "rating": "normal",
        "value": 21
      },
      "last_24h": {
        "rating": "normal",
        "value": 21
      },
      "last_3d": {
        "rating": "normal",
        "value": 21
      },
      "last_7d": {
        "rating": "normal",
        "value": 21
      },
      "last_14d": {
        "rating": "normal",
        "value": 21
      },
      "last_30d": {
        "rating": "normal",
        "value": 21
      }
    },
    "history": null,
    "sid": 39,
    "last_updated": "2019-09-10T16:14:04+00:00"
  }
}