WOLFX DOCUMENTATION

Wolfx SeisJS API Documentation

SeisJS station, WebSocket connection, and observation data field documentation.

Last updated
Document version
v20250704

Overview

  • Data push interval per station: 1 second
  • Seismic intensity standard: Japan Meteorological Agency (JMA)
  • Ground motion intensity standard: Chinese national intensity standard (based on GB/T 17742-2020)
  • This API provides real-time data from SeisJS stations via WebSocket
  • Heartbeat mechanism: the server sends a `heartbeat` packet upon connection and every minute; the client may optionally respond with `ping` (recommended)
  • Disclaimer: This API only provides station data from SeisJS for legal research and development use. Any other usage is prohibited.

Available Station List

  • Station List JSON URL: https://api.wolfx.jp/seis_list.json
  • Note: For application development, it is recommended to use this station list API to retrieve real-time station status for cloud-based control. The list updates every 10 minutes.

WebSocket Endpoint

  • Receive JSON data from all SeisJS stations:
text
wss://seisjs.wolfx.jp/all_seis

JSON Field Description (Data Types)

FieldDescription
typeStation UUID (String)
regionStation location (String)
latitudeStation latitude (Number)
longitudeStation longitude (Number)
versionSeisJS version running on the station (Number)
PGAComposite Peak Ground Acceleration (cm/s²) (Number)
PGVComposite Peak Ground Velocity (cm/s) (Number)
PGDComposite Peak Ground Displacement (cm) (Number)
PGA_EWEast-West Peak Ground Acceleration (cm/s²) (Number)
PGV_EWEast-West Peak Ground Velocity (cm/s) (Number)
PGD_EWEast-West Peak Ground Displacement (cm) (Number)
PGA_NSNorth-South Peak Ground Acceleration (cm/s²) (Number)
PGV_NSNorth-South Peak Ground Velocity (cm/s) (Number)
PGD_NSNorth-South Peak Ground Displacement (cm) (Number)
PGA_UDVertical Peak Ground Acceleration (cm/s²) (Number)
PGV_UDVertical Peak Ground Velocity (cm/s) (Number)
PGD_UDVertical Peak Ground Displacement (cm) (Number)
Max_PGAMax composite PGA within 2 minutes (cm/s²) (Number)
Max_PGVMax composite PGV within 2 minutes (cm/s) (Number)
Max_PGDMax composite PGD within 2 minutes (cm) (Number)
Max_PGA_EWMax East-West PGA within 2 minutes (cm/s²) (Number)
Max_PGV_EWMax East-West PGV within 2 minutes (cm/s) (Number)
Max_PGD_EWMax East-West PGD within 2 minutes (cm) (Number)
Max_PGA_NSMax North-South PGA within 2 minutes (cm/s²) (Number)
Max_PGV_NSMax North-South PGV within 2 minutes (cm/s) (Number)
Max_PGD_NSMax North-South PGD within 2 minutes (cm) (Number)
Max_PGA_UDMax Vertical PGA within 2 minutes (cm/s²) (Number)
Max_PGV_UDMax Vertical PGV within 2 minutes (cm/s) (Number)
Max_PGD_UDMax Vertical PGD within 2 minutes (cm) (Number)
ShindoComposite JMA Seismic Intensity (String)
Max_ShindoMax JMA Seismic Intensity within 2 minutes (String)
CalcShindoComposite Calculated JMA Seismic Intensity (Number)
Max_CalcShindoMax Calculated JMA Seismic Intensity within 2 minutes (Number)
IntensityComposite CSIS Intensity (Number)
Max_IntensityMax CSIS Intensity within 2 minutes (Number)
LPGMLong-Period Ground Motion Level (Number)
Max_LPGMMax Long-Period Ground Motion Level within 2 minutes (Number)
Sva30Spectral Acceleration Value (Number)
Max_Sva30Max Spectral Acceleration Value within 2 minutes (Number)
error_codeError codes reported by station (Array of Numbers)
reverseReserved field for server-side validation (String)
is_desktopIndicates if the client is a desktop (Boolean)
High_PrecisionIndicates if the station is high-precision (Boolean)
update_atData update timestamp (String)
create_atJSON generation timestamp (String)

WebSocket Manual Commands

  • Ping:
text
ping

WebSocket JSON Field Specification

  • Common JSON Field:
FieldDescription
typeData type / Station UUID (String)
  • WebSocket Heartbeat Packet Fields:
FieldDescription
typeheartbeat (String)
verServer version (Number)
idClient connection UUID (String)
timestampTimestamp in milliseconds (String)
  • WebSocket Pong Packet Fields:
FieldDescription
typepong (String)
timestampTimestamp in milliseconds (String)

API Documentation Version: v20250704