JX3TNT 开放平台开发文档

JX3TNT 开发者文档

几分钟了解如何
查询榜单与招募数据

本文档面向剑三机器人和社区工具开发者。榜单与角色接口返回 JSON;Boss 峰值图和招募组合快照返回已经生成好的 PNG。

完全免费只读查询资料审核后开通每个 Token 独立统计用量

开始前准备

JX3TNT 开放平台复用主站手机号账号。你不需要再记一套账号,但需要单独提交开发者接入申请。

01登录账号使用 JX3TNT 主站手机号账号登录。
02提交申请填写应用名称、用途、QQ 和预计调用量。
03等待审核审核通过后会向主站账号已验证手机号发送通知;未通过原因可在开发者个人中心查看。
04创建 Token审核通过后,在开发者中心自行创建。
API 地址https://api.jx3tnt.com
返回格式JSON;峰值图为 image/png
使用提醒:Token 只限申请时登记的主体和应用使用。发现转借、共享、泄露、一号多用或违规多号一用等情况,平台会立即暂停相关服务。

身份验证

调用接口时,把 Token 放在请求头中。下面的 <你的 Token> 替换成开发者中心创建时显示的内容。

Authorization: Bearer <你的 Token>

Token 创建成功时只完整显示一次。建议保存在机器人服务端的环境变量或安全配置中,不要直接写进公开代码。

最简单的调用示例

curl -H "Authorization: Bearer <你的 Token>" \
  "https://api.jx3tnt.com/v1/recruitments/snapshot.png" \
  --output recruitments.png

先查看可查询内容

返回当前赛季、榜单类型、副本、Boss、心法和已生成图表目录。

GET
/v1/meta

建议机器人先读取这个接口,不要把赛季或 Boss ID 长期写死。需要查看历史赛季时,可以增加 seasonId

curl -H "Authorization: Bearer <你的 Token>" \
  "https://api.jx3tnt.com/v1/meta"

查询角色榜单

按服务器和角色名,查询宗师榜·英雄与宗师榜·巅峰成绩。

GET
/v1/characters/rankings?serverName=乾坤一掷&characterName=咸鱼

需要填写的参数

参数是否必填说明
serverName必填角色所在服务器,必须填写完整名称,例如“乾坤一掷”。
characterName必填角色名称,必须精确填写,例如“咸鱼”。
bossId选填可直接填写 Boss 中文名或 ID;填写后查看这个 Boss 在两个宗师榜中的分值与 DPS/HPS。
seasonId选填查看指定赛季;不填时使用最新正式快照。

查询“乾坤一掷”的角色“咸鱼”

curl -G "https://api.jx3tnt.com/v1/characters/rankings" \
  -H "Authorization: Bearer <你的 Token>" \
  --data-urlencode "serverName=乾坤一掷" \
  --data-urlencode "characterName=咸鱼"

返回示例(字段结构示意)

{
  "ok": true,
  "query": {
    "serverName": "乾坤一掷",
    "characterName": "咸鱼"
  },
  "snapshotVersion": "2026-07-22-01",
  "generatedAt": "2026-07-22T03:00:00.000Z",
  "snapshotUpdatedAt": "2026-07-22T03:00:00.000Z",
  "snapshotUpdatedAtText": "2026-07-22 11:00:00(北京时间)",
  "data": [
    {
      "leaderboardKind": "grandmaster_peak",
      "rank": 12,
      "value": 113.0126,
      "score": 113.0126,
      "character": {
        "serverName": "乾坤一掷",
        "characterName": "咸鱼",
        "schoolName": "七秀",
        "kungfuId": "10081",
        "kungfuName": "冰心诀"
      },
      "reportUrl": "/reports/..."
    }
  ]
}

查看这个角色在“笑妆娘”的分值和 DPS

curl -G "https://api.jx3tnt.com/v1/characters/rankings" \
  -H "Authorization: Bearer <你的 Token>" \
  --data-urlencode "serverName=乾坤一掷" \
  --data-urlencode "characterName=咸鱼" \
  --data-urlencode "bossId=笑妆娘"
怎么看结果:接口会从角色榜单资料自动识别心法。同一角色有多个心法上榜时会全部返回,不需要开发者填写心法 ID。不填写 Boss 时,rankscore 是两个宗师榜的总榜排名与综合分值;填写 Boss 后,boss.scoreboss.dpsboss.hps 是该 Boss 的成绩,overallRankoverallScore 保留总榜信息。角色或所选 Boss 没有上榜数据时,data 返回空数组,message 给出完整中文提示,action.textaction.url 可直接渲染为上传战报链接。

返回空值时怎么显示

data 是空数组时,请在原本显示榜单名次或分值的位置显示 message。如果你的产品支持点击链接,请把 action.text 显示为文字,并链接到 action.url

{
  "ok": true,
  "data": [],
  "message": "该角色数据未进入榜单,如需上榜,请前往www.Jx3TNT.com上传战报。",
  "action": {
    "text": "www.Jx3TNT.com 上传战报。",
    "url": "https://www.jx3tnt.com/"
  }
}

机器人无数据提示(Markdown)

该角色数据未进入榜单,如需上榜,请前往 [www.Jx3TNT.com 上传战报。](https://www.jx3tnt.com/)

使用场景建议

角色榜单查询卡片示例
角色查询卡片示例

详细榜单与深度数据:建议设计成独立命令或单独查询页,按榜单、Boss、门派或心法调用对应接口。角色接口负责角色摘要;名侠榜完整列表仍通过 /v1/leaderboards/mingxia_regular_dps 单独查询,避免让一次角色查询返回过大的结果。

请务必显示快照更新时间:直接展示每次响应中的 snapshotUpdatedAtText,不要用机器人回复时间或页面打开时间代替。

查询榜单前 100

查询一个榜单的正式排名;宗师两榜和名侠榜可继续按心法筛选。

GET
/v1/leaderboards/{leaderboardKind}

可查询的榜单

grandmaster_peak宗师榜·巅峰
grandmaster_hero宗师榜·英雄
mingxia_regular_dps名侠榜
team_speed_hero团队竞速·英雄
team_top10_top100十甲/百强团队榜
site_death死神榜

可选筛选参数

参数说明
dungeonId只查看指定副本。
bossId只查看指定 Boss。查询名侠榜时通常与副本一起使用。
keyword宗师榜·英雄、宗师榜·巅峰和名侠榜可填写中文门派或心法,例如“蓬莱”或“山海心诀”。死神榜不支持此参数。
seasonId查看指定赛季;不填时使用最新正式快照。
view宗师榜·巅峰可填写 oneSectMaster,列出每个心法的榜首角色。
limit返回数量,最少 1 条、最多 100 条,默认 100 条。

查询名侠榜前 100

curl -G "https://api.jx3tnt.com/v1/leaderboards/mingxia_regular_dps" \
  -H "Authorization: Bearer <你的 Token>" \
  --data-urlencode "dungeonId=<副本 ID>" \
  --data-urlencode "bossId=<Boss ID>" \
  --data-urlencode "limit=100"

查询一派宗师

curl -G "https://api.jx3tnt.com/v1/leaderboards/grandmaster_peak" \
  -H "Authorization: Bearer <你的 Token>" \
  --data-urlencode "view=oneSectMaster"

查询宗师榜·英雄的“山海心诀”排名

curl -G "https://api.jx3tnt.com/v1/leaderboards/grandmaster_hero" \
  -H "Authorization: Bearer <你的 Token>" \
  --data-urlencode "keyword=山海心诀" \
  --data-urlencode "limit=100"

查询“笑妆娘”的蓬莱名侠榜

curl -G "https://api.jx3tnt.com/v1/leaderboards/mingxia_regular_dps" \
  -H "Authorization: Bearer <你的 Token>" \
  --data-urlencode "bossId=笑妆娘" \
  --data-urlencode "keyword=蓬莱" \
  --data-urlencode "limit=100"

查询当前赛季死神榜

curl -H "Authorization: Bearer <你的 Token>" \
  "https://api.jx3tnt.com/v1/leaderboards/site_death"

返回结果中的角色名与主站死神榜采用同一稳定脱敏方式;averageDeaths 是角色本赛季场均死亡数,participationCount 是本赛季击败 BOSS 次数。同一场战斗重复上传不会重复计算。

组合筛选:宗师两榜和名侠榜默认只返回常规 DPS 榜单数据,可用 keyword 按门派或心法筛选,并与 bossIdseasonIdlimit 组合。死神榜不接受心法筛选。接口保留正式榜单的 rank,不会按筛选结果重新编号;没有符合项时返回空数组。

下载 Boss 全职业峰值图

返回这个 Boss 当前各心法的 DPS/HPS 峰值柱状图。

GET
/v1/charts/bosses/{bossId}/peaks.png

输出心法使用 DPS、防御心法使用 DPS、治疗心法使用 HPS。图片随正式榜单快照预先生成,查询时不会重新统计或现场绘图;图片底部会直接标注快照更新时间。

curl -G "https://api.jx3tnt.com/v1/charts/bosses/<Boss ID>/peaks.png" \
  -H "Authorization: Bearer <你的 Token>" \
  --data-urlencode "dungeonId=<副本 ID>" \
  --output boss-peaks.png

下载今日与长期招募组合快照

返回一张适合机器人直接发送的公开招募 PNG 图片。

GET
/v1/recruitments/snapshot.png

图片上半部分按预发车时间列出今日预报名活动,包括站内团牌、招募信息、副本、报名情况和预发车时间;下半部分从已经公开、审核通过且由用户真实上传的长期招募海报中选取一张宽屏展示。没有合格海报时会显示明确的空态,不会生成替代海报。

图片随正式招募快照预先生成,同一快照内内容固定,调用时不会重复读取数据库或临时抽取海报;图片底部会直接标注快照更新时间。这个接口不需要额外参数,也不包含联系方式、报名成员或团队内部排期。

curl -H "Authorization: Bearer <你的 Token>" \
  "https://api.jx3tnt.com/v1/recruitments/snapshot.png" \
  --output recruitments.png

即将开放

指定团队查询

/v1/teams/profile?serverName=乾坤一掷&teamName=示例团队

查询团队评价、赛季历史工资,以及单次最高收益的掉落列表与工资。

团队赛季收益榜前 100

/v1/leaderboards/team_season_income?seasonId=<赛季 ID>&limit=100

查询团队赛季累计收益前 100 名,并返回榜单快照更新时间。

查询 Token 用量

查看当前 Token 的今日和本月调用情况。

GET
/v1/usage

本站接口对剑三机器人开发者完全免费。日/月额度只用于保障安全与公平使用;有真实提升额度需求时,可以在开发者中心申请更高额度 Token。

{
  "ok": true,
  "billingMode": "free",
  "data": {
    "dailyQuota": 1000,
    "dailyUsed": 36,
    "monthlyQuota": 10000,
    "monthlyUsed": 628
  }
}

理解返回结果

字段含义
oktrue 表示调用成功,false 表示需要查看错误信息。
data本次查询到的榜单、招募或用量数据。
snapshotVersion本次榜单数据版本,方便确认两次查询是否使用同一批数据。
generatedAt数据生成时间,采用 ISO 8601 时间格式。
snapshotUpdatedAt本次正式快照更新时间,采用 ISO 8601 时间格式,便于程序处理。
snapshotUpdatedAtText已经转换成北京时间的快照更新时间,可直接展示给用户。
metricType说明数值是分值、DPS、HPS、场均死亡数或团队成绩。

榜单按固定时间更新。更新完成后,接口直接读取已经生成好的榜单数据,不会在每次查询时重新计算,也不会把临时结果作为正式榜单返回。建议在展示每一份榜单时同时显示 snapshotUpdatedAtText,让用户知道数据更新到了什么时间。

常见错误

400参数填写有误。检查服务器、角色名、榜单类型和筛选条件。
401Token 缺失、无效、过期或已经停用。
403当前 Token 没有开通这个查询权限。
404指定赛季不存在,或该 Boss 暂无已生成图表。
429调用过于频繁或本日/本月额度已经用完。
503服务或榜单数据暂时不可用,请稍后重试。

错误返回示例

{
  "ok": false,
  "error": {
    "code": "OPEN_API_TOKEN_INVALID",
    "message": "API Token 无效。"
  }
}

数据来源与帮助

权威榜单需要更多真实玩家数据才更有价值。如果你的产品方便展示来源,建议在查询结果旁保留下面的说明,引导玩家上传战报并认领角色。这能让榜单样本更完整,也能让开发者持续获得更可靠的数据。

数据来源:JX3TNT.COM 剑网三天梯榜 更多玩家个人数据请到天梯榜官网上传和认领自己的角色https://www.jx3tnt.com/

联系我们

JX3天梯榜API交流群:1042441268。仅为交流群,非审核通道。

如果需要程序自动读取全部字段说明,可以查看 机器可读接口文档