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
}