Seismic hazard information API

TOP > API > Seismic hazard information API

Seismic hazard information API

This API provides mesh information on seismic hazard.

Version

1.0.0

Request URL

https://www.j-shis.bosai.go.jp/map/api/pshm/version/case/eqcode/meshinfo.format?meshcode=meshcode&options

https://www.j-shis.bosai.go.jp/map/api/meshcode/pshm/version/case/eqcode/meshinfo.format?options

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

Response

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/version¹/case²/eqcode³/meshinfo.format⁴?meshcode=meshcode⁵&options⁸

https://www.j-shis.bosai.go.jp/map/api/meshcode⁵/pshm/version¹/case²/eqcode³/meshinfo.format⁴?options⁸

By Longitude and Latitude

https://www.j-shis.bosai.go.jp/map/api/pshm/version¹/case²/eqcode³/meshinfo.format⁴?position=position⁶&epsg=epsg⁷&options⁸

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 2024 NIED version…Y2024
2	case	Required	Probability case Average case…AVR Maximum case…MAX
3	eqcode	Required	Earthquake code Refer to earthquake code for more information.
4	format	Required	Response format GeoJSON format…geojson GML format…gml
5	meshcode	Conditional	250m mesh code Refer to the Quarter Grid Square definition for more information. Note) Request fails if the “epsg” or “position” parameter is specified with this parameter.
6	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.
7	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.
8	attr	Optional	Seismic hazard attribute Refer to a List of seismic hazard attributes for more information. If not specified, all attributes are returned.

The following is a list of seismic hazard attributes.

Attribute name	Format	Description
T30_I45_PS	%.6f	Probability of exceedance [IJMA >=5-Lower] within 30 years
T30_I50_PS	%.6f	Probability of exceedance [IJMA >=5-Upper] within 30 years
T30_I55_PS	%.6f	Probability of exceedance [IJMA >=6-Lower] within 30 years
T30_I60_PS	%.6f	Probability of exceedance [IJMA >=6-Upper] within 30 years
T30_P03_SI	%.1f	IJMA for a 3% probability of exceedance within 30 years
T30_P03_BV	%.1f	PBV for a 3% probability of exceedance within 30 years (cm/s)
T30_P03_SV	%.1f	PGV for a 3% probability of exceedance within 30 years (cm/s)
T30_P06_SI	%.1f	IJMA for a 6% probability of exceedance within 30 years
T30_P06_BV	%.1f	PBV for a 6% probability of exceedance within 30 years (cm/s)
T30_P06_SV	%.1f	PGV for a 6% probability of exceedance within 30 years (cm/s)
T50_P02_SI	%.1f	IJMA for a 2% probability of exceedance within 50 years
T50_P02_BV	%.1f	PBV for a 2% probability of exceedance within 50 years (cm/s)
T50_P02_SV	%.1f	PGV for a 2% probability of exceedance within 50 years (cm/s)
T50_P05_SI	%.1f	IJMA for a 5% probability of exceedance within 50 years
T50_P05_BV	%.1f	PBV for a 5% probability of exceedance within 50 years (cm/s)
T50_P05_SV	%.1f	PGV for a 5% probability of exceedance within 50 years (cm/s)
T50_P10_SI	%.1f	IJMA for a 10% probability of exceedance within 50 years
T50_P10_BV	%.1f	PBV for a 10% probability of exceedance within 50 years (cm/s)
T50_P10_SV	%.1f	PGV for a 10% probability of exceedance within 50 years (cm/s)
T50_P39_SI	%.1f	IJMA for a 39% probability of exceedance within 50 years
T50_P39_BV	%.1f	PBV for a 39% probability of exceedance within 50 years (cm/s)
T50_P39_SV	%.1f	PGV for a 39% probability of exceedance within 50 years (cm/s)

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

GeoJSON format

GeoJSON response is as follows.

Tag			Description
type			The type of the GeoJSON object FeatureCollection (fixed)
crs			The coordinate reference system (CRS) of the GeoJSON object
status			Request status Success (fixed)
features			Member element An array with a geometry of the rectangular mesh and its attribute
	type		The type of the GeoJSON object Feature (fixed)
	geometry		A geometry object of the rectangular mesh
	properties		Any JSON object or a JSON null object
		meshcode	250m mesh code Refer to the Quarter Grid Square definition for details.
		Seismic hazard attribute name (such as T30_I45_PS)	Seismic hazard attributes Refer to a List of seismic hazard attribute for details.
metaData			Meta-information
	meshcode		250m mesh code Refer to the Quarter Grid Square definition for details.
	eqcode		Earthquake code
	version		Map version
	case		Probability case
	attr		Array of seismic hazard attribute name
		name	Seismic hazard attribute Refer to a List of seismic hazard attribute for details.
		unit	Unit of the attribute value

Response sample

Request URL

https://www.j-shis.bosai.go.jp/map/api/pshm/Y2010/AVR/TTL_MTTL/meshinfo.geojson?meshcode=5440008644N&attr=T30_I45_PS

GeoJSON format response

{
  "type": "FeatureCollection",
  "crs": {
    "type": "name",
    "properties": {
      "name": "urn:ogc:def:crs:EPSG:4301"
    }
  },
  "status": "Success",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          [
            [
              140.08437,
              36.07292
            ],
            [
              140.08437,
              36.075
            ],
            [
              140.0875,
              36.075
            ],
            [
              140.0875,
              36.07292
            ],
            [
              140.08437,
              36.07292
            ]
          ]
        ],
        "type": "Polygon"
      },
      "properties": {
        "meshcode": "5440008644N"
        "T30_I45_PS": "0.999005",
      }
    }
  ],
  "metaData": {
    "meshcode": "5440008644N",
    "eqcode": "TTL_MTTL",
    "version": "Y2010",
    "case": "AVR",
    "attr": [
      {
        "name": "T30_I45_PS",
        "unit": ""
      }
    ]
  }
}

GML format

GML response is given as following.

Tag				Description
gml: boundedBy				A bounding box of all geometries included in the response
gml: featureMember				Member element
	jshis: mesh			Mesh
		gml: coverage		A geometry object of the rectangular mesh
		jshis: meshcode		250m mesh code Refer to the Quarter Grid Square definition for details.
		Seismic hazard attribute name (such as T30_I45_PS)		Seismic hazard attribute Refer to a List of Seismic hazard attribute for details.
jshis: status				Request status Success (fixed)
jshis: metaData				Meta-information
	jshis: version			Map version
	jshis: case			Probability case
	jshis: eqcode			Earthquake code
	jshis: meshcode			250m mesh code Refer to the Quarter Grid Square definition for details.
	jshis: attrs			Seismic hazard attribute name array
		jshis: attr		Seismic hazard attribute included in the response
			jshis: name	Seismic hazard attribute Refer to a List of Seismic hazard attribute for details.
			jshis: unit	Unit of the attribute value

Response sample

Request URL

https://www.j-shis.bosai.go.jp/map/api/pshm/Y2010/AVR/TTL_MTTL/meshinfo.gml?meshcode=5440008644N&attr=T30_I45_PS

GML format response

<?xml version="1.0" encoding="utf-8"?>
<jshis:PshmMeshinfo xmlns:gml="http://www.opengis.net/gml"
 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-meshinfo-v1.0.xsd">
  <gml:boundedBy>
    <gml:Box srsName="urn:ogc:def:crs:EPSG:4301">
      <gml:coord>
        <gml:X>140.08437</gml:X>
        <gml:Y>36.07292</gml:Y>
      </gml:coord>
      <gml:coord>
        <gml:X>140.0875</gml:X>
        <gml:Y>36.075</gml:Y>
      </gml:coord>
    </gml:Box>
  </gml:boundedBy>
  <gml:featureMember>
    <jshis:mesh>
      <gml:coverage>
        <gml:Polygon srsName="urn:ogc:def:crs:EPSG:4301">
          <gml:outerBoundaryIs>
            <gml:LinearRing>
              <gml:coordinates>140.08437,36.07292
                       140.08437,36.075
                       140.0875,36.075
                       140.0875,36.07292
                       140.08437,36.07292 </gml:coordinates>
            </gml:LinearRing>
          </gml:outerBoundaryIs>
        </gml:Polygon>
      </gml:coverage>
      <jshis:meshcode>5440008644N</jshis:meshcode>
      <jshis:T30_I45_PS>0.999005</jshis:T30_I45_PS>
    </jshis:mesh>
  </gml:featureMember>
  <jshis:status>Success</jshis:status>
  <jshis:metaData>
    <jshis:version>Y2010</jshis:version>
    <jshis:case>AVR</jshis:case>
    <jshis:eqcode>TTL_MTTL</jshis:eqcode>
    <jshis:meshcode>5440008644N</jshis:meshcode>
    <jshis:attrs>
      <jshis:attr>
        <jshis:name>T30_I45_PS</jshis:name>
        <jshis:unit/>
      </jshis:attr>
    </jshis:attrs>
  </jshis:metaData>
</jshis:PshmMeshinfo>

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.

GeoJSON format

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

Tag		Description
type		The type of the GeoJSON object FeatureCollection (fixed)
status		Request status Error (fixed)
error		Error information
	code	The error classification code
	message	An error message
features		An empty array

Response sample

Request URL

https://www.j-shis.bosai.go.jp/map/api/pshm/Y2007/AVR/TTL_MTTL/meshinfo.geojson?meshcode=5440008644N&attr=T30_I45_PS

GeoJSON format error response

{
  "type": "FeatureCollection",
  "status": "Error",
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Supported value for option [ version ] is Y2008,Y2009,Y2010,Y2011,Y2012,Y2012_M2,Y2013,Y2013_M2,Y2013_M3,Y2014,Y2016,Y2017,Y2018"
  },
  "features": [
    {
      "geometry": {
        "coordinates": [
          []
        ]
      }
    }
  ]
}

GML format

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

Tag		Description
gml:boundedBy		null element <gml:null>unknown</gml:null> (fixed)
gml:featureMember		An empty array
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/pshm/Y2007/AVR/TTL_MTTL/meshinfo.gml?meshcode=5440008644N&attr=T30_I45_PS

Error response in GML format

<?xml version="1.0" encoding="utf-8"?>
<jshis:PshmMeshinfo xmlns:gml="http://www.opengis.net/gml"
 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-meshinfo-v1.0.xsd">
    <gml:boundedBy>
        <gml:null>unknown</gml:null>
    </gml:boundedBy>
    <gml:featureMember/>
    <jshis:status>Error</jshis:status>
    <jshis:error>
        <jshis:code>INVALID_REQUEST</jshis:code>
        <jshis:message>Supported value for option [ version ] is Y2008,Y2009,Y2010,Y2011,Y2012,Y2012_M2,Y2013,Y2013_M2,Y2013_M3,Y2014,Y2016,Y2017,Y2018,Y2019,Y2020,Y2021,Y2022,Y2023,Y2024</jshis:message>
    </jshis:error>
</jshis:PshmMeshinfo>

Category : API　

TOP > API > Seismic hazard information API

J-SHIS | Japan Seismic Hazard Information Station