J-SHIS | Japan Seismic Hazard Information Station

submenu Sitemap Contact Us J-SHIS 地震ハザードステーション
Start J-SHIS Maps

Damaging Fault Search API for municipality

This API provides damaging faults which largely affect on a specified municipality.

Version

1.0.0

Request URL

http://www.j-shis.bosai.go.jp/map/api/fltsearch?areacode=areacode&ecode=ecode&mode=mode&version=version&case=case&period=period&format=format&options
http://www.j-shis.bosai.go.jp/map/api/areacode/fltsearch?ecode=ecode&mode=mode&version=version&case=case&period=period&format=format&options

Table of contents

Request

– URL
– Parameters

Response

– Status code
– Normal case
– JSON format
– XML format
– Error case
– Error classification code
– JSON format
– XML format

Request

URL

In the URL, bold characters indicate a request parameter; superscript number corresponds to the No. in parameter list.

http://www.j-shis.bosai.go.jp/map/api/fltsearch?areacode=areacode1&ecode=ecode2&mode=mode3&version=version4&case=case5&period=period6&format=format7&options8
http://www.j-shis.bosai.go.jp/map/api/areacode1/fltsearch?ecode=ecode2&mode=mode3&version=version4&case=case5&period=period6&format=format7&options8
Parameters

Request parameters of the API are as follows. The parameters are case-sensitive.

No Parameter Dispensability Input value and Description
1 areacode Required Five digits with prefix “A” are composed of double digits of prefectural code (JISX0401) and three digits of municipal code as examples given.

  • municipality…A + prefectural code (2-digit) + municipal code (3-digit)
  • prefecture…A + prefectural code (2-digit) + ‘000’
2 ecode Required Population type code

  • Nighttime population…ALL_NT_A
  • Daytime population…ALL_DT_A
3 mode Required Scenario earthquake code

  • Conditional Probability of Exceedance (CPE)…C
  • Seismic Hazard Maps for Specified Seismic Source Faults (SESM)…S
4 version Required Map version

  • 2008 version…Y2008
  • 2009 version…Y2009
  • 2010 version…Y2010
  • 2011 version…Y2011
  • 2012 version (model 1)…Y2012
  • 2012 version (model 2)…Y2012_M2
  • 2013 version (model 1)…Y2013
  • 2013 version (model 2)…Y2013_M2
  • 2013 version (model 3)…Y2013_M3
  • 2014 version…Y2014
  • 2016 version…Y2016
  • 2017 version…Y2017
  • 2018 version…Y2018
  • 2019 NIED version…Y2019
5 case Required Probability case

  • Average case…AVR
  • Maximum case…MAX
6 period Required Evaluated period of a probability of occurrence

  • 30-Year…P_T30
  • 50-Year…P_T50
7 format Required Response format

  • JSON format…json
  • XML format…xml
8 param Optional Evaluated parameter (Priority to catastrophic hazard)

  • -1.0 <= param <= 1.0 (with seven digits of significant figures)

Default value…0.6

Note1) A generalized risk index RG(α;Y,I) is defined as follows. (Noshima, et al., 2010)
RG(α;Y,I) = P0(Y)1-αPEX(I)1+α

  • P0(Y)…Probability of occurrence in Y-year
  • PEX(I)…Population exposure to seismic intensity [IJMA >= I]
  • α…Priority to catastrophic hazard

Note2) Examples of a catastrophe priority are given as follows.

  • 1…Only considering a conditional probability of exceedance
  • 0…Equally considering a conditional probability of exceedance and a probability of occurrence
  • -1…Only considering a probability of occurrence
8 ijma Optional Threshold IJMA of probability of exceedance

  • 5-Lower…45
  • 5-Upper…50
  • 6-Lower…55
  • 6-Upper…60

Default value…55

8 lang Optional Response language

  • Japanese…ja
  • English…en

Note) A default value is “ja”.

Response

Status code

The data acquisition is successful, once you got the return HTTP 200 status code. Otherwise, please see the following HTTP status code.

HTTP status code Description Detail
400 Bad Request The request could not be understood by the server due to malformed syntax.

For example, unsupported value was setup.

403 Forbidden The server understood the request, but is refusing to fulfill it.

For example, requests exceeded the upper limits of normal.

404 Not Found The server has not found anything matching the Request-URI.

For example, non-existent mesh code was specified.

500 Internal Server Error The server encountered an unexpected condition which prevented it from fulfilling the request.
503 Service Unavailable The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

For example, a database connection fails.

Normal case
JSON format

JSON response is as follows.

Tag Description
status Request status

  • Success (fixed)
Fault Member element of a fault list

  • Fault (fixed)
rank Fault ranking
This number is ranked from the largest score obtained with the evaluation function to the smallest one.
ltecode Fault code

Refer to The J-SHIS Fault Code for details.
ltecase Fault case name
This value exist only if a mode equals “S”.
ltename Fault name
eqcode Earthquake code

Refer to The J-SHIS Earthquake Code for details.

eqgroup Earthquake group

  • Major active faults…A
  • other active faults…B
  • subduction-zone earthquakes…C
eqcategory Earthquake category attribute

  • Category I …1
  • Category II …2
  • Category III…3
case Average/Maximum case

  • Average case…AVR
  • Maximum case…MAX
probability Probability of occurrence
magnitude Magnitude
Note) Negative value of magnitude means moment magnitude and positive means JMA magnitude.
score Value of evaluation function
This value only has relative meaning. The more influence, the larger value.
pex Population exposure to seismic intensity
metaData Meta-information

  • metaData (fixed)
areacode Five digits with prefix “A” are composed of double digits of prefectural code (JISX0401) and three digits of municipal code as examples given.

  • municipality…A + prefectural code (2-digit) + municipal code (3-digit)
  • prefecture…A + prefectural code (2-digit) + ‘000’
ecode Population type code
mode Scenario earthquake code included in a response
version Map version
case Probability case
period Evaluated period of a probability of occurrence
param Evaluated a parameter
ijma Threshold IJMA of probability of exceedance
lang Language
Response sample
Request URL
http://www.j-shis.bosai.go.jp/map/api/fltsearch?areacode=A08220&ecode=ALL_NT_A&mode=C&version=Y2010&case=MAX&period=P_T30&format=json&ijma=55&param=0.6&lang=en
JSON format response
{
   "status":"Success",
   "Fault":[
      {
         "magnitude":"-7.4",
         "pex":"88262",
         "ltecode":"F003101",
         "eqcode":"LND_A98F",
         "probability":"0.00008260",
         "ltename":"Kanto-heiya-hokuseien fault zone (Main part)",
         "score":"1.906e+06",
         "case":"MAX",
         "rank":"1",
         "eqcategory":"3",
         "ltecase":"1",
         "eqgroup":"A"
      },
      {
         "magnitude":"-7.9",
         "pex":"2612",
         "ltecode":"AKNTO",
         "eqcode":"PLE_AKNTO",
         "probability":"0.00137000",
         "ltename":"Kanto Earthquake of \"1923 Taisho\" type",
         "score":"2.099e+04",
         "case":"AVR",
         "rank":"2",
         "eqcategory":"1",
         "ltecase":"1",
         "eqgroup":"C"
      }
   ],
   "metaData":{
      "period":"P_T30",
      "lang":"en",
      "areacode":"A08220",
      "mode":"C",
      "version":"Y2010",
      "case":"MAX",
      "ecode":"ALL_NT_A",
      "param":"0.6",
      "ijma":"55"
   }
}
XML format

XML response is given as following.

Tag Description
jshis:
status
Request status

  • Success (fixed)
jshis:
Faults
Faults array element of information
jshis:
Fault
Fault member element
rank Fault ranking
This number is ranked from the largest score obtained with the evaluation function to the smallest one.
ltecode Fault code

Refer to The J-SHIS Fault Code for details.

ltecase Fault case name
This value exist only if a mode equals “S”.
ltename Fault name
eqcode Earthquake code

Refer to The J-SHIS Earthquake Code for details.

eqgroup Earthquake group

  • Major active faults…A
  • other active faults…B
  • subduction-zone earthquakes…C
eqcategory Earthquake category attribute

  • Category I …1
  • Category II …2
  • Category III…3
case Average/Maximum case

  • Average case…AVR
  • Maximum case…MAX
probability Probability of occurrence
magnitude Magnitude
Note) Negative value of magnitude means moment magnitude and positive means JMA magnitude.
score Value of evaluation function
This value only has relative meaning. The more influence, the larger value.
pex Population exposure to seismic intensity
jshis:metaData Meta-information
jshis:areacode Five digits with prefix “A” are composed of double digits of prefectural code (JISX0401) and three digits of municipal code as examples given.

  • municipality…A + prefectural code (2-digit) + municipal code (3-digit)
  • prefecture…A + prefectural code (2-digit) + ‘000’
jshis:ecode Population type code
jshis:mode Scenario earthquake code included in a response
jshis:
version
Map version
jshis:
case
Probability case
jshis:
period
Evaluated period of a probability of occurrence
jshis:
param
Evaluated a parameter
jshis:
ijma
Threshold IJMA of probability of exceedance
jshis:
lang
Language
Response sample
Request URL
http://www.j-shis.bosai.go.jp/map/api/fltsearch?areacode=A08220&ecode=ALL_NT_A&mode=C&version=Y2010&case=MAX&period=P_T30&format=xml&ijma=55&param=0.6&lang=en
XML format response
<?xml version="1.0" encoding="utf-8"?>
<jshis:FltsearchArea xmlns:jshis="http://www.j-shis.bosai.go.jp" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.j-shis.bosai.go.jp http://www.j-shis.bosai.go.jp/map/xsd/gml-v2.1.2/fltsearch-area-v1.0.xsd">
    <jshis:status>Success</jshis:status>
    <jshis:metaData>
        <jshis:areacode>A08220</jshis:areacode>
        <jshis:case>MAX</jshis:case>
        <jshis:ecode>ALL_NT_A</jshis:ecode>
        <jshis:ijma>55</jshis:ijma>
        <jshis:lang>en</jshis:lang>
        <jshis:mode>C</jshis:mode>
        <jshis:param>0.6</jshis:param>
        <jshis:period>P_T30</jshis:period>
        <jshis:version>Y2010</jshis:version>
    </jshis:metaData>
    <jshis:Faults>
        <jshis:Fault case="MAX" eqcategory="3" eqcode="LND_A98F" eqgroup="A" ltecase="1" ltecode="F003101" ltename="Kanto-heiya-hokuseien fault zone (Main part)" magnitude="-7.4" pex="88262" probability="0.00008260" rank="1" score="1.906e+06"/>
        <jshis:Fault case="AVR" eqcategory="1" eqcode="PLE_AKNTO" eqgroup="C" ltecase="1" ltecode="AKNTO" ltename="Kanto Earthquake of "1923 Taisho" type" magnitude="-7.9" pex="2612" probability="0.00137000" rank="2" score="2.099e+04"/>
    </jshis:Faults>
</jshis:FltsearchArea>
Error case
Error classification code

Error classification code is given as following.

Classification code Description
INVALID_REQUEST The request could not be understood by the server due to malformed syntax.
DB_CONNECT_ERROR An error about Database occurred while processing your request.
UNKNOWN_ERROR An unknown error occurred while processing your request.
NOT_FOUND The server has not found anything matching the Request-URI.
JSON format

Once a request failed, response in JSON format is given as following.

Tag Description
type The type of the JSON object

  • PshmHzcv (fixed)
status Status

  • Error (fixed)
error Error information
code An error classification code
message An error message
Response sample
Request URL
http://www.j-shis.bosai.go.jp/map/api/fltsearch?areacode=A08220&ecode=ALL_NT_A&mode=C&version=Y2010&case=MAX&period=P_T30&format=jsonA
JSON format error response
{
    "status": "Error",
    "error": {
        "code": "INVALID_REQUEST",
        "message": "Supported formats are json,xml"
    }
}
XML format

In a request failed, response in XML format is as follows.

Tag Description
jshis:status Request status

  • Error (fixed)
jshis:error Error information
jshis:code An error classification code
jshis:message An error message
Response sample
Request URL
http://www.j-shis.bosai.go.jp/map/api/fltsearch?areacode=A08220&ecode=ALL_NT_A&mode=C&version=Y2010&case=MAX&period=P_T40&format=xml
XML format error response
<?xml version="1.0" encoding="utf-8"?>
<jshis:FltsearchArea xmlns:jshis="http://www.j-shis.bosai.go.jp" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.j-shis.bosai.go.jp http://www.j-shis.bosai.go.jp/map/xsd/gml-v2.1.2/fltsearch-area-v1.0.xsd">
    <jshis:status>Error</jshis:status>
    <jshis:error>
        <jshis:code>INVALID_REQUEST</jshis:code>
        <jshis:message>Supported options for [period] are : P_T30 / P_T50 </jshis:message>
    </jshis:error>
</jshis:FltsearchArea>
Category : API