このAPIは、サーバーの情報を取得するためのものです。

<aside> 👉 APIのセキュリティを保護するため、未設定のユーザーエージェントや攻撃に利用される可能性のあるユーザーエージェントはブロックされます。

</aside>

<aside> 👉 APIのレートリミットは30秒あたり5リクエストです。

</aside>

<aside> ❗ APIの提供に支障があると判断した場合、接続を遮断します。

</aside>

エンドポイント一覧

/api/getservers

起動中のすべてのサーバーを取得するためのエンドポイントです。 以下のようなJSONレスポンスが返されます。

{
    "result": true,
    "servers": [
				{
		        "name": "サーバー名",
		        "owner": "オーナーのUUID",
		        "motd": "サーバーの説明文",
		        "players": "現在のプレイヤー数",
		        "maxplayers": "最大プレイヤー数",
		        "whitelist": "ホワイトリストが有効かどうか",
		        "premium": "プレミアムサーバーかどうか",
		        "ultra_premium": "ウルトラプレミアムサーバーかどうか",
		        "thirdparty": "第三者製サーバーかどうか",
		        "votes": "投票数"
		    },
				{
		        "name": "...",
		        "owner": "...",
		        "motd": "...",
		        "players": "...",
		        "maxplayers": "...",
		        "whitelist": "...",
		        "premium": "...",
		        "ultra_premium": "...",
		        "thirdparty": "...",
		        "votes": "..."
		    },
		    {...},
		]
}

/api/getserver/{name}

指定されたサーバーの情報を取得するためのエンドポイントです。 {name}にはサーバー名を指定します。 以下のようなJSONレスポンスが返されます。

{
    "result": true,
    "name": "サーバー名",
    "owner": "オーナーのUUID",
    "motd": "サーバーの説明文",
    "status": "サーバーのステータス (ONLINE/OFFLINE)",
    "icon": "サーバーアイコンの種類",
    "players": "現在のプレイヤー数",
    "maxplayers": "最大プレイヤー数",
    "whitelist": "ホワイトリストが有効かどうか",
    "language": "サーバーの言語",
    "votes": "投票数",
    "premium": "プレミアムサーバーかどうか",
    "ultra_premium": "未使用項目 (削除予定)",
    "thirdparty": "ThirdPartyサーバーかどうか",
    "laststart": "最後にサーバーが起動した時刻 (UNIX TIME)",
    "tps": "サーバーのTPS"
}

/api/getplayer/{name}

指定されたプレイヤーの情報を取得するためのエンドポイントです。 {name}にはプレイヤー名を指定します。 以下のようなJSONレスポンスが返されます。

{
    "result": true,
    "name": "プレイヤー名",
    "uuid": "プレイヤーのUUID",
    "rank": "プレイヤーのランク",
    "firstlogin": "初回ログイン時刻",
    "playtime": "プレイ時間",
    "lastserver": "最後にいたサーバー名",
    "servername": "所持サーバー名"
}