# 接口地址
## 通用官方API接口
```
https://mc.iroselle.com/api/
```
## 公共參數
暫時無需公共參數
## 公共返回
| 字段名 | 類型 | 參考 | 備注
| --- | --- | --- | --- |
| code | 0/1 | 1 | 是否調用成功 |
| message | String | 操作成功 | 若操作失敗將返回失敗原因
| res | Object/Array | | 每個接口返回的詳細信息
| run_time | double | 0.005712 | 調用API耗時(秒)
*****
## :-: 獲取服務器信息
### 接口地址
```
https://mc.iroselle.com/api/data/getServerInfo
```
### 參數
| 參數名 | 類型 | 參考 | 備注
| --- | --- | --- | --- |
| server_addr | String | roselle.vip | 服務器地址
| show_favicon | 1/0 | 1 | 是否返回服務器圖標(默認不返回)
### 返回
| 字段名 | 類型 | 參考 | 備注
| --- | --- | --- | --- |
| server_status | 1/0 | 1 | 是否在線
| server_player_online | int | 68 | 當前在線玩家
| server_player_max | int | 69 | 在線玩家上限
| server_player_average | double | 26.8172 | 日均在線人數
| server_player_histroy_max | int | 139 | 歷史最高同時在線人數
| favicon | base64/空字符串 | | 服務器小圖標(Base64格式)
### 實例
~~~[api]
get:https://mc.iroselle.com/api/data/getServerInfo
*string:server_addr=roselle.vip#服務器IP地址
int:show_favicon=0#是否顯示服務器圖標(若可用)
~~~
*****
## :-: 獲取服務器在線玩家(純文本)
### 接口地址
```
https://mc.iroselle.com/api/data/getServerPlayer
```
### 參數
| 參數名 | 類型 | 參考 | 備注
| --- | --- | --- | --- |
| server_addr | String | roselle.vip | 服務器地址
### 返回
純文本，在線返回具體在線人數，若離線返回-1
### 實例
~~~[api]
get:https://mc.iroselle.com/api/data/getServerPlayer
*string:server_addr=roselle.vip#服務器IP地址
~~~
