Documentation Powered by ReDoc

针对Splatoon 2的stat.ink API (1.0.0)

Download OpenAPI specification:Download

URL: https://github.com/fetus-hina/stat.ink License: CC-BY 4.0

Authentication

APITokenAuth

一个有使用者授权格式的API密钥

stat.ink会给每个用户单独生成API密钥。 可以从用户设置页面获取

例子： Authorization: Bearer sD093VHLHW41b9xdaM7zVpyIX2TbIornR0h47RaUNGA

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

battle

获得用户的对战统计

返回指定的玩家统计（比如杀敌数）。

Responses

Response samples

Content type
application/json
{
  • "updated_at": {
    },
  • "entire": {
    },
  • "nawabari": {
    },
  • "gachi": {
    }
}

general

获得装备

返回装备信息列表

HTML版本: 头饰 / 衣服 / 鞋子

query Parameters
type
string
Enum: "clothing" "headgear" "shoes"

根据装备类型过滤

key装备类别
clothing衣服
headgear头饰
shoes鞋子
brand
string
Enum: "amiibo" "annaki" "cuttlegear" "enperry" "firefin" "forge" "grizzco" "inkline" "krak_on" "rockenberg" "skalop" "splash_mob" "squidforce" "takoroka" "tentatek" "toni_kensa" "zekko" "zink"

根据品牌过滤

key品牌
amiiboamiibo
annaki无府
cuttlegear乌贼牌
enperry大王乌贼
firefin火河豚
forge锻造
grizzco熊老板
inkline墨线
krak_on海蜇
rockenberg罗肯堡
skalop仙贝
splash_mob喷涂帮
squidforce乌贼力量
takoroka乌贼人
tentatek东海堂
toni_kensa剑乌贼丸
zekko贼扣
zink真可
ability
string
Enum: "ability_doubler" "bomb_defense_up" "bomb_defense_up_dx" "cold_blooded" "comeback" "drop_roller" "haunt" "ink_recovery_up" "ink_resistance_up" "ink_saver_main" "ink_saver_sub" "last_ditch_effort" "main_power_up" "ninja_squid" "object_shredder" "opening_gambit" "quick_respawn" "quick_super_jump" "respawn_punisher" "run_speed_up" "special_charge_up" "special_power_up" "special_saver" "stealth_jump" "sub_power_up" "swim_speed_up" "tenacity" "thermal_ink"

根据主技能过滤

key技能
ability_doubler技能翻倍
bomb_defense_up副武器伤害减少
bomb_defense_up_dx爆破伤害减少
cold_blooded冷血
comeback索命
drop_roller翻滚
haunt阴魂不散
ink_recovery_up回墨加速
ink_resistance_up防墨增加
ink_saver_main主武器省墨
ink_saver_sub副武器省墨
last_ditch_effort最后一博
main_power_up主武器增强
ninja_squid隐游
object_shredder毁物增强
opening_gambit一鼓作气
quick_respawn快速复活
quick_super_jump快速大跳
respawn_punisher死亡惩罚
run_speed_up走速增加
special_charge_up大招加速
special_power_up大招增强
special_saver大招损失减少
stealth_jump隐跳
sub_power_up副武器增强
swim_speed_up游速增加
tenacity韧劲十足
thermal_ink热感墨水

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

获得装备（CSV格式）

返回所有装备信息（CSV (RFC 4180)格式）

随着支持语言的增加，物品的位置可能会改变

如果使用该数据来进行自动处理，一定要检查第一行的header（或者使用JSON版本）

HTML版本: 头饰 / 衣服 / 鞋子

query Parameters
type
string
Enum: "clothing" "headgear" "shoes"

根据装备类型过滤

key装备类别
clothing衣服
headgear头饰
shoes鞋子
brand
string
Enum: "amiibo" "annaki" "cuttlegear" "enperry" "firefin" "forge" "grizzco" "inkline" "krak_on" "rockenberg" "skalop" "splash_mob" "squidforce" "takoroka" "tentatek" "toni_kensa" "zekko" "zink"

根据品牌过滤

key品牌
amiiboamiibo
annaki无府
cuttlegear乌贼牌
enperry大王乌贼
firefin火河豚
forge锻造
grizzco熊老板
inkline墨线
krak_on海蜇
rockenberg罗肯堡
skalop仙贝
splash_mob喷涂帮
squidforce乌贼力量
takoroka乌贼人
tentatek东海堂
toni_kensa剑乌贼丸
zekko贼扣
zink真可
ability
string
Enum: "ability_doubler" "bomb_defense_up" "bomb_defense_up_dx" "cold_blooded" "comeback" "drop_roller" "haunt" "ink_recovery_up" "ink_resistance_up" "ink_saver_main" "ink_saver_sub" "last_ditch_effort" "main_power_up" "ninja_squid" "object_shredder" "opening_gambit" "quick_respawn" "quick_super_jump" "respawn_punisher" "run_speed_up" "special_charge_up" "special_power_up" "special_saver" "stealth_jump" "sub_power_up" "swim_speed_up" "tenacity" "thermal_ink"

根据主技能过滤

key技能
ability_doubler技能翻倍
bomb_defense_up副武器伤害减少
bomb_defense_up_dx爆破伤害减少
cold_blooded冷血
comeback索命
drop_roller翻滚
haunt阴魂不散
ink_recovery_up回墨加速
ink_resistance_up防墨增加
ink_saver_main主武器省墨
ink_saver_sub副武器省墨
last_ditch_effort最后一博
main_power_up主武器增强
ninja_squid隐游
object_shredder毁物增强
opening_gambit一鼓作气
quick_respawn快速复活
quick_super_jump快速大跳
respawn_punisher死亡惩罚
run_speed_up走速增加
special_charge_up大招加速
special_power_up大招增强
special_saver大招损失减少
stealth_jump隐跳
sub_power_up副武器增强
swim_speed_up游速增加
tenacity韧劲十足
thermal_ink热感墨水

Responses

Response samples

Content type
text/csv
headgear,rockenberg,18k_aviators,3008,last_ditch_effort,Sonnenbrille 18K,18K Aviators,18K Aviators,Gafas aviador oro,Gafas aviador retro,Lunettes de soleil 18 ct,Lunettes de soleil 18 carats,Occhiali da sole 18K,タレサン18K,18K aviatorbril,Золотые «авиаторы»,18K金飞行墨镜,18K金飛行墨鏡
headgear,enperry,anglerfish_mask,24003,,Seeteufel-Maske,Anglerfish Mask,Anglerfish Mask,Máscara de rape abisal,Máscara abisal,Masque de baudroie,Masque de baudroie,Maschera da pesce abissale,アンコウラバーマスク,Voetbalvismasker,Маска удильщика,安康鱼面具,安康魚面具
headgear,annaki,annaki_beret,2009,ink_resistance_up,Annaki-Barrett,Annaki Beret,Annaki Beret,Boina Annak,Boina Annak,Béret Aroz,Béret Aroz,Berretto con spilla,アナアキアンピンベレー,Annaki-baret,Берет с булавкой,无府贝雷帽,無府貝雷帽
headgear,annaki,annaki_beret_and_glasses,3015,ink_saver_main,Annaki-Barrett mit Brille,Annaki Beret & Glasses,Annaki Beret & Glasses,Boina Annak con gafas,Boina Annak con gafas,Béret et lunettes Aroz,Béret et lunettes Aroz,Berretto Annak con occhiali,アナアキバスクベレー,Annaki-baret met zonnebril,Комплект «Револют»,无府贝雷帽与眼镜,無府貝雷帽與眼鏡
headgear,annaki,annaki_mask,8005,opening_gambit,Annaki-Mundschutz,Annaki Mask,Annaki Mask,Mascarilla Annak,Tapabocas negra y roja,Masque Aroz,Masque Aroz,Mascherina Annak,アナアキマスク,Annaki-mondkapje,Маска «Неформал»,无府口罩,無府口罩

获得模式

返回模式信息列表

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

获得场地

返回场地信息列表

HTML版本

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

获得武器

返回武器信息列表

HTML版本

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

获得武器（CSV格式）

返回所有武器信息（CSV (RFC 4180)格式）

随着支持语言的增加，物品的位置可能会改变

如果使用该数据来进行自动处理，一定要检查第一行的header（或者使用JSON版本）

HTML版本

Responses

Response samples

Content type
text/csv
shooter,shooter,sshooter,quickbomb,chakuchi,sshooter,sshooter,40,Kleckser,Splattershot,Splattershot,Lanzatintas,Rociador,Liquéficateur,Liquidateur,Splasher,スプラシューター,Superspetter,Каплестрел,小绿,小綠
shooter,shooter,sshooter_collabo,splashbomb,jetpack,sshooter,sshooter_collabo,41,Tentatek-Kleckser,Tentatek Splattershot,Tentatek Splattershot,Lanzatintas B,Rociador Tentáctica,Liquéficateur Tentatek,Liquidateur griffé,Splasher logo,スプラシューターコラボ,Tentatek Superspetter,Каплестрел «Щуччи»,东海堂贴牌小绿,東海堂貼牌小綠
shooter,shooter,sshooter_becchu,kyubanbomb,missile,sshooter,sshooter_becchu,42,Kensa-Kleckser,Kensa Splattershot,Kensa Splattershot,Lanzatintas elegante,Rociador Tonken,Liquéficateur Thony K,Liquidateur K,Splasher Nero Marlin,スプラシューターベッチュー,Toni Kensa Superspetter,Каплестрел от С. Кусаки,剑乌贼丸贴牌小绿,劍烏賊丸貼牌小綠
shooter,shooter,heroshooter_replica,quickbomb,chakuchi,sshooter,sshooter,45,Heldenwaffe Replik,Hero Shot Replica,Hero Shot Replica,Pistola de Élite (réplica),Rociador de élite réplica,Liquéfi. héroïque (rép.),Lanceur héroïque (réplique),Pistola élite replica,ヒーローシューター レプリカ,Heldenspetter (replica),Каплестрел-004 (клон),复刻英雄枪,復刻英雄槍
shooter,shooter,octoshooter_replica,splashbomb,jetpack,sshooter,sshooter_collabo,46,Octo Shot Replica,Octo Shot Replica,Octo Shot Replica,Pistola octariana (réplica),Pistola octariana réplica,Liquéfi. octarien (rép.),Lanceur Octaling (réplique),Octo Shot Replica,オクタシューター レプリカ,Octo Shot Replica,Octo Shot Replica,复刻章鱼小枪,復刻章魚小槍

obsoleted

获得数据（废弃）

该API已经废弃使用。

请使用这个/api/v2/stage

Responses

salmon

获得鲑鱼打工结果

返回鲑鱼打工结果

query Parameters
screen_name
string[0-9a-zA-Z_]{1,15}

根据用户过滤

如果设置only = splatnet_number，那么必需提供该参数。

only
string
Value: "splatnet_number"

改变结果集合

值
splatnet_number仅返回SplatNet的ID数
stage
string^[a-z0-9_]+$
Enum: "dam" "donburako" "polaris" "shaketoba" "tokishirazu"

根据场地过滤

key场地
dam养殖场
donburako破船湾
polaris北极星方舟废墟
shaketoba废弃前哨站
tokishirazu三文鱼烟熏厂
newer_than
integer <int32>

根据永久ID过滤

你会获得newer_than < id< older_than。

older_than
integer <int32>

根据永久ID过滤

你会获得newer_than < id< older_than。

order
string
Default: "desc"
Enum: "asc" "desc" "splatnet_asc" "splatnet_desc"

结果顺序

key
asc从旧到新
desc从新到旧（多数情况下默认）
splatnet_ascSplatNet数从小到大
splatnet_descSplatNet数从大到小（如果"only" = "splatnet_number"时的默认设置）
count
integer <int32> [ 1 .. 1000 ]
Default: 50

获取最大土地面积

接受 1-1000 (如果 only = splatnet_number)
接受 1-50 (其它)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

发布鲑鱼打工结果

发布鲑鱼打工结果

Authorizations:
APITokenAuth
Request Body schema:
appliation/json
appliation/json
application/x-msgpack
uuid
string

一个唯一的ID用来区分结果

客户端软件要设置UUID来区分重复的打工。

如何创建UUID

  • 以SplatNet 2为基础的应用

    • 使用该命名空间 418fe150-cb33-11e8-8816-d050998473ba 生成第五版的UUID

      使用"splatnet_number@principal_id"格式（比如：5436@3f6fb10a91b0c551）
      uuid_v5("418fe150-cb33-11e8-8816-d050998473ba", sprintf("%d@%s", number, principal_id))

  • 独立应用（比如用户的输入或录屏）

    • 没有任何发送（关闭重复检查）
    • 自行生成第四版的UUID
    • 使用你自己的命名空间来自行生成UUID 第三版或第五版

如果最近一天内发现同样UUID的打工，API会返回302 已找到。 这仅对简单重复有效，但是对复杂的重复检测无能为力。

我们推荐按照以下步骤发布。

  1. 用 GET /api/v2/user-salmon?only=splatnet_number 来获取已经上传的打工次数

  2. 从SplatNet 2获取数据

  3. 根据未上传的打工过滤并上传

关于 UUID， 参考RFC 4122.

如果忽略，我们会随机生成UUID。

如果该值不是正确的UUID，我们会以它为种子生成一个UUID 不要依赖该行为

splatnet_number
integer <int32>

SplatNet指定ID

stage
string^[a-z0-9_]+$
Enum: "dam" "donburako" "polaris" "shaketoba" "tokishirazu"

场地

key场地SplatNet指定ID
dam养殖场/images/coop_stage/65c68c6f0641cc5654434b78a6f10b0ad32ccdee.png
donburako破船湾/images/coop_stage/e07d73b7d9f0c64e552b34a2e6c29b8564c63388.png
polaris北极星方舟废墟/images/coop_stage/50064ec6e97aac91e70df5fc2cfecf61ad8615fd.png
shaketoba废弃前哨站/images/coop_stage/6d68f5baa75f3a94e5e9bfb89b82e7377e3ecd2c.png
tokishirazu三文鱼烟熏厂/images/coop_stage/e9f7c7b35e6d46778cd3cbc0d89bd7e1bc3be493.png
clear_waves
integer <int32> [ 0 .. 3 ]

打通几波

如果完成打工就是3。如果第一阶段就失败则为0。

fail_reason
string^[a-z0-9_]+$
Enum: "time_limit" "wipe_out"

失败原因

如果完成打工或未知即为null或空白字符。

key原因
time_limit时间到
wipe_out全员阵亡
title
string^[a-z0-9_]+$
Enum: "intern" "apprentice" "part_timer" "go_getter" "overachiever" "profreshional"

称号（打工之前）

key称号SplatNet指定ID
intern实习生
apprentice学徒1
part_timer兼职员工2
go_getter潜力股3
overachiever绩优生4
profreshional专业人士5
title_exp
integer <int32> [ 0 .. 999 ]

称号分数（打工之后）

40就是专业的40分之999。

title_after
string^[a-z0-9_]+$
Enum: "intern" "apprentice" "part_timer" "go_getter" "overachiever" "profreshional"

称号（打工之后）

title_exp_after
integer <int32> [ 0 .. 999 ]

称号分数（打工之前）

40就是专业的40分之999。

danger_rate
number <float> decimal places <= 1 [ 0 .. 200 ]

危险系数，200.0 = 最危险！

object

关主出现次数

如果你的客户端没有该数据，忽略它或者是设为null。

如果该关主没有出现，你可以输入0或者忽略该关主。

{
  "boss_appearances": null, // OK
}

{
  "boss_appearances": { // OK: you can omit bosses if not necessary.
  },
}

{
  "boss_appearances": {
    "scrapper": 0, // OK: you can send 0
  },
}
key关主SplatNet指定ID
drizzler雨怪21sakerocket
flyfish垃圾桶9sakelien-cup-twins
goldie金鱼3sakelien-golden
griller烧烤架16sakedozer
maws遁地鲨15sakediver
scrapper铁车12sakelien-shield
steel_eel长龙铁鳗13sakelien-snake
steelhead绿帽怪6sakelien-bomber
stinger塔怪14sakelien-tower
Array of objects (__2fmy__Wave) [ 1 .. 3 ] items

每波的信息

如果你的客户端没有该数据，忽略它或者是设为null。

object (__2id7__Player)

玩家的数据

Array of objects (__2id7__Player) [ 1 .. 3 ] items

打工成员数据（除自己的数据以外），通常还有三个

shift_start_at
integer <int64>

对战排班起始时间使用UNIX时间格式。

start_at
integer <int64>

打工开始时间使用UNIX时间格式。

end_at
integer <int64>

打工结束时间使用UNIX时间格式。

注意：SplatNet的JSON数据中可能没有该值。

note
string

用户笔记

private_note
string

用户私人笔记

link_url
string <uri>

相关网址（比如YouTube视频地址）

automated
string
Enum: "yes" "no"

是自动化上传吗？

value
yes如果自动输入
no如果手动输入

如果该用户的上传数据可以任意选择，请选择 no。

agent
string <= 64 characters

你的客户端名称

如果设置了agent_version， 那么必需提供该参数。

agent_version
string <= 255 characters

你的客户端版本

如果设置了agent， 那么必需提供该参数。

Responses

Request samples

Content type
appliation/json
appliation/json
application/x-msgpack
{
  • "uuid": "4c705dd6-7a22-5f04-865d-d87413b0970d",
  • "splatnet_number": 5436,
  • "stage": "tokishirazu",
  • "clear_waves": 1,
  • "fail_reason": "wipe_out",
  • "title": "profreshional",
  • "title_exp": 410,
  • "title_after": "profreshional",
  • "title_exp_after": 405,
  • "danger_rate": 174.2,
  • "boss_appearances": {
    },
  • "waves": [
    ],
  • "my_data": {
    },
  • "teammates": null,
  • "shift_start_at": 1573106400,
  • "start_at": 1573151096,
  • "end_at": null,
  • "note": null,
  • "private_note": null,
  • "link_url": null,
  • "automated": "yes",
  • "agent": "splatnet2statink",
  • "agent_version": "1.5.3"
}

获得鲑鱼打工结果

返回鲑鱼打工结果

path Parameters
id
required
integer <int32>

结果的永久ID

Responses

Response samples

Content type
application/json
{
  • "id": 137857,
  • "uuid": "4c705dd6-7a22-5f04-865d-d87413b0970d",
  • "splatnet_number": 5436,
  • "url": "https://stat.ink/@fetus_hina/salmon/137857",
  • "api_endpoint": "https://stat.ink/api/v2/salmon/137857",
  • "stage": {
    },
  • "is_cleared": false,
  • "fail_reason": {
    },
  • "clear_waves": 1,
  • "danger_rate": "174.2",
  • "quota": [
    ],
  • "title": {
    },
  • "title_exp": 410,
  • "title_after": {
    },
  • "title_exp_after": 405,
  • "boss_appearances": {
    },
  • "waves": [
    ],
  • "my_data": {
    },
  • "teammates": null,
  • "agent": {
    },
  • "automated": true,
  • "note": null,
  • "link_url": null,
  • "shift_start_at": {
    },
  • "start_at": {
    },
  • "end_at": null,
  • "register_at": {
    }
}

获得鲑鱼打工结果（有授权）

返回鲑鱼打工结果

你只能获得该用户API密钥授权的数据。

Authorizations:
APITokenAuth
query Parameters
only
string
Value: "splatnet_number"

改变结果集合

值
splatnet_number仅返回SplatNet的ID数
stage
string^[a-z0-9_]+$
Enum: "dam" "donburako" "polaris" "shaketoba" "tokishirazu"

根据场地过滤

key场地
dam养殖场
donburako破船湾
polaris北极星方舟废墟
shaketoba废弃前哨站
tokishirazu三文鱼烟熏厂
newer_than
integer <int32>

根据永久ID过滤

你会获得newer_than < id< older_than。

older_than
integer <int32>

根据永久ID过滤

你会获得newer_than < id< older_than。

order
string
Default: "desc"
Enum: "asc" "desc" "splatnet_asc" "splatnet_desc"

结果顺序

key
asc从旧到新
desc从新到旧（多数情况下默认）
splatnet_ascSplatNet数从小到大
splatnet_descSplatNet数从大到小（如果"only" = "splatnet_number"时的默认设置）
count
integer <int32> [ 1 .. 1000 ]
Default: 50

获取最大土地面积

接受 1-1000 (如果 only = splatnet_number)
接受 1-50 (其它)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获得鲑鱼打工统计（卡片数据）

返回鲑鱼打工统计

你只能获得该用户API密钥授权的数据。

Authorizations:
APITokenAuth
query Parameters
id
integer <int32> >= 1

永久ID

如果忽略了 id, 你会得到最新的数据.

id的值来自于POST API的头部位置的报文。

如果你设置了其他玩家的id， 你会得到一个404错误。

Responses

Response samples

Content type
application/json
{
  • "work_count": 388,
  • "total_golden_eggs": 4886,
  • "total_eggs": 177331,
  • "total_rescued": 780,
  • "total_point": 47034,
  • "as_of": {
    },
  • "registered_at": {
    }
}

发布鲑鱼打工统计（卡片数据）

发布鲑鱼打工统计（卡片数据）

Authorizations:
APITokenAuth
Request Body schema:
appliation/json
appliation/json
application/x-msgpack
work_count
integer <int32> >= 0

鲑鱼打工次数

total_golden_eggs
integer <int32> >= 0

金蛋收集数量

total_eggs
integer <int32> >= 0

收集的能量蛋数

total_rescued
integer <int32> >= 0

救援队友数量

total_point
integer <int32> >= 0

总分数

as_of
integer <int64> >= 1538528400

数据获取时间（UNIX时间戳）

如果忽略，就会使用当前日期

Responses

Request samples

Content type
appliation/json
appliation/json
application/x-msgpack
{
  • "work_count": 5436,
  • "total_golden_eggs": 77806,
  • "total_eggs": 3042663,
  • "total_rescued": 13258,
  • "total_point": 966048,
  • "as_of": 1573153685
}