J-SHIS | Japan Seismic Hazard Information Station

submenu Sitemap Contact Us J-SHIS 地震ハザードステーション
Start J-SHIS Maps
TOP > API > Deep subsurface structural physical properties API
その他

Deep subsurface structural physical properties API

This API provides physical properties for deep subsurface structure .

Version

1.0.0

Request URL

https://www.j-shis.bosai.go.jp/map/api/dstrct/version/phys.format

Table of contents

Request

– URL
– 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.

https://www.j-shis.bosai.go.jp/map/api/dstrct/version1/phys.format2
Parameters

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

No Parameter Dispensability Input values and Description
1 version Required Version code

  • Version 1…V1
  • Version 2…V2
  • Version 3.2…V3.2

Refer to a list of version codes for details.

2 format Required Response format

  • JSON format…json
  • XML format…xml

The following is a list of version code.

Version code Description
V1 Fujiwara, H. et al. (2009), “A Study on Subsurface Structure Model for Deep Sedimentary Layers of Japan for Strong-motion Evaluation”, Technical Note of the National Research Institute for Earth Science and Disaster Prevention, No. 337, Page 4-11 ? 4-24, in Japanese
V2 Fujiwara, H. et al. (2012), “Some Improvements of Seismic Hazard Assessment based on the 2011
Tohoku Earthquake”, Technical Note of the National Research Institute for Earth Science and
Disaster Prevention, No. 379, in Japanese
V3.2 The Headquarters for Earthquake Research Promotion (2021), “Modeling concept of subsurface structures from seismic bedrock to ground surface” (in Japanese)

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)
phys attribute array of physical property
SVP associative array of P-wave velocity
tn1 P-wave velocity of layer No. 1
tn2 P-wave velocity of layer No. 2
・・・ ・・・
tn33 P-wave velocity of layer No. 33
SVS Associative array of S-wave velocity
tn1 S-wave velocity of layer No. 1
tn2 S-wave velocity of layer No. 2
・・・ ・・・
tn33 S-wave velocity of layer No. 33
SRO Associative array of density
tn1 Density of layer No. 1
tn2 Density of layer No. 2
・・・ ・・・
tn33 Density of layer No. 33
SQP Associative array of Qp
tn1 Qp of layer No. 1
tn2 Qp of layer No. 2
・・・ ・・・
tn33 Qp of layer No. 33
SQS Associative array of Qs
tn1 Qs of layer No. 1
tn2 Qs of layer No. 2
・・・ ・・・
tn33 Qs of layer No. 33
metaData Meta-information
version Version code
phys Physical property attributes included in a response
name Attribute name of physical property
unit Property value of unit of the physical
Response sample
Request URL
https://www.j-shis.bosai.go.jp/map/api/dstrct/V1/phys.json
JSON形式レスポンス
{
    "status": "Success",
    "phys": {
        "SVP": {
            "tn1" :"1600", "tn2" :"1600", "tn3" :"1700", "tn4" :"1800", "tn5" :"1800",
            "tn6" :"2000", "tn7" :"2000", "tn8" :"2100", "tn9" :"2100", "tn10":"2200", 
            "tn11":"2300", "tn12":"2400", "tn13":"2400", "tn14":"2500", "tn15":"2500", 
            "tn16":"2600", "tn17":"2700", "tn18":"3000", "tn19":"3200", "tn20":"3400", 
            "tn21":"3500", "tn22":"3600", "tn23":"3700", "tn24":"3800", "tn25":"4000", 
            "tn26":"4000", "tn27":"5000", "tn28":"4600", "tn29":"5000", "tn30":"5500", 
            "tn31":"5500", "tn32":"5700", "tn33":"6000"
          },
        "SVS": {
            "tn1" :"350", "tn2" :"400", "tn3" :"450", "tn4" :"500", "tn5" :"550", 
            "tn6" :"600", "tn7" :"650", "tn8" :"700", "tn9" :"750", "tn10":"800", 
            "tn11":"850", "tn12":"900", "tn13":"950", "tn14":"1000", "tn15":"1100", 
            "tn16":"1200", "tn17":"1300", "tn18":"1400", "tn19":"1500", "tn20":"1600", 
            "tn21":"1700", "tn22":"1800", "tn23":"1900", "tn24":"2000", "tn25":"2100", 
            "tn26":"2100", "tn27":"2700", "tn28":"2900", "tn29":"2700", "tn30":"3100", 
            "tn31":"3200", "tn32":"3300", "tn33":"3400"
        },
        "SRO": {
            "tn1" :"1850", "tn2" :"1850", "tn3" :"1900", "tn4" :"1900", "tn5" :"1900", 
            "tn6" :"1900", "tn7" :"1950", "tn8" :"2000", "tn9" :"2000", "tn10":"2000", 
            "tn11":"2050", "tn12":"2050", "tn13":"2100", "tn14":"2100", "tn15":"2150", 
            "tn16":"2150", "tn17":"2200", "tn18":"2250", "tn19":"2250", "tn20":"2300", 
            "tn21":"2300", "tn22":"2350", "tn23":"2350", "tn24":"2400", "tn25":"2400", 
            "tn26":"2400", "tn27":"2500", "tn28":"2550", "tn29":"2500", "tn30":"2600", 
            "tn31":"2650", "tn32":"2700", "tn33":"2750"
        },
        "SQP": {
            "tn1" :"60", "tn2" :"60", "tn3" :"60", "tn4" :"60", "tn5" :"60", 
            "tn6" :"100", "tn7" :"100", "tn8" :"100", "tn9" :"100", "tn10":"100", 
            "tn11":"100", "tn12":"100", "tn13":"100", "tn14":"150", "tn15":"150", 
            "tn16":"150", "tn17":"150", "tn18":"150", "tn19":"150", "tn20":"150", 
            "tn21":"150", "tn22":"150", "tn23":"150", "tn24":"200", "tn25":"200", 
            "tn26":"200", "tn27":"200", "tn28":"200", "tn29":"200", "tn30":"300", 
            "tn31":"300", "tn32":"300", "tn33":"300"
        },
        "SQS": {
            "tn1" :"60", "tn2" :"60", "tn3" :"60", "tn4" :"60", "tn5" :"60", 
            "tn6" :"100", "tn7" :"100", "tn8" :"100", "tn9" :"100", "tn10":"100", 
            "tn11":"100", "tn12":"100", "tn13":"100", "tn14":"150", "tn15":"150", 
            "tn16":"150", "tn17":"150", "tn18":"150", "tn19":"150", "tn20":"150", 
            "tn21":"150", "tn22":"150", "tn23":"150", "tn24":"200", "tn25":"200", 
            "tn26":"200", "tn27":"200", "tn28":"200", "tn29":"200", "tn30":"300", 
            "tn31":"300", "tn32":"300", "tn33":"300"
        }
    },
    "metaData": {
        "version":"V1",
        "phys": [
            {
                "name": "SVP",
                "unit": "m/s"
            },
            {
                "name": "SVS",
                "unit": "m/s"
            },
            {
                "name": "SRO",
                "unit": "kg/m^3"
            },
            {
                "name": "SQP",
                "unit": ""
            },
            {
                "name": "SQS",
                "unit": ""
            }
        ]
    }
}
XML format

XML response is given as following.

Tag Description
jshis:
status		 Request status

  • Success (fixed)
jshis:
phys		 attribute array of physical property
jshis:
SVP		 associative array of P-wave velocity
tn1 P-wave velocity of layer No. 1
tn2 P-wave velocity of layer No. 2
・・・ ・・・
tn33 P-wave velocity of layer No. 33
jshis:
SVS		 Associative array of S-wave velocity
tn1 S-wave velocity of layer No. 1
tn2 S-wave velocity of layer No. 2
・・・ ・・・
tn33 S-wave velocity of layer No. 33
jshis:
SRO		 Associative array of density
tn1 Density of layer No. 1
tn2 Density of layer No. 2
・・・ ・・・
tn33 Density of layer No. 33
jshis:
SQP		 Associative array of Qp
tn1 Qp of layer No. 1
tn2 Qp of layer No. 2
・・・ ・・・
tn33 Qp of layer No. 33
jshis:
SQS		 Associative array of Qs
tn1 Qs of layer No. 1
tn2 Qs of layer No. 2
・・・ ・・・
tn33 Qs of layer No. 33
jshis:
metaData		 Meta-information
jshis:
version		 Version code
jshis:
physs		 Physical property attributes included in a response array
jshis:
phys		 Physical property attributes included in a response
jshis:
name		 Attribute name of physical property
jshis:
unit		 Property value of unit of the physical
Response sample
Request URL
https://www.j-shis.bosai.go.jp/map/api/dstrct/V1/phys.xml
XML format response
<?xml version="1.0" encoding="UTF-8"?>
<jshis:DstrctPhys
    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/dstrct-phys-v1.0.xsd">
    <jshis:status>Success</jshis:status>
    <jshis:phys>
        <jshis:SVP>
            <jshis:tn1>1600</jshis:tn1><jshis:tn2>1600</jshis:tn2><jshis:tn3>1700</jshis:tn3>
            <jshis:tn4>1800</jshis:tn4><jshis:tn5>1800</jshis:tn5><jshis:tn6>2000</jshis:tn6>
            <jshis:tn7>2000</jshis:tn7><jshis:tn8>2100</jshis:tn8><jshis:tn9>2100</jshis:tn9>
            <jshis:tn10>2200</jshis:tn10><jshis:tn11>2300</jshis:tn11><jshis:tn12>2400</jshis:tn12>
            <jshis:tn13>2400</jshis:tn13><jshis:tn14>2500</jshis:tn14><jshis:tn15>2500</jshis:tn15>
            <jshis:tn16>2600</jshis:tn16><jshis:tn17>2700</jshis:tn17><jshis:tn18>3000</jshis:tn18>
            <jshis:tn19>3200</jshis:tn19><jshis:tn20>3400</jshis:tn20><jshis:tn21>3500</jshis:tn21>
            <jshis:tn22>3600</jshis:tn22><jshis:tn23>3700</jshis:tn23><jshis:tn24>3800</jshis:tn24>
            <jshis:tn25>4000</jshis:tn25><jshis:tn26>4000</jshis:tn26><jshis:tn27>5000</jshis:tn27>
            <jshis:tn28>4600</jshis:tn28><jshis:tn29>5000</jshis:tn29><jshis:tn30>5500</jshis:tn30>
            <jshis:tn31>5500</jshis:tn31><jshis:tn32>5700</jshis:tn32><jshis:tn33>6000</jshis:tn33>
        </jshis:SVP>
        <jshis:SVS>
            <jshis:tn1>350</jshis:tn1><jshis:tn2>400</jshis:tn2><jshis:tn3>450</jshis:tn3>
            <jshis:tn4>500</jshis:tn4><jshis:tn5>550</jshis:tn5><jshis:tn6>600</jshis:tn6>
            <jshis:tn7>650</jshis:tn7><jshis:tn8>700</jshis:tn8><jshis:tn9>750</jshis:tn9>
            <jshis:tn10>800</jshis:tn10><jshis:tn11>850</jshis:tn11><jshis:tn12>900</jshis:tn12>
            <jshis:tn13>950</jshis:tn13><jshis:tn14>1000</jshis:tn14><jshis:tn15>1100</jshis:tn15>
            <jshis:tn16>1200</jshis:tn16><jshis:tn17>1300</jshis:tn17><jshis:tn18>1400</jshis:tn18>
            <jshis:tn19>1500</jshis:tn19><jshis:tn20>1600</jshis:tn20><jshis:tn21>1700</jshis:tn21>
            <jshis:tn22>1800</jshis:tn22><jshis:tn23>1900</jshis:tn23><jshis:tn24>2000</jshis:tn24>
            <jshis:tn25>2100</jshis:tn25><jshis:tn26>2100</jshis:tn26><jshis:tn27>2700</jshis:tn27>
            <jshis:tn28>2900</jshis:tn28><jshis:tn29>2700</jshis:tn29><jshis:tn30>3100</jshis:tn30>
            <jshis:tn31>3200</jshis:tn31><jshis:tn32>3300</jshis:tn32><jshis:tn33>3400</jshis:tn33>
        </jshis:SVS>
        <jshis:SRO>
            <jshis:tn1>1850</jshis:tn1><jshis:tn2>1850</jshis:tn2><jshis:tn3>1900</jshis:tn3>
            <jshis:tn4>1900</jshis:tn4><jshis:tn5>1900</jshis:tn5><jshis:tn6>1900</jshis:tn6>
            <jshis:tn7>1950</jshis:tn7><jshis:tn8>2000</jshis:tn8><jshis:tn9>2000</jshis:tn9>
            <jshis:tn10>2000</jshis:tn10><jshis:tn11>2050</jshis:tn11><jshis:tn12>2050</jshis:tn12>
            <jshis:tn13>2100</jshis:tn13><jshis:tn14>2100</jshis:tn14><jshis:tn15>2150</jshis:tn15>
            <jshis:tn16>2150</jshis:tn16><jshis:tn17>2200</jshis:tn17><jshis:tn18>2250</jshis:tn18>
            <jshis:tn19>2250</jshis:tn19><jshis:tn20>2300</jshis:tn20><jshis:tn21>2300</jshis:tn21>
            <jshis:tn22>2350</jshis:tn22><jshis:tn23>2350</jshis:tn23><jshis:tn24>2400</jshis:tn24>
            <jshis:tn25>2400</jshis:tn25><jshis:tn26>2400</jshis:tn26><jshis:tn27>2500</jshis:tn27>
            <jshis:tn28>2550</jshis:tn28><jshis:tn29>2500</jshis:tn29><jshis:tn30>2600</jshis:tn30>　
            <jshis:tn31>2650</jshis:tn31><jshis:tn32>2700</jshis:tn32><jshis:tn33>2750</jshis:tn33>
        </jshis:SRO>
        <jshis:SQP> 
            <jshis:tn1>60</jshis:tn1><jshis:tn2>60</jshis:tn2><jshis:tn3>60</jshis:tn3>
            <jshis:tn4>60</jshis:tn4><jshis:tn5>60</jshis:tn5><jshis:tn6>100</jshis:tn6>
            <jshis:tn7>100</jshis:tn7><jshis:tn8>100</jshis:tn8><jshis:tn9>100</jshis:tn9>
            <jshis:tn10>100</jshis:tn10><jshis:tn11>100</jshis:tn11><jshis:tn12>100</jshis:tn12>
            <jshis:tn13>100</jshis:tn13><jshis:tn14>150</jshis:tn14><jshis:tn15>150</jshis:tn15>
            <jshis:tn16>150</jshis:tn16><jshis:tn17>150</jshis:tn17><jshis:tn18>150</jshis:tn18>
            <jshis:tn19>150</jshis:tn19><jshis:tn20>150</jshis:tn20><jshis:tn21>150</jshis:tn21>
            <jshis:tn22>150</jshis:tn22><jshis:tn23>150</jshis:tn23><jshis:tn24>200</jshis:tn24>
            <jshis:tn25>200</jshis:tn25><jshis:tn26>200</jshis:tn26><jshis:tn27>200</jshis:tn27>
            <jshis:tn28>200</jshis:tn28><jshis:tn29>200</jshis:tn29><jshis:tn30>300</jshis:tn30>
            <jshis:tn31>300</jshis:tn31><jshis:tn32>300</jshis:tn32><jshis:tn33>300</jshis:tn33>
        </jshis:SQP>
        <jshis:SQS>
            <jshis:tn1>60</jshis:tn1><jshis:tn2>60</jshis:tn2><jshis:tn3>60</jshis:tn3>
            <jshis:tn4>60</jshis:tn4><jshis:tn5>60</jshis:tn5><jshis:tn6>100</jshis:tn6>
            <jshis:tn7>100</jshis:tn7><jshis:tn8>100</jshis:tn8><jshis:tn9>100</jshis:tn9>
            <jshis:tn10>100</jshis:tn10><jshis:tn11>100</jshis:tn11><jshis:tn12>100</jshis:tn12>
            <jshis:tn13>100</jshis:tn13><jshis:tn14>150</jshis:tn14><jshis:tn15>150</jshis:tn15>
            <jshis:tn16>150</jshis:tn16><jshis:tn17>150</jshis:tn17><jshis:tn18>150</jshis:tn18>
            <jshis:tn19>150</jshis:tn19><jshis:tn20>150</jshis:tn20><jshis:tn21>150</jshis:tn21>
            <jshis:tn22>150</jshis:tn22><jshis:tn23>150</jshis:tn23><jshis:tn24>200</jshis:tn24>
            <jshis:tn25>200</jshis:tn25><jshis:tn26>200</jshis:tn26><jshis:tn27>200</jshis:tn27>
            <jshis:tn28>200</jshis:tn28><jshis:tn29>200</jshis:tn29><jshis:tn30>300</jshis:tn30>
            <jshis:tn31>300</jshis:tn31><jshis:tn32>300</jshis:tn32><jshis:tn33>300</jshis:tn33>
        </jshis:SQS> 
    </jshis:phys>
    <jshis:metaData>
        <jshis:version>V1</jshis:version>
        <jshis:physs>
            <jshis:phys>
                <jshis:name>SVP</jshis:name>
                <jshis:unit>m/s</jshis:unit>
            </jshis:phys>
            <jshis:phys>
                <jshis:name>SVS</jshis:name>
                <jshis:unit>m/s</jshis:unit>
            </jshis:phys>
            <jshis:phys>
                <jshis:name>SRO</jshis:name>
                <jshis:unit>kg/m^3</jshis:unit>
            </jshis:phys>
            <jshis:phys>
                <jshis:name>SQP</jshis:name>
                <jshis:unit/>
            </jshis:phys>
            <jshis:phys>
                <jshis:name>SQS</jshis:name>
                <jshis:unit/>
            </jshis:phys> 
        </jshis:physs>
    </jshis:metaData>
</jshis:DstrctPhys>
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
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/dstrct/V10/phys.json
JSON format error response
{
    "status": "Error",
    "error": {
        "code": "INVALID_REQUEST",
        "message": "Supported options for [version] are : V1 / V2 / V3.2 "
    }
}
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/dstrct/V10/phys.xml
XML format error response
<?xml version="1.0" encoding="utf-8"?>
<jshis:DstrctPhys
    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/dstrct-phys-v1.0.xsd">
    <jshis:status>Error</jshis:status>
    <jshis:error>
        <jshis:code>INVALID_REQUEST</jshis:code>
        <jshis:message>Supported options for [version] are : V1 / V2 / V3.2 </jshis:message>
    </jshis:error>
</jshis:DstrctPhys>
Category : API　
TOP > API > Deep subsurface structural physical properties API