API 文档
REST 与 WebSocket 参考
使用 API Key 鉴权即可开始拉取数据。每个接口、参数与响应均有完整文档。
鉴权
所有请求都需要在 X-API-Key 请求头中携带 API Key。请妥善保管你的 Key,并在控制台中定期轮换。
基础地址
https://api.sportfast.iocurl -X GET "https://api.sportfast.io/v1/livescore?lang=en" \
-H "X-API-Key: YOUR_API_KEY"接口
参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
lang | string | — | 响应语言:en 或 zh,默认 en。 |
league_id | integer | — | 按联赛 ID 过滤。 |
date | string | — | 按日期过滤(YYYY-MM-DD)。 |
page | integer | — | 分页页码。 |
WebSocket
持久 WebSocket 连接以毫秒级推送数据——无需轮询、毫无延迟。进球、换人、红黄牌实时同步。
import WebSocket from "ws";
const ws = new WebSocket("wss://stream.sportfast.io/v1/live", {
headers: { "X-API-Key": "YOUR_API_KEY" },
});
ws.on("message", (msg) => {
const event = JSON.parse(msg);
console.log(event.type, event.data);
});错误码
| 401 | API Key 无效或缺失 |
| 403 | 套餐配额已用尽 |
| 429 | 触发限流 |
| 404 | 资源不存在 |
| 500 | 服务器内部错误 |