# 接口地址
## 通用官方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地址
~~~
