百鸽API接口使用说明
百鸽提供了一组简单易用的API接口,方便开发者获取游戏王卡片的相关信息。
API版本:v0(不稳定,可能随时更改字段或增加新功能)
API端点
所有API请求均通过以下基础URL进行访问:https://ygocdb.com/
。
目前仅支持GET
方法,且返回的Access-Control-Allow-Origin
始终为*
。
可用的API资源
/api/v0/card/:cardId
- 获取指定ID的卡片的信息/api/v0/cards.zip
- 一次性获取所有卡片的信息/api/v0/cards.zip.md5
- 获取上述所有卡片信息的MD5校验值/api/v0/?search=:query
- 搜索卡片/api/v0/idChangelog.jsonp
- 获取卡片ID变更记录(JSON格式)/api/v0/idChangelogArray.jsonp
- 获取卡片ID变更记录数组(JSON格式)/api/v0/idChangelog.txt
- 获取卡片ID变更记录(纯文本格式)
除API外可用的资源
/card/cid/:cid
- 通过官方数据库cid直达卡片详情页面/card/name/:name
- 通过卡片名称直达卡片详情页面cdn.233.momobako.com
- 卡图CDN
申请其他API
如果您需要其他API接口,请在此直接联系我。
API详情
/api/v0/card/:cardId
获取ID(密码)为:cardId
的卡片的信息。
参数:
show
- 可选参数,设置为all
时返回完整卡片信息callback
- 可选参数,设置JSONP回调函数名
示例请求:https://ygocdb.com/api/v0/card/16178681
JSONP请求:https://ygocdb.com/api/v0/card/16178681?callback=foo
完整信息请求:https://ygocdb.com/api/v0/card/16178681?show=all
返回:
{ "id": 16178681, "data": { "ot": 11, "setcode": 284295321, "type": 16777249, "atk": 2500, "def": 2000, "level": 67371015, "race": 8192, "attribute": 32 }, "text": { "name": "异色眼灵摆龙", "types": "[怪兽|效果|灵摆] 龙/暗\n[★7] 2500/2000 4/4", "desc": "【灵摆效果】\n这个卡名的①②的灵摆效果1回合各能使用1次。\n①:可以把自己的灵摆怪兽的战斗发生的对自己的战斗伤害变成0。\n②:自己结束阶段才能发动。这张卡破坏,从卡组把1只攻击力1500以下的灵摆怪兽加入手卡。\n【怪兽效果】\n①:这张卡用和对方怪兽的战斗给与对方的战斗伤害变成2倍。" } }
字段说明:
id
- 卡片左下角的密码data
- 卡片的基本信息,格式与YGOPro相同,许多字段因使用位运算而不直观,请参考YGOPro的Wikitext
- 卡片的文本信息
/api/v0/cards.zip
一次性获取所有卡片的信息。
示例请求:https://ygocdb.com/api/v0/cards.zip
返回:二进制zip文件,包含cards.json
{ "4007": { "cid": 4007, "id": 89631139, "cn_name": "青眼白龙", "sc_name": "青眼白龙", "md_name": "青眼白龙", "nwbbs_n": "青眼白龙", "cnocg_n": "蓝眼白龙", "jp_ruby": "ブルーアイズ・ホワイト・ドラゴン", "jp_name": "青眼の白龍", "en_name": "Blue-Eyes White Dragon", "text": { "types": "[怪兽|通常] 龙/光\n[★8] 3000/2500", "pdesc": "", "desc": "以高攻击力著称的传说之龙。任何对手都能粉碎,其破坏力不可估量。" }, "data": { "ot": 11, "setcode": 221, "type": 17, "atk": 3000, "def": 2500, "level": 8, "race": 8192, "attribute": 16 } }, "4008": { ...
字段说明:
cid
- 卡片的官方数据库唯一标识符cn_name
- 卡片的中文名称,即YGOPro译名sc_name
- 卡片的官方简体中文名称md_name
- 卡片的Master Duel中文名称(与上述官方简中名称经常有格式上的误差,或更新不及时)nwbbs_n
- 卡片的NWBBS论坛译名cnocg_n
- 卡片的CNOCG论坛译名wiki_en
- 卡片的Yugipedia英文名称,正式发售的卡无此字段- 略
/api/v0/cards.zip.md5
获取上述所有卡片信息的MD5校验值。
返回值为压缩包中cards.json
文件的MD5校验值。如果您准备在您的项目的客户端自动化获取cards.zip,请务必校验MD5值,仅在有更新时重新下载。
示例请求:https://ygocdb.com/api/v0/cards.zip.md5
/api/v0/?search=:query
搜索卡片。
参数:
search
- 搜索关键词,可以是卡片名称、效果文本等,也支持卡片密码和cidstart
- 返回结果的起始位置,默认为0callback
- 可选参数,设置JSONP回调函数名
示例请求:https://ygocdb.com/api/v0/?search=青眼白龙
返回:
{ "result": [ { "cid": 4007, "id": 89631139, "cn_name": "青眼白龙", "sc_name": "青眼白龙", "md_name": "青眼白龙", "nwbbs_n": "青眼白龙", "cnocg_n": "蓝眼白龙", "jp_ruby": "ブルーアイズ・ホワイト・ドラゴン", "jp_name": "青眼の白龍", "en_name": "Blue-Eyes White Dragon", "text": { "types": "[怪兽|通常] 龙/光\n[★8] 3000/2500", "pdesc": "", "desc": "以高攻击力著称的传说之龙。任何对手都能粉碎,其破坏力不可估量。" }, "data": { "ot": 11, "setcode": 221, "type": 17, "atk": 3000, "def": 2500, "level": 8, "race": 8192, "attribute": 16 }, "html": { "pdesc": "", "desc": "以高攻击力著称的传说之龙。任何对手都能粉碎,其破坏力不可估量。", "refer": { } }, "weight": 100, "faqs": [ "23215", "6244" ], "artid": 0 }, { "cid": 8864, "id": 9433350, "cn_name": "罪 青眼白龙", "sc_name": "Sin 青眼白龙", "md_name": "Sin 青眼白龙", "nwbbs_n": "罪 青眼白龙", "cnocg_n": "Sin 蓝眼白龙", "jp_ruby": "シン ブルーアイズ・ホワイト・ドラゴン", "jp_name": "Sin 青眼の白龍", "en_name": "Malefic Blue-Eyes White Dragon", "text": { "types": "[怪兽|效果|特殊召唤] 龙/暗\n[★8] 3000/2500", "pdesc": "", "desc": "这张卡不能通常召唤。从卡组把1只「青眼白龙」除外的场合可以特殊召唤。\r\n①:「罪」怪兽在场上只能有1只表侧表示存在。\r\n②:只要这张卡在怪兽区域存在,其他的自己怪兽不能攻击宣言。\r\n③:没有场地魔法卡表侧表示存在的场合这张卡破坏。" }, "data": { "ot": 11, "setcode": 14483491, "type": 33554465, "atk": 3000, "def": 2500, "level": 8, "race": 8192, "attribute": 32 }, "html": { "pdesc": "", "desc": "这张卡不能通常召唤。从卡组把1只「\u003Ca href=\"/card/89631139\" data-refer=\"89631139\" data-toggle=\"tooltip\" target=\"_blank\" lang=\"zh-Hans\"\u003E青眼白龙\u003C/a\u003E」除外的场合可以特殊召唤。\u003Cbr\u003E①:「\u003Ca href=\"/?search=罪\" target=\"_blank\" class=\"search\"\u003E罪\u003C/a\u003E」怪兽在场上只能有1只表侧表示存在。\u003Cbr\u003E②:只要这张卡在怪兽区域存在,其他的自己怪兽不能攻击宣言。\u003Cbr\u003E③:没有场地魔法卡表侧表示存在的场合这张卡破坏。", "refer": { "89631139": true } }, "weight": 90, "faqs": [ "22471", "9227" ], "artid": 0 } ], "next": 2 }
字段说明:
result
- 搜索结果数组next
- 搜索结果按权重分页,此参数表示下一页的起始位置,0表示没有更多结果weight
- 匹配权重,100表示完全匹配
/api/v0/idChangelog.jsonp
获取卡片ID变更记录,以JSON或JSONP格式返回。
部分新发售的卡片会暂时使用YGOPro先行卡的ID,这种ID为9位数字,会在不久修改为实际卡片密码,可在此处获取修改记录。
参数:
callback
- 可选参数,设置JSONP回调函数名
示例请求:https://ygocdb.com/api/v0/idChangelog.jsonp
返回:包含旧ID到新ID映射关系的JSON对象。
/api/v0/idChangelogArray.jsonp
获取卡片ID变更记录的数组形式,以JSON或JSONP格式返回。
参数:
callback
- 可选参数,设置JSONP回调函数名
示例请求:https://ygocdb.com/api/v0/idChangelogArray.jsonp
返回:包含相同长度的旧ID数组和新ID数组的JSON对象。
/api/v0/idChangelog.txt
获取卡片ID变更记录的纯文本格式。
示例请求:https://ygocdb.com/api/v0/idChangelog.txt
返回:纯文本格式的ID变更记录,每行一条记录。
其他资源
/card/cid/:cid
直达:cid
对应卡片详情页面。
示例请求:https://ygocdb.com/card/cid/4007
/card/name/:name
直达卡片名称:name
对应卡片详情页面。
示例请求:https://ygocdb.com/card/name/青眼白龙
cdn.233.momobako.com
卡图CDN。
服务器是自费的,请合理使用。商业项目建议自行建立镜像,请联系我。
网址:
- https://cdn.233.momobako.com/ygopro/pics/
cardid
.jpg - https://cdn.233.momobako.com/ygoimg/jp/
cardid
.jpg - https://cdn.233.momobako.com/ygoimg/en/
cardid
.jpg - https://cdn.233.momobako.com/ygoimg/sc/
cardid
.jpg
参数:
!half
- 200px*290px的缩略图!thumb2
- 82px*120px的缩略图!thumb
- 44px*64px的缩略图!art
- 256px*256px的中间图!artp
- 290px*216px的灵摆卡中间图
示例请求:
- https://cdn.233.momobako.com/ygoimg/jp/16178681.jpg
- https://cdn.233.momobako.com/ygoimg/en/16178681.jpg!half
- https://cdn.233.momobako.com/ygopro/pics/16178681.jpg!thumb2