Chess API
收藏Chess API 数据集概述
基本信息
- 数据集名称: Chess API
- 类别: Gaming
- 提供者: apimirai
- API版本: v1 (current)
- 基础订阅价格: $0.00 / 月
- 专业订阅价格: $10.00 / 月
- 高级订阅价格: $30.00 / 月
- 顶级订阅价格: $100.00 / 月
- 服务等级: 100%
- 延迟: 517ms
- 测试通过率: 100%
- 流行度: 9.1
数据集描述
Chess API 是一个紧凑的棋局分析器。通过单一请求和单一格式,可获取合法走法、最佳走法建议以及胜率评估。该API旨在通过实验真实棋局并获取来自轻量级国际象棋引擎的即时、程序化反馈来帮助用户学习国际象棋。
主要功能
- 获取所有合法走法: 返回给定局面下轮到走棋一方的所有合法走法。
- 建议最佳走法: 基于AI搜索,返回轮到走棋一方的最佳走法建议。
- 评估胜率: 返回以百分之一兵为单位的评估值,并使用Lichess逻辑公式计算白方与黑方的获胜概率分割。
端点详情
所有端点均使用POST方法,Content-Type为application/json,并需要认证头X-RapidAPI-Key和X-RapidAPI-Host。
1. POST /moves
返回给定局面下轮到走棋一方的所有合法走法。
- 查询参数:
turn(可选):white或black。默认值:white。allow_castling(可选):1启用王车易位规则。castle_rights(可选): 权利字符串,例如KQkq,KQ,kq等。用于声明当前局面中哪些王车易位权利仍然可用。allow_enpassant(可选):1启用吃过路兵逻辑。ep(可选): 吃过路兵目标方格,如e3(仅在allow_enpassant=1时有意义)。
- 请求体: 使用棋子数组或信封格式
{ "turn": "...", "pieces": [...] }。 - 响应: 包含合法走法列表,每个走法包括
from、to和uci字段。局面状态可以是ok、checkmate或stalemate。
2. POST /bestmove
基于AI搜索,返回轮到走棋一方的最佳走法建议。
- 查询参数: 与
/moves相同。 - 请求体: 与
/moves相同。 - 响应: 包含最佳走法、合法走法数量以及一个简单的子力得分。
3. POST /win_chance
返回以百分之一兵为单位的评估值,以及使用Lichess逻辑公式计算的白方与黑方获胜概率分割。
- 查询参数:
turn(可选):white或black。allow_castling,castle_rights,allow_enpassant,ep(可选,用于API一致性)。
- 请求体: 与
/moves和/bestmove相同的棋子格式。 - 响应: 包含
centipawns(评估值,白方优势为正,黑方优势为负)、white_win和black_win(百分比)。
数据模型
棋子表示 (请求体)
对于 /moves、/bestmove 和 /win_chance,将当前局面作为棋子列表发送:
json
[
{ "pos_x": "e", "pos_y": "2", "figure": "pawn", "color": "white" },
{ "pos_x": "e", "pos_y": "7", "figure": "pawn", "color": "black" },
{ "pos_x": "e", "pos_y": "1", "figure": "king", "color": "white" },
{ "pos_x": "e", "pos_y": "8", "figure": "king", "color": "black" }
]
信封格式 (可选)
可以发送包含 pieces 的对象:
json
{
"turn": "white",
"pieces": [
{ "pos_x": "e", "pos_y": "2", "figure": "pawn", "color": "white" }
]
}
认证
所有请求均通过RapidAPI进行。需在请求头中发送:
X-RapidAPI-Key: 您的RapidAPI密钥。X-RapidAPI-Host: RapidAPI为此API分配的主机。
错误格式
1) JSON错误对象 (推荐格式)
json { "status": "error", "code": "invalid_parameters", "message": "One or more parameters are invalid." }
可能的错误码包括: bad_request、method_not_allowed、invalid_parameters、unauthorized、rate_limited、resource_not_found、upstream_error、internal_error。
2) 纯文本HTTP错误
某些错误可能以纯文本响应体返回,例如HTTP 400 Bad Request、405 Method Not Allowed、401/403。
集成注意事项
- 始终在局面中包含双方的王。某些功能和评估假设一个有效的国际象棋局面。
turn可以通过查询参数?turn=white|black或在请求体中提供。如果两者都存在,以请求体为准。- 如果启用王车易位,请在需要跨自定义位置具有确定性行为时显式提供
castle_rights。 - 如果启用吃过路兵,请提供
ep(目标方格) 以匹配您要分析的确切情况。
演示链接
- 实时演示: https://mirai-api.github.io/chess-api/
- RapidAPI列表: https://rapidapi.com/apimirai/api/chess-api3/
提供商信息
- API创建者: apimirai
- 订阅者数量: 1
- 类别: Gaming




