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

Bearer 認証フォーマットされた API トークン

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) 形式で返します。

サポートする言語が変化すると、項目の場所がずれる場合があります。

自動処理に使用する場合は、1行目のヘッダを確認してください。もしくは、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 Aviators
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,Маска удильщика,安康鱼面具,Anglerfish Mask
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,Берет с булавкой,无府贝雷帽,Annaki Beret
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,Комплект «Револют»,无府贝雷帽与眼镜,Annaki Beret & Glasses
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,Маска «Неформал»,无府口罩,Annaki Mask

ルールを取得

ルール情報を配列で返します

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) 形式で返します。

サポートする言語が変化すると、項目の場所がずれる場合があります。

自動処理に使用する場合は、1行目のヘッダを確認してください。もしくは、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,Каплестрел,小绿,Splattershot
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,Каплестрел «Щуччи»,东海堂贴牌小绿,Tentatek Splattershot
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,Каплестрел от С. Кусаки,剑乌贼丸贴牌小绿,Kensa Splattershot
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 (клон),复刻英雄枪,Hero Shot Replica
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,复刻章鱼小枪,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イカリング2の番号のみを返します
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_ascイカリングの番号が小さいものから大きいもの
splatnet_descイカリングの番号が大きいものから小さいもの ("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 の作り方:

  • イカリング2ベースのアプリケーション

    • 名前空間 418fe150-cb33-11e8-8816-d050998473ba を使用して、Version 5 UUID を生成します

      "splatnet_number@principal_id" の形式を利用してください（例：5436@3f6fb10a91b0c551）
      uuid_v5("418fe150-cb33-11e8-8816-d050998473ba", sprintf("%d@%s", number, principal_id))

  • スタンドアロンアプリケーション（例: ユーザ入力やスクリーンキャプチャ）

    • 何も送信しない（重複検出は無効になります）
    • Version 4 UUID を生成して送信します
    • Version 3 か 5 の UUID を生成して送信します（名前空間はあなたのアプリケーションで独自に定義してください）

24 時間以内に同一の UUID が送信された場合、302 Found が返ります。
この UUID は意図しない重複の検出に役立ちますが、完全な検出は行いません。

次の手順に従って処理してください:

  1. GET /api/v2/user-salmon?only=splatnet_number を呼び出して、すでに登録済みのバイト番号を取得します。

  2. イカリング2からデータを取得します。

  3. 未登録のバイトを抽出して、投稿します。

UUID については RFC 4122 を参照してください。

省略された場合、自動的にランダムな UUID を生成します。

UUID として正しくない形式が与えられた場合、その値を元に UUID が生成されます。 この挙動に依存しないでください。

splatnet_number
integer <int32>

イカリング定義のID

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

ステージ

keyステージイカリング定義の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 ]

クリアした WAVE 数

クリアしたら 3、WAVE 1 で落ちたら 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称号イカリング定義のID
internけんしゅう
apprenticeかけだし1
part_timerはんにんまえ2
go_getterいちにんまえ3
overachieverじゅくれん4
profreshionalたつじん5
title_exp
integer <int32> [ 0 .. 999 ]

称号ポイント（バイト前）

たつじん 40/999 なら 40 を指定します。

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

称号（バイト後）

title_exp_after
integer <int32> [ 0 .. 999 ]

称号ポイント（バイト後）

たつじん 40/999 なら 40 を指定します。

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

キケン度、200.0 = キケン度MAX

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オオモノシャケイカリング定義の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

各 WAVE の情報

クライアントがこのデータを検出しない/できない場合、フィールドごと省略するか、単に null を送信してください。

object (__2id7__Player)

自分のデータ

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

仲間のデータ（自分のデータを除く）。典型的には3要素

shift_start_at
integer <int64>

バイト期間（プレイ期間）が開始された日時を UNIX タイムスタンプで指定します。

start_at
integer <int64>

このバイトが開始された日時を UNIX タイムスタンプで指定します。

end_at
integer <int64>

このバイトが終了した日時を UNIX タイムスタンプで指定します。

メモ: この値はイカリング2のJSONには含まれていません。

note
string

ユーザによるメモ

private_note
string

非公開メモ

link_url
string <uri>

この投稿に関連する URL（例えば 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"
}

サーモンラン結果を取得（1件）

サーモンランの結果を返します。

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イカリング2の番号のみを返します
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_ascイカリングの番号が小さいものから大きいもの
splatnet_descイカリングの番号が大きいものから小さいもの ("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 の Location ヘッダから取得できます。

他人の 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
}