開発者向け情報

MapleStatus.info の API ドキュメントへようこそ！ここでは、最新のサーバー稼働状況を取得するための API 利用方法について解説します。当サイトのチェッカーもこの API で動作しており、開発者の皆様もご自身のプロジェクトで自由にご活用いただけます。REST API の詳細は以下をご確認ください。

はじめに

API を公開プロジェクトで使用される際は、可能な範囲でクレジットの表記をお願いしています。当サイトへのリンクを掲載し、支援・寄付を促していただけると幸いです。

当サイトの運営およびサーバー維持にはコストが発生しています。もし本サービスがお役に立てているようでしたら、無理のない範囲でご支援をお願いいたします！いただいた寄付は、サーバー費用や開発ツール、そして開発者のモチベーション（一杯のコーヒー！）のために大切に活用させていただきます。😊

PayPal で寄付

認証について

当 API はオープンかつ無料で公開されており、利用にあたっての認証は不要です。ただし、ガイドラインを遵守し、サーバーに過度な負荷をかけないようお願いいたします。サービスの悪用が確認された場合、特定の IP アドレスをブロックする権利を留保します。

レート制限

現在、1分あたり 500 リクエストの制限を設けています。この制限は、最初のリクエストからではなく、毎分 0 秒を起点としてカウントされます。

REST API リファレンス

ベース URL

本ドキュメントに記載されているすべての URL は、以下のベース URL を起点としています。

https://maplestatus.info/api

GET ゲーム一覧の取得

/games

レスポンス例 (/games):

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

GET ゲーム情報の取得

/games/:game_id

レスポンス例 (/games/maplestory):

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

GET ゲーム地域設定一覧の取得

/games/:game_id/locales

レスポンス例 (/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 ゲーム地域設定情報の取得

/games/:game_id/:locale_id

レスポンス例 (/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 全ワールド一覧の取得

/games/:game_id/:locale_id/worlds

レスポンス例 (/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 全ワールドおよび所属サーバー一覧の取得

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

レスポンス例 (/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 特定ワールド内のサーバー一覧の取得

/games/:game_id/:locale_id/:world_id

レスポンス例 (/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 サーバー情報の取得

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

レスポンス例 (/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"
  }
}