J-SHIS | Japan Seismic Hazard Information Station

submenu Sitemap Contact Us J-SHIS 地震ハザードステーション
Start J-SHIS Maps
TOP > API > Hazard curve information API
その他

Hazard curve information API

This API provides a Hazard curve data in the specified Third-mesh that is exceedance probability versus intensity index.

Version

1.0.0

Request URL

https://www.j-shis.bosai.go.jp/map/api/pshm/version/case/eqcode/t/hzcv.format?meshcode=meshcode
https://www.j-shis.bosai.go.jp/map/api/meshcode/pshm/version/case/eqcode/t/hzcv.format
https://www.j-shis.bosai.go.jp/map/api/pshm/version/case/eqcode/t/hzcv.format?position=position&epsg=epsg

Table of contents

Request

– URL
– By Mesh code
– By Longitude and Latitude
– Parameters

Response

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

Request

URL

There are two ways that you can specify search position, either by longitude and latitude or by the mesh code. In the URL, bold characters indicate a request parameter; superscript number corresponds to the No. in parameter list.

By Mesh code
https://www.j-shis.bosai.go.jp/map/api/pshm/version1/case2/eqcode3/t4/hzcv.format5?meshcode=meshcode6
https://www.j-shis.bosai.go.jp/map/api/meshcode6/pshm/version1/case2/eqcode3/t4/hzcv.format5
By Longitude and Latitude
https://www.j-shis.bosai.go.jp/map/api/pshm/version１/case2/eqcode3/t4/hzcv.format5?position=position7&epsg=epsg8
Parameters

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

No Parameter Dispensability Input values and Description
1 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
  • 2020 version…Y2020
  • 2021 NIED version…Y2021
  • 2022 NIED version…Y2022
  • 2023 NIED version…Y2023
2 case Required Probability case

  • Average case…AVR
  • Maximum case…MAX
3 eqcode Required Earthquake code

Refer to earthquake code for details.
4 t Required Period

  • 30-Year…T30
  • 50-Year…T50
5 format Required Output form

  • JSON format…json
  • XML format…xml
6 meshcode Conditional Third mesh
Refer to the Basic Grid Square Code definition for details.

Note) Request fails if the “epsg” or “position” parameter is specified with this parameter.
7 position Conditional Longitude and Latitude are separated by a comma. The coordinates are restricted in the following regions.

  • 122.0≦Longitude≦154.0
  • 20.0≦Latitude≦46.0

Note1) This parameter is required when “epsg” parameter is specified.
Note2) Request fails if a “meshcode” parameter is specified.
8 epsg Conditional EPSG code

  • JGD2000…4612
  • Tokyo…4301
  • WGS84…4326

Note1) This parameter is required when “position” parameter is specified.
Note2) Request fails if a “meshcode” parameter is specified.

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
type The type of the JSON object

  • PshmHzcv (fixed)
status Request status

  • Success (fixed)
metaData Meta-information
meshcode Third mesh
Refer to the Basic Grid Square Code definition for details.
eqcode Earthquake code
version Map version
case Probability case
t Period
prob Exceedance probability
meshcode Third mesh
Refer to the Basic Grid Square Code definition for details.
value An array of exceedance probability value corresponds to the intensity index.
sim Intensity index
type The type of intensity index

  • bv…Peak velocity on the engineering bedrock
unit Unit of the value set in the intensity index array.
value An array of intensity index value
Response sample
Request URL
https://www.j-shis.bosai.go.jp/map/api/pshm/Y2010/AVR/TTL_MTTL/T30/hzcv.json?meshcode=51322041N
JSON format response
{
    "type": "PshmHzcv",
    "status": "Success",
    "metaData": {
        "meshcode": "51322041N",
        "eqcode": "TTL_MTTL",
        "version": "Y2010",
        "case": "AVR",
        "t": "30"
    },
    "prob": {
        "meshcode": "51322041N",
        "value": [
            "1.000000",   "0.9995463",   "0.9595824",
            "0.8783311",   "0.7994685",   "0.7182883",
            "0.6308817",   "0.5406196",   "0.4532565",
            "0.3734141",   "0.3036335",   "0.2190794",
            "0.1564535",   "0.1114249",   "0.07955143",
            "0.05715077",   "0.04142031",   "0.03033558",
            "0.02247881",   "0.01685985",   "0.01280638",
            "0.008334419",   "0.005611635",   "0.003968899",
            "0.003148562",   "0.002552753",   "0.002107752",
            "0.001766375",   "0.001498294",   "0.001282806",
            "0.001106593",   "0.0008373687",   "0.0006446405",
            "0.0005003452",   "0.0003907430",   "0.0003061670",
            "0.0002406302",   "0.0001896429",   "0.0001498107",
            "0.0001185443",   "0.00009391604",   "0.00005903268",
            "0.00003698568",   "0.00002286980",   "0.00001371502",
            "0.000007703490"
        ]
    },
    "sim": {
        "type": "bv",
        "unit": "cm/s",
        "value": [
            "0.0",   "2.0",   "4.0",   "6.0",   "8.0",
            "10.0",   "12.0",   "14.0",   "16.0",
            "18.0",   "20.0",   "23.0",   "26.0",
            "29.0",   "32.0",   "35.0",   "38.0",
            "41.0",   "44.0",   "47.0",   "50.0",
            "55.0",   "60.0",   "65.0",   "70.0",
            "75.0",   "80.0",   "85.0",   "90.0",
            "95.0",   "100.0",   "110.0",   "120.0",
            "130.0",   "140.0",   "150.0",   "160.0",
            "170.0",   "180.0",   "190.0",   "200.0",
            "220.0",   "240.0",   "260.0",   "280.0",
            "300.0"
        ]
    }
}
XML format

XML response is given as following.

Tag Description
jshis:
status		 Status

  • Success (fixed)
jshis:
type		 Type

  • PshmHzcv (fixed)
jshis:
metaData		 Meta-information
jshis:
meshcode		 Third mesh
Refer to the Basic Grid Square Code definition for details.
jshis:
eqcode		 Earthquake code
jshis:
version		 Map version
jshis:
case		 Probability case
jshis:
t		 Period
jshis:
prob		 Exceedance probability array
jshis:
meshcode		 Third mesh
Refer to the Basic Grid Square Code definition for details.
jshis:
values		 An exceedance probability
jshis:
value		 An exceedance probability value with an attribute ID corresponds to the value of intensity index that has the same attribute ID.
jshis:
sim		 An array of the intensity index

  • type…a type of intensity index
    bv…Peak velocity on the engineering bedrock
  • unit…a unit of the value set in the intensity index array
jshis:
values		 A value of intensity index
jshis:
value		 An intensity index value with an attribute ID corresponds to the value of exceedance probability that has the same attribute ID.
Response sample
Request URL
https://www.j-shis.bosai.go.jp/map/api/36225725N/pshm/Y2010/AVR/TTL_MTTL/T30/hzcv.xml
XML format response
<?xml version="1.0" encoding="utf-8"?>
<jshis:PshmHzcv 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/pshm-hzcv-v1.0.xsd">
    <jshis:status>Success</jshis:status>
    <jshis:type>PshmHzcv</jshis:type>
    <jshis:metaData>
        <jshis:meshcode>51322041N</jshis:meshcode>
        <jshis:eqcode>TTL_MTTL</jshis:eqcode>
        <jshis:version>Y2010</jshis:version>
        <jshis:case>AVR</jshis:case>
        <jshis:t>30</jshis:t>
    </jshis:metaData>
    <jshis:prob>
        <jshis:meshcode>51322041N</jshis:meshcode>
        <jshis:values>
            <jshis:value id="1">1.000000</jshis:value>
            <jshis:value id="2">0.9995463</jshis:value>
            <jshis:value id="3">0.9595824</jshis:value>
            <jshis:value id="4">0.8783311</jshis:value>
            <jshis:value id="5">0.7994685</jshis:value>
            <jshis:value id="6">0.7182883</jshis:value>
            <jshis:value id="7">0.6308817</jshis:value>
            <jshis:value id="8">0.5406196</jshis:value>
            <jshis:value id="9">0.4532565</jshis:value>
            <jshis:value id="10">0.3734141</jshis:value>
            <jshis:value id="11">0.3036335</jshis:value>
            <jshis:value id="12">0.2190794</jshis:value>
            <jshis:value id="13">0.1564535</jshis:value>
            <jshis:value id="14">0.1114249</jshis:value>
            <jshis:value id="15">0.07955143</jshis:value>
            <jshis:value id="16">0.05715077</jshis:value>
            <jshis:value id="17">0.04142031</jshis:value>
            <jshis:value id="18">0.03033558</jshis:value>
            <jshis:value id="19">0.02247881</jshis:value>
            <jshis:value id="20">0.01685985</jshis:value>
            <jshis:value id="21">0.01280638</jshis:value>
            <jshis:value id="22">0.008334419</jshis:value>
            <jshis:value id="23">0.005611635</jshis:value>
            <jshis:value id="24">0.003968899</jshis:value>
            <jshis:value id="25">0.003148562</jshis:value>
            <jshis:value id="26">0.002552753</jshis:value>
            <jshis:value id="27">0.002107752</jshis:value>
            <jshis:value id="28">0.001766375</jshis:value>
            <jshis:value id="29">0.001498294</jshis:value>
            <jshis:value id="30">0.001282806</jshis:value>
            <jshis:value id="31">0.001106593</jshis:value>
            <jshis:value id="32">0.0008373687</jshis:value>
            <jshis:value id="33">0.0006446405</jshis:value>
            <jshis:value id="34">0.0005003452</jshis:value>
            <jshis:value id="35">0.0003907430</jshis:value>
            <jshis:value id="36">0.0003061670</jshis:value>
            <jshis:value id="37">0.0002406302</jshis:value>
            <jshis:value id="38">0.0001896429</jshis:value>
            <jshis:value id="39">0.0001498107</jshis:value>
            <jshis:value id="40">0.0001185443</jshis:value>
            <jshis:value id="41">0.00009391604</jshis:value>
            <jshis:value id="42">0.00005903268</jshis:value>
            <jshis:value id="43">0.00003698568</jshis:value>
            <jshis:value id="44">0.00002286980</jshis:value>
            <jshis:value id="45">0.00001371502</jshis:value>
            <jshis:value id="46">0.000007703490</jshis:value>
        </jshis:values>
    </jshis:prob>
    <jshis:sim type="bv" unit="cm/s">
        <jshis:values>
            <jshis:value id="1">0.0</jshis:value>
            <jshis:value id="2">2.0</jshis:value>
            <jshis:value id="3">4.0</jshis:value>
            <jshis:value id="4">6.0</jshis:value>
            <jshis:value id="5">8.0</jshis:value>
            <jshis:value id="6">10.0</jshis:value>
            <jshis:value id="7">12.0</jshis:value>
            <jshis:value id="8">14.0</jshis:value>
            <jshis:value id="9">16.0</jshis:value>
            <jshis:value id="10">18.0</jshis:value>
            <jshis:value id="11">20.0</jshis:value>
            <jshis:value id="12">23.0</jshis:value>
            <jshis:value id="13">26.0</jshis:value>
            <jshis:value id="14">29.0</jshis:value>
            <jshis:value id="15">32.0</jshis:value>
            <jshis:value id="16">35.0</jshis:value>
            <jshis:value id="17">38.0</jshis:value>
            <jshis:value id="18">41.0</jshis:value>
            <jshis:value id="19">44.0</jshis:value>
            <jshis:value id="20">47.0</jshis:value>
            <jshis:value id="21">50.0</jshis:value>
            <jshis:value id="22">55.0</jshis:value>
            <jshis:value id="23">60.0</jshis:value>
            <jshis:value id="24">65.0</jshis:value>
            <jshis:value id="25">70.0</jshis:value>
            <jshis:value id="26">75.0</jshis:value>
            <jshis:value id="27">80.0</jshis:value>
            <jshis:value id="28">85.0</jshis:value>
            <jshis:value id="29">90.0</jshis:value>
            <jshis:value id="30">95.0</jshis:value>
            <jshis:value id="31">100.0</jshis:value>
            <jshis:value id="32">110.0</jshis:value>
            <jshis:value id="33">120.0</jshis:value>
            <jshis:value id="34">130.0</jshis:value>
            <jshis:value id="35">140.0</jshis:value>
            <jshis:value id="36">150.0</jshis:value>
            <jshis:value id="37">160.0</jshis:value>
            <jshis:value id="38">170.0</jshis:value>
            <jshis:value id="39">180.0</jshis:value>
            <jshis:value id="40">190.0</jshis:value>
            <jshis:value id="41">200.0</jshis:value>
            <jshis:value id="42">220.0</jshis:value>
            <jshis:value id="43">240.0</jshis:value>
            <jshis:value id="44">260.0</jshis:value>
            <jshis:value id="45">280.0</jshis:value>
            <jshis:value id="46">300.0</jshis:value>
        </jshis:values>
    </jshis:sim>
</jshis:PshmHzcv>
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
https://www.j-shis.bosai.go.jp/map/api/pshm/Y2010/AVR/TTL_MTTL/T60/hzcv.json?meshcode=51322041N
JSON format error response
{
  "type": "PshmHzcv",
  "status": "Error",
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Supported options for [ t ] are : T30 / T50"
  }
}
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
https://www.j-shis.bosai.go.jp/map/api/51322041N/pshm/Y2010/AVR/TTL_MTTL/T60/hzcv.xml
Error response in XML format
<jshis:PshmHzcv 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/pshm-hzcv-v1.0.xsd">
    <jshis:status>Error</jshis:status>
    <jshis:error>
        <jshis:code>INVALID_REQUEST</jshis:code>
        <jshis:message>Supported options for [ t ] are : T30 / T50</jshis:message>
    </jshis:error>
</jshis:PshmHzcv>
Category : API　
TOP > API > Hazard curve information API