WOLFX DOCUMENTATION

Wolfx WebSocket API 利用説明

Wolfx WebSocket API の接続先、all_eew の除外指定、手動クエリ、JSON データ仕様。

最終更新

WebSocket の概要

  • WebSocket API は、対応する業務 JSON が更新されると、購読先のクライアントへ関連情報を自動配信します。
  • ハートビートメカニズム:サーバーは毎分、または接続確立後にハートビートパケットを送信して接続を維持します。クライアントは任意で ping パケットを返信することができます(推奨)。

接続および利用上の注意

  • 可能な限り接続を再利用し、不要な重複接続や短時間での再接続の繰り返しを避けてください。
  • 複数のデータ源を取得する場合は、下記の接続先の説明を確認し、all_eew 集約チャンネルの利用を検討してください。

WebSocket 呼び出し URL

  • all_eew では複数のデータ源の更新をまとめて受信できます。
text
wss://ws-api.wolfx.jp/all_eew

不要な更新を減らすには、任意の URL クエリパラメーター exclude に、受信対象から外したいデータ源の名前を指定します。個別の購読先の URL パスにあるデータ源名を使い、複数指定する場合はカンマ(,)で区切ります。

text
wss://ws-api.wolfx.jp/all_eew?exclude=cenc_eew
wss://ws-api.wolfx.jp/all_eew?exclude=sc_eew,fj_eew,cq_eew

exclude は接続時に指定し、その all_eew 接続の自動配信にのみ適用されます。指定を変更するには再接続してください。存在しないデータ源名を指定すると、WebSocket のハンドシェイク時に HTTP 400 が返ります。

除外した公開データ源のキャッシュ済み JSON は、同じ接続で従来の手動クエリコマンドを使って取得できます。

  • 四川省地震局 地震速報 JSON API:
text
wss://ws-api.wolfx.jp/sc_eew
  • JMA 緊急地震速報 JSON API:
text
wss://ws-api.wolfx.jp/jma_eew
  • 福建省地震局 地震速報 JSON API:
text
wss://ws-api.wolfx.jp/fj_eew
  • 重庆市地震局 地震速報 JSON API:
text
wss://ws-api.wolfx.jp/cq_eew
  • 中国地震台網 地震速報 JSON API:
text
wss://ws-api.wolfx.jp/cenc_eew
  • 中国地震台網 地震情報 JSON API:
text
wss://ws-api.wolfx.jp/cenc_eqlist
  • JMA 地震情報 JSON API:
text
wss://ws-api.wolfx.jp/jma_eqlist
  • JMA 津波情報 JSON API:
text
wss://ws-api.wolfx.jp/jma_tsunami
  • JMA 特別地震情報 JSON API:
text
wss://ws-api.wolfx.jp/jma_special_eq

WebSocket 手動クエリコマンド

手動クエリは、対応するデータ源または all_eew の接続で、そのデータ源のキャッシュ済み JSON を取得します。

  • Ping:
text
ping
  • 四川省地震局 地震速報 JSON:
text
query_sceew
  • JMA 緊急地震速報 JSON:
text
query_jmaeew
  • 福建省地震局 地震速報 JSON:
text
query_fjeew
  • 重庆市地震局 地震速報 JSON:
text
query_cqeew
  • 中国地震台網 地震速報 JSON:
text
query_cenceew
  • 中国地震台網 地震情報 JSON:
text
query_cenceqlist
  • JMA 地震情報 JSON:
text
query_jmaeqlist
  • JMA 津波情報 JSON API:
text
query_jmatsunami
  • JMA 特別地震情報 JSON API:
text
query_jmaspecialeq

WebSocket JSON データ仕様

  • 共通のJSONフィールドの説明:
FieldDescription
typeデータの種類/提供元(対応する値はAPIホームページを参照)(文字列型)
  • WebSocket ハートビート(heartbeat)パケットのJSONフィールド説明:
FieldDescription
typeheartbeat(文字列型)
verサーバーバージョン(数値型)
idクライアント接続のUUID(文字列型)
timestampハートビート送信のミリ秒単位タイムスタンプ(文字列型)
  • WebSocket Pong パケットのJSONフィールド説明:
FieldDescription
typepong(文字列型)
timestampPongパケット送信のミリ秒単位タイムスタンプ(文字列型)