GitHub 开始使用
v0.10.4 开源 · GPL-3.0 · 零依赖

常用接口
一站搞定

Miao API 把游戏限免、全网热搜、天气节假日、金融行情、诗词壁纸、开发工具和网络检测等 120 个常用接口聚合在一起:统一 JSON 格式,每个字段都有中文说明,支持跨域,免注册就能调用。

curl https://api.miao.club/api/hitokoto
GET /api/hot/weibo?limit=3
// 返回示例
{
  "code": 200,
  "message": "ok",
  "cached": true,
  "data": {
    "title": "微博热搜",
    "items": [
      {
        "rank": 1,
        "title": "……",
        "hot": 1234567,
        "url": "https://s.weibo.com/weibo?q=…"
      }
    ]
  }
}
120个常用接口
186个调用地址
1,000次/天 免注册调用
10,000次/天 注册用户
0个第三方依赖
为什么选 Miao API

不只是把接口堆在一起

每个接口都经过同样的打磨:格式统一、文档完整、有缓存兜底,出了问题一眼就能看到。

统一格式,字段中文说明

所有接口外层都是 { code, message, data },每个返回字段都写明含义、单位和何时为空,并有自动化测试保证文档与实际一致。

快,上游挂了也不空白

按数据特点缓存,热门接口提前预热,大部分请求毫秒级返回;上游出故障时先返回最近一次成功的数据。

前端直接调用

全部接口开启跨域,网页里 fetch 就能用;二维码、壁纸、徽章等图片接口直接写进 <img>。

内容更新自动推送

订阅 Epic 周免、游戏限免、必应壁纸、节假日提醒等主题,推送到微信、Bark、Telegram、钉钉、飞书、企业微信或邮件。

运行状态公开透明

公开的状态页按真实调用统计每个接口 24 小时的调用量、耗时和失败率,数据源失效的接口会明确标出原因。

零依赖,拷过去就能跑

只用 Node.js 自带能力和内置 SQLite,没有任何 npm 依赖;自带管理后台、一键巡检、故障诊断和在线更新。

在线试用

点一下,看看真实返回

下面的数据都是刚刚实时请求的,和你在自己项目里调用拿到的完全一样。

GET /api/hitokoto
// 点击左侧的接口开始请求
产品截图

从调试到运维,都在网页里完成

Miao API 在线调试:返回结果带中文字段注释和示例代码
每个接口都能在线调试,返回结果旁边直接显示字段的中文说明,下方附 cURL、JavaScript、Python 示例代码。
自己部署

10 分钟,拥有自己的 API 站

没有额度限制,可以自己加接口、给团队用。只需要 Node.js 22.13+ 或 Docker。

1

下载并启动

git clone 后执行 npm start,或用 Docker 运行,默认端口 3000。

2

绑定域名

Nginx、1Panel 或宝塔反向代理到 127.0.0.1:3000,开启 HTTPS。

3

注册管理员

打开网站注册,第一个账号自动成为管理员。

4

后台设置

填写站点地址、开启「信任反向代理」,按需配置第三方密钥,每项都能一键测试连通性。

5

之后一键升级

后台检查到新版本后点一下即可更新,只下载有变化的文件,启动失败自动回滚。

# 需要 Node.js 22.13 以上,没有任何 npm 依赖
git clone https://github.com/bocmiao/api.git miao-api
cd miao-api
cp .env.example .env   # 可选,npm start 会自动读取
npm start

# 看到这一行就成功了:
Miao API 已启动:http://localhost:3000

开源,并且会一直开源

Miao API 以 GNU GPL v3 协议开源。你可以自由地使用、修改和部署;欢迎提交 Issue 反馈问题、提交 PR 贡献新接口。如果它对你有帮助,点个 Star 就是最好的支持。

在 GitHub 上查看 →
  • 📦零依赖:只用 Node.js 内置模块与 SQLite
  • 🧪900+ 自动化测试:接口解析、字段文档、限流、在线更新全覆盖
  • 🧩模块化:新增一个接口只需一个文件,自动出现在文档和调试页
常见问题

你可能想知道

Miao API 是免费的吗?

是的。在线站点不注册每天可免费调用 1,000 次,免费注册后每天 10,000 次;自己部署则没有任何限制。

调用需要 API Key 吗?

不需要。大多数接口直接请求就能用;注册后在控制台创建 API Key,通过请求头 X-API-Key 传入可获得更高额度。在公开网页里调用时建议不带 Key。

可以用在商业项目里吗?

可以调用在线站点的接口,也可以部署源码使用。项目以 GPL v3 协议开源:如果你分发修改后的版本,需要同样以 GPL v3 开源并保留版权声明。部分接口的数据来自第三方网站,请同时遵守相应网站的使用条款。

如何新增自己的接口?

在 src/apis/<分类>/ 下按约定新建一个模块文件并注册,它会自动出现在接口目录、文档页和在线调试中。欢迎把通用的接口提交 PR 分享给大家。

遇到问题去哪里反馈?

欢迎加入用户 QQ 群「MiaoClub」 2639496(点击加群),也可以到 GitHub Issues 提交问题和建议。

现在就开始用

不用注册,打开就能调用。