splapi API Version 1.5.0

スプラトゥーンのステージ情報を返すAPIです。適当に使って構いませんが、自分用APIなので完全に無保証です。

知識のない利用者の相手をする気もありませんのでわからなければあきらめてください。


API Basics

Stages API (Regular, Ranked, Splatfest)

ステージ情報 API のエンドポイントは次の通りになります。 ...{AAA|BBB|CCC}... は「AAAまたはBBBまたはCCC」の意味です。 絞り込み機能等はありません。

【形式1・形式2】選択可能なパラメータの意味は次の通りです。

【形式3】形式3のインタフェースでは、現在から未来にかけて開催されている・開催されるステージ情報をまとめて返却します。 (regular/schedule + gachi/schedule をまとめて返します。)

Response Structure

ステージ情報APIは次の形式で応答します。 応答は valid な JSON であることのみが規定され、スペースや改行がどのようになるかは不定です。 また、文字列がどのように表現されるかも規定しません。 (実際には可能な限りエスケープを行わない文字列表現を使い、改行等を行わないレスポンスが返されますが、これに依存してはいけません) また、要素の出現順も規定しません。

【形式1・2】:

{
  "result": [
    {
      "rule": "ナワバリバトル",
      "rule_ex": {
        "statink": "nawabari",
        "name_id": "turf_war",
        "name_en": "Turf War",
        "name":"ナワバリバトル"
      },
      "maps": [
        "タチウオパーキング",
        "モンガラキャンプ場"
      ],
      "maps_ex": [
        {
          "statink": "tachiuo",
          "name_id": "moray_towers",
          "name_en": "Moray Towers",
          "name": "タチウオパーキング"
        },
        {
          "statink": "mongara",
          "name_id": "camp_triggerfish",
          "name_en": "Camp Triggerfish",
          "name": "モンガラキャンプ場"
        }
      ],
      "start": "2016-12-15T19:00:00",
      "start_utc": "2016-12-15T10:00:00+00:00",
      "start_t": 1481796000,
      "end": "2016-12-15T23:00:00",
      "end_utc": "2016-12-15T14:00:00+00:00",
      "end_t": 1481810400
      // "team": [ "アオリ", "ホタル" ]
    },
    // ...
  ],
  "source": {
    // ...
  }
}

【形式3】:(省略部分は形式1, 2の例を参照してください)

{
  "result": {
    "regular": [
      { /* ... (現在のステージ) */ },
      { /* ... (次のステージ) */ },
      { /* ... (その次のステージ) */ }
    ],
    "gachi": [
      { /* ... (現在のステージ) */ },
      { /* ... (次のステージ) */ },
      { /* ... (その次のステージ) */ }
    ]
  },
  "source": { /* ... */ }
}

Date and Time

開始・終了を示す値は、start, start_utc, start_t のように 3 通りの表現で返されます。 (終了の場合は s/start/end/ した項目)

それぞれの示す時間は同じであることが保障されます。 利用者の都合で適当に使い分けてください。

Response Structure when stat_ink=on

stat_ink=on パラメータが指定されているとき、maps 部分が次のように変わります。

"maps": [
  {"origin_name":"タチウオパーキング","stat_ink_name":"tachiuo"},
  {"origin_name":"モンガラキャンプ場","stat_ink_name":"mongara"}
]

stat_ink_nameに現れるID文字列はを確認してください。

"Source" information

API 1.5.0 以降、レスポンスには source 構造が含まれます。

内容は見れば大体想像できる内容だと思いますが、 これは主にサーバ管理上の都合で応答に含むもので、利用者による使用は想定していません。

従って、内容の構造体については未定義扱いとしてください。

サイト名やURLも含まれて見えると思いますが、これを表示する義務等はありませんし、 そもそもここに到達可能なURLが記載されるとは限りません。 (外部から到達不可能な、例えば http://127.0.0.1:8080/ 等が出力される可能性があります)


Identifiers

Identifiers - Rule (mode)

ルールの stat.ink 連携用、splapi.fetus.jp 定義の独自識別子一覧です。 これらの識別子をアプリケーションはルールの特定に利用可能です。 (nameベースで識別するよりはマシなコードが書けると思います)

名称(日本語) 名称(英語) stat.ink定義識別子 独自定義識別子
ナワバリバトル Turf War nawabari turf_war
ガチエリア Splat Zones area splat_zones
ガチヤグラ Tower Control yagura tower_control
ガチホコ Rainmaker hoko rainmaker

Identifiers - Map (stage)

ステージの stat.ink 連携用、splapi.fetus.jp 定義の独自識別子一覧です。 これらの識別子をアプリケーションはルールの特定に利用可能です。 (nameベースで識別するよりはマシなコードが書けると思います)

名称(日本語) 名称(英語) stat.ink定義識別子 独自定義識別子
デカライン高架下 Urchin Underpass dekaline urchin_underpass
ハコフグ倉庫 Walleye Warehouse hakofugu walleye_warehouse
シオノメ油田 Saltspray Rig shionome saltspray_rig
アロワナモール Arowana Mall arowana arowana_mall
Bバスパーク Blackbelly Skatepark bbass blackbelly_skatepark
ホッケふ頭 Port Mackerel hokke port_mackerel
モズク農園 Kelp Dome mozuku kelp_dome
ネギトロ炭鉱 Bluefin Depot negitoro bluefin_depot
タチウオパーキング Moray Towers tachiuo moray_towers
モンガラキャンプ場 Camp Triggerfish mongara camp_triggerfish
ヒラメが丘団地 Flounder Heights hirame flounder_heights
マサバ海峡大橋 Hammerhead Bridge masaba hammerhead_bridge
キンメダイ美術館 Museum d'Alfonsino kinmedai museum_d_alfonsino
マヒマヒリゾート&スパ Mahi-Mahi Resort mahimahi mahi_mahi_resort
ショッツル鉱山 Piranha Pit shottsuru piranha_pit
アンチョビットゲームズ Ancho-V Games anchovy ancho_v_games

Change Log

バージョン番号はセマンティックバージョニングっぽくつけます。


Users